Skip to main content

A package to build metabolic models

Project description

pipeline status coverage report

Documentation Status PyPi Code style: black Downloads

modelbase

modelbase is a python package to help you build and analyze dynamic mathematical models of biological systems. It has originally been designed for the simulation of metabolic systems, but can be used for virtually any processes, in which some substances get converted into others.

modelbase incorporates an easy construction method to define 'reactions'. A rate law and the stoichiometry need to be specified, and the system of differential equations is assembled automatically.

modelbase allows 'algebraic modules', which are useful to implement rapid equilibrium or quasi steady-state approximations. In the simplest instance, they allow easy incorporation of conserved quantities.

modelbase also allows a simple construction of isotope-specific models. This class contains a constructor method that automatically construct all isotope specific versions of a particular reaction. Very cool - check it out!

Release notes

Versions 1.0 and 0.4.0 introduced changes not compatible with the previous official release 0.2.5. API changes are summarised in this notebook

Version 0.4.5 was the prior stable version

Version 0.2.5 is the official release for the submission of the mansucript "Building mathematical models of biological systems with modelbase, a Python package for semi-automatic ODE assembly and construction of isotope-specific models" to the Journal of Open Research Software.

See changelog.md for details on changes of earlier versions.

Dependencies

  • NumPy
  • Scipy
  • Matplotlib
  • Assimulo
  • Sundials

Installation

pip install modelbase

To enable assimulo support, either conda install the package

conda install -c conda-forge assimulo
# or
conda install -c chria assimulo

or build sundials from source using our installation guide.

License

GPL 3

Documentation

The official documentation is hosted on ReadTheDocs.

Issues and support

If you experience issues using the software please contact us through our issues page.

Contributing to modelbase

All contributions, bug reports, bug fixes, documentation improvements, enhancements and ideas are welcome. See our contribution guide for more information.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

modelbase-1.2.1.tar.gz (90.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

modelbase-1.2.1-py3-none-any.whl (125.9 kB view details)

Uploaded Python 3

File details

Details for the file modelbase-1.2.1.tar.gz.

File metadata

  • Download URL: modelbase-1.2.1.tar.gz
  • Upload date:
  • Size: 90.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/49.6.0.post20201009 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.9.1

File hashes

Hashes for modelbase-1.2.1.tar.gz
Algorithm Hash digest
SHA256 cbbca4973d9f654cf988fcc1bc05c461fa20c4a27890bc5bbf709dedc538ad27
MD5 c43ebc8183e00b068892c9c57367b3ac
BLAKE2b-256 b0f9603182087eeb48377ed31a6cad30739844d835f391232cf3968e9f6908eb

See more details on using hashes here.

File details

Details for the file modelbase-1.2.1-py3-none-any.whl.

File metadata

  • Download URL: modelbase-1.2.1-py3-none-any.whl
  • Upload date:
  • Size: 125.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/49.6.0.post20201009 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.9.1

File hashes

Hashes for modelbase-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 28982d34b1cbb002a12338fea770342a54473e192cfc5c2a92ab0bcbc35cdf56
MD5 2238fb1936ecbebf698f990b5a39e47e
BLAKE2b-256 5a932883bd08b9d4922f946901c4b8d7d21d5a96a46d022b09ee1c18d607474e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page