Skip to main content

A package to build metabolic models

Project description

modelbase

DOI pipeline status coverage report Documentation PyPi Code style: black Checked with mypy security: bandit Downloads

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.

Installation

If you quickly want to test out modelbase, or do not require assimulo support, install modelbase via

pip install modelbase

To enable assimulo support, the easiest way is to install modelbase via conda. We also recommend using the conda-forge channels.

# recommended to avoid package clashes
conda config --add channels conda-forge

# Create a new environment (not necessary, but recommended)
conda create -n mb39 python=3.9
conda install -c conda-forge modelbase

License

GPL 3

Documentation

The official documentation is hosted here on gitlab.

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.

How to cite

If you use this software in your scientific work, please cite this article:

van Aalst, M., Ebenhöh, O. & Matuszyńska, A. Constructing and analysing dynamic models with modelbase v1.2.3: a software update. BMC Bioinformatics 22, 203 (2021)

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.58.0.tar.gz (88.4 kB view details)

Uploaded Source

Built Distribution

modelbase-1.58.0-py3-none-any.whl (103.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: modelbase-1.58.0.tar.gz
  • Upload date:
  • Size: 88.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.2 CPython/3.10.6 Linux/5.15.154+

File hashes

Hashes for modelbase-1.58.0.tar.gz
Algorithm Hash digest
SHA256 c4d6d4ff98635b974078b24bb973a3fd517143d0aa074c521b039761ee0c8388
MD5 354c01a287204dd6ee05628184b54d18
BLAKE2b-256 07e617b0c20bbe53aa4a4dbfbed551c861728f9ed14fcbd9e267780045591711

See more details on using hashes here.

File details

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

File metadata

  • Download URL: modelbase-1.58.0-py3-none-any.whl
  • Upload date:
  • Size: 103.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.2 CPython/3.10.6 Linux/5.15.154+

File hashes

Hashes for modelbase-1.58.0-py3-none-any.whl
Algorithm Hash digest
SHA256 30a107bb51ea677312e979c4131bb04386c8522a3c9d943aead9455ae5781c16
MD5 0c55b6bbf80b663eb270b084716b1c4b
BLAKE2b-256 e3d93b4ceb81596b48a2cbc06e8370b87afaa33c726fa89a3aeb731e4e166e1c

See more details on using hashes here.

Supported by

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