Package pipe_control :: Package structure
[hide private]
[frames] | no frames]

Source Code for Package pipe_control.structure

 1  ############################################################################### 
 2  #                                                                             # 
 3  # Copyright (C) 2008-2013 Edward d'Auvergne                                   # 
 4  #                                                                             # 
 5  # This file is part of the program relax (http://www.nmr-relax.com).          # 
 6  #                                                                             # 
 7  # This program is free software: you can redistribute it and/or modify        # 
 8  # it under the terms of the GNU General Public License as published by        # 
 9  # the Free Software Foundation, either version 3 of the License, or           # 
10  # (at your option) any later version.                                         # 
11  #                                                                             # 
12  # This program is distributed in the hope that it will be useful,             # 
13  # but WITHOUT ANY WARRANTY; without even the implied warranty of              # 
14  # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               # 
15  # GNU General Public License for more details.                                # 
16  #                                                                             # 
17  # You should have received a copy of the GNU General Public License           # 
18  # along with this program.  If not, see <http://www.gnu.org/licenses/>.       # 
19  #                                                                             # 
20  ############################################################################### 
21   
22  # Package docstring. 
23  """This package consists of modules used reading, writing, creating, structural information. 
24   
25  In the future, numerous structure related operations will be present including: 
26   
27      - Numerous PDB parsers. 
28      - A PDB writer. 
29      - CIF parsers. 
30      - Other structural data file parsers. 
31      - Functions for creating geometric objects in structural format. 
32      - Mass and inertia related functions. 
33   
34  This package has well defined API implemented as class methods for accessing structural data 
35  independent of parser, writer, etc. 
36  """ 
37   
38  __all__ = [ 
39      'geometric', 
40      'main', 
41      'mass' 
42  ] 
43