Skip to content

API reference

The API reference is generated from the docstrings of the package.

sbmlutils

The top level modules: the model definition, reading and writing, validation and the shared output.

module description
factory the model definition and create_model, the entry point of the package
io reading and writing SBML
validation validation of a document against the SBML specification
parser SBML and antimony into a model definition
notes element documentation written as markdown
reaction_equation the stoichiometry of a reaction as a string
biomodels models from the BioModels database
cytoscape models rendered as a network in Cytoscape
console shared rich console
log logging of the package
utils meta ids and the frozen base class

sbmlutils.comp

Hierarchical models with the comp package, see Model composition.

module description
comp.comp ports, external model definitions and replacements
comp.flatten flattening a comp model into a single model

sbmlutils.converters

Conversion of a model into another representation, see Converters.

module description
converters.odefac the ODE system as python, R, julia, markdown or latex
converters.xpp XPP/XPPAUT ode files to SBML
converters.copasi ids written into the names for COPASI
converters.mathml evaluation of MathML

sbmlutils.data

module description
data.interpolation data points as an SBML model, see Interpolation

sbmlutils.fbc

Constraint based models, see Flux balance constraints.

module description
fbc.fbc flux bounds and boundary conditions
fbc.cobra the bridge to cobrapy, the optional cobra extra

sbmlutils.layout

module description
layout.layout layout information in the model, see Visualization

sbmlutils.manipulation

module description
manipulation.merge merging models into one comp model

sbmlutils.metadata

Annotation of models, see Annotations. The qualifiers BQB, BQM and the ontology terms SBO are re-exported from pymetadata.

module description
metadata.annotator annotations from a file applied to a model
metadata.validator validation of the annotations of a model
metadata.miriam the MIRIAM qualifiers of libsbml

sbmlutils.report

The content of a model for a human reader, see Reports.

module description
report.sbmlinfo the complete content of a document as JSON
report.sbmlreport a report on sbml4humans.de
report.units unit definitions rendered as a string or latex
report.mathml math rendered as latex