r6185 - /1.3/prompt/structure.py -- May 21, 2008 - 11:46

Author: bugman
Date: Wed May 21 11:46:02 2008
New Revision: 6185

URL: http://svn.gna.org/viewcvs/relax?rev=6185&view=rev
Log:
Modified the structure.read_pdb() user function docstring to mention the new 
internal PDB parser.


Modified:
    1.3/prompt/structure.py

Modified: 1.3/prompt/structure.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/prompt/structure.py?rev=6185&r1=6184&r2=6185&view=diff
==============================================================================
--- 1.3/prompt/structure.py (original)
+++ 1.3/prompt/structure.py Wed May 21 11:46:02 2008
@@ -309,23 +309,27 @@
         structure beginning with the line 'MODEL i' in the PDB file will be 
loaded.  Otherwise all
         structures will be loaded starting from the model number 1.
 
-        Currently only the Scientific Python PDB parser can be used to read 
structural data.
-        Therefore the 'parser' argument should be set to the string 
'scientific'.
+        A few different PDB parsers can be used to read the structural data. 
 These are selected by
+        setting the 'parser' argument to one of:
+
+            'scientific' - the Scientific Python PDB parser.
+            'internal' - a lower quality and less reliable, although faster, 
PDB parser built into
+                relax.
 
 
         Example
         ~~~~~~~
 
-        To load all structures from the PDB file 'test.pdb' in the directory 
'~/pdb', type:
+        To load all structures from the PDB file 'test.pdb' in the directory 
'~/pdb', type one of:
 
         relax> structure.read_pdb('test.pdb', '~/pdb')
         relax> structure.read_pdb(file='test.pdb', dir='pdb')
 
 
-        To load the 10th model from the file 'test.pdb', use:
-
-        relax> structure.read_pdb('test.pdb', model=10)
-        relax> structure.read_pdb(file='test.pdb', model=10)
+        To load the 10th model from the file 'test.pdb' using the internal 
relax parser, use one of:
+
+        relax> structure.read_pdb('test.pdb', model=10, parser='internal')
+        relax> structure.read_pdb(file='test.pdb', model=10, 
parser='internal')
 
         """