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


Download files

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

Files for modelbase, version 1.0.post1
Filename, size File type Python version Upload date Hashes
Filename, size modelbase-1.0.post1-py3-none-any.whl (112.6 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size modelbase-1.0.post1.tar.gz (76.8 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page