sbmlsim.units
¶
Manage units and units conversions.
Used for model and data unit conversions.
Module Contents¶
Classes¶
Storage of units information. |
|
Units class. |
Attributes¶
- class sbmlsim.units.UnitsInformation(udict, ureg, *args, **kwargs)[source]¶
Bases:
collections.abc.MutableMapping
Storage of units information.
Used for models or datasets.
- Parameters
udict (UdictType) –
ureg (pint.UnitRegistry) –
- sbml_uids = ['ampere', 'farad', 'joule', 'lux', 'radian', 'volt', 'avogadro', 'gram', 'katal', 'metre',...[source]¶
- __setitem__(self, key, value)[source]¶
Set item.
- Parameters
key (str) –
value (str) –
- Return type
None
- static from_sbml_path(model_path, ureg=None)[source]¶
Get pint UnitsInformation for model.
- Parameters
model_path (pathlib.Path) –
ureg (Optional[pint.UnitRegistry]) –
- Return type
- static model_uid_dict(model, ureg)[source]¶
Populate the model uid dict for lookup.
- Parameters
model (libsbml.Model) –
ureg (pint.UnitRegistry) –
- Return type
Dict[str, str]
- static from_sbml_doc(doc, ureg=None)[source]¶
Get pint UnitsInformation for model in document.
- Parameters
doc (libsbml.SBMLDocument) –
ureg (Optional[pint.UnitRegistry]) –
- Return type
- static normalize_changes(changes, uinfo)[source]¶
Normalize all changes to units in given units dictionary.
This is a major helper function allowing to convert changes to the requested units.
- Parameters
changes (Dict[str, pint.Quantity]) –
uinfo (UnitsInformation) –
- Return type
Dict[str, pint.Quantity]