Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
O
openstructure
Manage
Activity
Members
Code
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Deploy
Releases
Container registry
Model registry
Analyze
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
schwede
openstructure
Commits
f7317a5f
Commit
f7317a5f
authored
9 months ago
by
Studer Gabriel
Browse files
Options
Downloads
Patches
Plain Diff
doc update
parent
dc952093
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
modules/io/doc/io.rst
+25
-2
25 additions, 2 deletions
modules/io/doc/io.rst
with
25 additions
and
2 deletions
modules/io/doc/io.rst
+
25
−
2
View file @
f7317a5f
...
...
@@ -78,12 +78,15 @@ behaviour.
even if one is available in the IO Profile.
:param pdb_string: A PDB file as a string.
:type pdb_str: :class:`str`
:param profile: The IO Profile to read the entity with. For more information
on the IO Profiles available, see :doc:`profile`.
:type profile: :class:`ost.io.IOProfile`
:param process: If set to True, run the :class:`~ost.conop.Processor`
contained in the IO Profile.
:type process: :class:`bool`
:rtype: :class:`~ost.mol.EntityHandle`.
...
...
@@ -92,11 +95,31 @@ behaviour.
.. code-block:: python
with open('protein.pdb') as pdb_f
d
:
pdb_str = pdb.read()
with open('protein.pdb') as pdb_f
h
:
pdb_str = pdb
_fh
.read()
ent = io.PDBStrToEntity(pdb_str, ost.io.profiles['DEFAULT'], True)
.. function:: MMCifStrToEntity(mmcif_str, profile=IOProfile(), process=False)
Load entity from a string in mmCIF format. By default the entity is loaded with
an empty IO Profile and is not processed with the :class:`~ost.conop.Processor`,
even if one is available in the IO Profile.
:param mmcif_str: mmCIF file as a string
:type mmcif_str: :class:`str`
:param profile: The IO Profile to read the entity with. For more information
on the IO Profiles available, see :doc:`profile`.
:type profile: :class:`ost.io.IOProfile`
:param process: If set to True, run the :class:`~ost.conop.Processor`
contained in the IO Profile.
:type process: :class:`bool`
:rtype: :class:`~ost.mol.EntityHandle`.
.. function:: LoadSDF(filename)
Load an SDF file and return an entity.
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment