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

or, using uv:

uv add modelbase

To enable assimulo support, the easiest way is to install modelbase via pixi, which pulls assimulo from the conda-forge channel.

# Add modelbase to a pixi project (creates one if needed)
pixi add modelbase assimulo

# or install it into a one-off environment
pixi init mb && cd mb
pixi add modelbase assimulo

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.59.7.tar.gz (73.9 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.59.7-py3-none-any.whl (92.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: modelbase-1.59.7.tar.gz
  • Upload date:
  • Size: 73.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.30 {"installer":{"name":"uv","version":"0.9.30","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"12","id":"bookworm","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for modelbase-1.59.7.tar.gz
Algorithm Hash digest
SHA256 b81728c0015548391bc005dde22442fd0739ebd5a5d36bbad5a8156ae1ac7746
MD5 37c808ec9b57e958da72943b769c7f90
BLAKE2b-256 25b403754dc629e3d18ad6119451526606071ce7211a32b5388c096b28b7d5fe

See more details on using hashes here.

File details

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

File metadata

  • Download URL: modelbase-1.59.7-py3-none-any.whl
  • Upload date:
  • Size: 92.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.30 {"installer":{"name":"uv","version":"0.9.30","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"12","id":"bookworm","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for modelbase-1.59.7-py3-none-any.whl
Algorithm Hash digest
SHA256 0d1ade2f9b8f69468a25adfb7713316fe757ecb5ba637ed3e5e9413997e5a4e2
MD5 f053d2df95ac5ae43e4b3c02a5d02125
BLAKE2b-256 5561c4ed24dec57297b962148ea8ecef2bb719492c19c70c9458f0894aad2450

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