Skip to content
Snippets Groups Projects
Commit 117bf4ba authored by Studer Gabriel's avatar Studer Gabriel
Browse files

document restrictions of PDB format causing exceptions to be thrown in SavePDB

parent 24e0c211
Branches
Tags
No related merge requests found
......@@ -144,12 +144,14 @@ file:
.. function:: EntityToPDBStr(ent, profile=IOProfile())
Return entity as a string in PDB format.
Return entity as a string in PDB format.
:param entity: The :class:`~ost.mol.EntityHandle` or :class:`~ost.mol.EntityView`
:param profile: The IO Profile to read the entity with. For more information
on the IO Profiles available, see :doc:`profile`.
:raises: IOException if the restrictions of the PDB format are not satisfied
(see :meth:`ost.io.SavePDB`)
:rtype: string.
......
......@@ -184,6 +184,15 @@ def SavePDB(models, filename, dialect=None, pqr=False, profile='DEFAULT'):
:param models: The entity or list of entities (handles or views) to be saved
:param filename: The filename
:type filename: string
:raises: IOException if the restrictions of the PDB format are not satisfied
(with the exception of atom numbers, see above):
* Chain names with more than one character
* Atom positions with coordinates outside range [-999.99, 9999.99]
* Residue names longer than three characters
* Atom names longer than four characters
* Numeric part of :class:`ost.mol.ResNum` outside range [-999, 9999]
* Alternative atom indicators longer than one character
"""
if not getattr(models, '__len__', None):
models=[models]
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment