biocrnpyler.core.compartment

Classes

Compartment(name[, size, ...])

A formal Compartment object for a Species in a CRN.

class biocrnpyler.core.compartment.Compartment(name: str, size=1e-06, spatial_dimensions=3, unit=None, **keywords)[source]

A formal Compartment object for a Species in a CRN. A Compartment must have a name. They may also have a spatial dimension (such as 2 for two-dimensional, or 3 for three-dimensional) and the size in litres. Note: The “default” keyword is reserved for BioCRNpyler allotting a default compartment. Users must choose a different string. The unit attribute for Compartment can be used to set unit for the Compartment size. Make sure that the string identifier used for the unit is a supported unit in BioCRNpyler. Check the documentation to find a list of supported units. Add your own custom units in units.py if needed.