Skip to main content

A package to build metabolic models

Project description

modelbase

pipeline status coverage report Documentation Status PyPi Code style: black Checked with mypy 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 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.

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.5.8.tar.gz (79.5 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.5.8-py3-none-any.whl (94.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: modelbase-1.5.8.tar.gz
  • Upload date:
  • Size: 79.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.9.10 Linux/5.4.109+

File hashes

Hashes for modelbase-1.5.8.tar.gz
Algorithm Hash digest
SHA256 e210cb45e515ae955a87cfefa1e98315f1ae7ebf8bd605d26c993ebc9c6b4ee9
MD5 c9ce02ef22b6b176b4fa0cef1c0553af
BLAKE2b-256 e8f85890062bb6966a0f7ec9668f05b3a54a3f9ac98508cde54c2667888b9e45

See more details on using hashes here.

File details

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

File metadata

  • Download URL: modelbase-1.5.8-py3-none-any.whl
  • Upload date:
  • Size: 94.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.9.10 Linux/5.4.109+

File hashes

Hashes for modelbase-1.5.8-py3-none-any.whl
Algorithm Hash digest
SHA256 bc4f91a015b8742b66a8a91a907fc0157ec8a153d47408f2eaa5654e8ffa761f
MD5 6fefc94ab5ad7d8ce9c7237e63fb92df
BLAKE2b-256 2858f7255a4949762d1ea124d28f07ac3e3487f9c588d3cbfe8912ee68d5c6f1

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