Forgi API documentation¶
This is the documentation of the forgi package, generated from the docstrings.
Note
Some private submodules contain docstrings in a different format than the rest of the code base. They have been left out of this documentation. Please see the source code for their documentation.
To get to know forgi, you might want to start with reading the documentation of forgi.graph.bulge_graph and forgi.threedee.models.coarse_grain.
To create an RNA object, the preferred method is the function forgi.load_rna instead of using the constructors in the RNA classes directly.
With standard parameters, this function returns a list of forgi.threedee.model.coarse_grain.CoarsegrainRNA objects.
Subpackages¶
- forgi.graph package
- forgi.projection package
- forgi.threedee package
- Subpackages
- forgi.threedee.model package
- forgi.threedee.utilities package
- Submodules
- forgi.threedee.utilities.graph_pdb module
- forgi.threedee.utilities.mcannotate module
- forgi.threedee.utilities.modified_res module
- forgi.threedee.utilities.modified_res_lookup module
- forgi.threedee.utilities.my_math module
- forgi.threedee.utilities.pdb module
- forgi.threedee.utilities.vector module
- forgi.threedee.utilities.cytvec module
- forgi.threedee.utilities.virtual_residues module
- Module contents
- Submodules
- forgi.threedee.visual package
- forgi.threedee.classification package
- Module contents
- Subpackages
- forgi.utilities package
- forgi.visual package
Submodules¶
Module contents¶
forgi - an RNA structure library¶
Forgi is a python library for analysing and manipulating RNA secondary and tertiary structures based on secondary structure elements.
The libraries core object, which is returned by the load_rna function,
is the forgi.graph.bulge_graph.BulgeGraph object (2D structure) and its
subclass the forgi.threedee.model.coarse_grain.CoarseGrainRNA object.