Source Code for Package generic_fns.structure

 1  ############################################################################### 
 2  #                                                                             # 
 3  # Copyright (C) 2008-2011 Edward d'Auvergne                                   # 
 4  #                                                                             # 
 5  # This file is part of the program relax.                                     # 
 6  #                                                                             # 
 7  # relax 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 2 of the License, or           # 
10  # (at your option) any later version.                                         # 
11  #                                                                             # 
12  # relax 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 relax; if not, write to the Free Software                        # 
19  # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA   # 
20  #                                                                             # 
21  ############################################################################### 
22   
23  # Package docstring. 
24  """This package consists of modules used reading, writing, creating, structural information. 
25   
26  In the future, numerous structure related operations will be present including: 
27   
28      - Numerous PDB parsers. 
29      - A PDB writer. 
30      - CIF parsers. 
31      - Other structural data file parsers. 
32      - Functions for creating geometric objects in structural format. 
33      - Mass and inertia related functions. 
34   
35  This package has well defined API implemented as class methods for accessing structural data 
36  independent of parser, writer, etc. 
37  """ 
38   
39  __all__ = [ 'api_base', 
40              'cones', 
41              'geometric', 
42              'internal', 
43              'main', 
44              'mass', 
45              'scientific', 
46              'superimpose' ] 
47