Commit 101c3cfa authored by Rafal P. Wiewiora's avatar Rafal P. Wiewiora
Browse files

docstrings

parent cc920d6a
...@@ -135,6 +135,8 @@ class PdbStructure(object): ...@@ -135,6 +135,8 @@ class PdbStructure(object):
load_all_models : bool load_all_models : bool
Whether to load every model of an NMR structure or trajectory, or Whether to load every model of an NMR structure or trajectory, or
just load the first model, to save memory. just load the first model, to save memory.
extraParticleIdentifier : string='EP'
if this value appears in the element column for an ATOM record, the Atom's element will be set to None to mark it as an extra particle
""" """
# initialize models # initialize models
self.load_all_models = load_all_models self.load_all_models = load_all_models
......
...@@ -68,6 +68,8 @@ class PDBFile(object): ...@@ -68,6 +68,8 @@ class PDBFile(object):
---------- ----------
file : string file : string
the name of the file to load the name of the file to load
extraParticleIdentifier : string='EP'
if this value appears in the element column for an ATOM record, the Atom's element will be set to None to mark it as an extra particle
""" """
top = Topology() top = Topology()
## The Topology read from the PDB file ## The Topology read from the PDB file
...@@ -255,6 +257,8 @@ class PDBFile(object): ...@@ -255,6 +257,8 @@ class PDBFile(object):
rather than generating new ones. Warning: It is up to the caller to rather than generating new ones. Warning: It is up to the caller to
make sure these are valid IDs that satisfy the requirements of the make sure these are valid IDs that satisfy the requirements of the
PDB format. Otherwise, the output file will be invalid. PDB format. Otherwise, the output file will be invalid.
extraParticleIdentifier : string=' '
String to write in the element column of the ATOM records for atoms whose element is None (extra particles)
""" """
PDBFile.writeHeader(topology, file) PDBFile.writeHeader(topology, file)
PDBFile.writeModel(topology, positions, file, keepIds=keepIds, extraParticleIdentifier=extraParticleIdentifier) PDBFile.writeModel(topology, positions, file, keepIds=keepIds, extraParticleIdentifier=extraParticleIdentifier)
...@@ -299,6 +303,8 @@ class PDBFile(object): ...@@ -299,6 +303,8 @@ class PDBFile(object):
rather than generating new ones. Warning: It is up to the caller to rather than generating new ones. Warning: It is up to the caller to
make sure these are valid IDs that satisfy the requirements of the make sure these are valid IDs that satisfy the requirements of the
PDB format. Otherwise, the output file will be invalid. PDB format. Otherwise, the output file will be invalid.
extraParticleIdentifier : string=' '
String to write in the element column of the ATOM records for atoms whose element is None (extra particles)
""" """
if len(list(topology.atoms())) != len(positions): if len(list(topology.atoms())) != len(positions):
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment