Skip to main content

A package to build metabolic models

Project description

mxlpy-logo

MxlPy

pypi docs License Coverage Ruff security: bandit PyPI Downloads

MxlPy (pronounced "em axe el pie") is a Python package for mechanistic learning (Mxl) - the combination of mechanistic modeling and machine learning to deliver explainable, data-informed solutions.

Documentation

You can find extensive documentation directly here on github

Installation

You can install mxlpy using pip: pip install mxlpy.

Due to their sizes, the machine learning packages are optional dependencies. You can install them using

# One of them respectively
pip install mxlpy[torch]
pip install mxlpy[tensorflow]
pip install mxlpy[keras]
pip install mxlpy[jax]
pip install mxlpy[sr]

# together
pip install mxlpy[torch, tensorflow, keras, jax, sr]

If you want access to the sundials solver suite via the assimulo package, we recommend setting up a virtual environment via pixi or mamba / conda using the conda-forge channel.

pixi init
pixi add python assimulo
pixi add --pypi mxlpy

How to cite

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

Development setup

You have two choices here, using uv (pypi-only) or using pixi (conda-forge, including assimulo)

uv

  • Install uv as described in the docs.
  • Run uv sync --all-extras --all-groups to install dependencies locally

pixi

  • Install pixi as described in the docs
  • Run pixi install --frozen

LLMs

We support the llms.txt convention for making documentation available to large language models and the applications that make use of them. It is located at docs/llms.txt

Tool family 🏠

MxlPy is part of a larger family of tools that are designed with a similar set of abstractions. Check them out!

  • MxlBricks is built on top of MxlPy to build mechanistic models composed of pre-defined reactions (bricks)
  • MxlWeb brings simulation of mechanistic models to the browser!

Project details


Download files

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

Source Distribution

mxlpy-0.37.0.tar.gz (5.1 MB view details)

Uploaded Source

Built Distribution

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

mxlpy-0.37.0-py3-none-any.whl (170.1 kB view details)

Uploaded Python 3

File details

Details for the file mxlpy-0.37.0.tar.gz.

File metadata

  • Download URL: mxlpy-0.37.0.tar.gz
  • Upload date:
  • Size: 5.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for mxlpy-0.37.0.tar.gz
Algorithm Hash digest
SHA256 c969d86e70f8969b7f14834b94596f4e69ed71a165cfd06ccef75d2ed6212c99
MD5 4e132e5752d7ce881def29c042f53378
BLAKE2b-256 b6d48b14f369b6a1bb3418f7ade05148fa4e8d886d5f490d30ef177dbf7286c5

See more details on using hashes here.

Provenance

The following attestation bundles were made for mxlpy-0.37.0.tar.gz:

Publisher: python-publish.yml on Computational-Biology-Aachen/MxlPy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mxlpy-0.37.0-py3-none-any.whl.

File metadata

  • Download URL: mxlpy-0.37.0-py3-none-any.whl
  • Upload date:
  • Size: 170.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for mxlpy-0.37.0-py3-none-any.whl
Algorithm Hash digest
SHA256 313582460b902df8df2e0db5c829fdc78a2cca0f23b14625eb2830e5dbd91450
MD5 6bd646927f21bb1797c6c24d77aa8a4e
BLAKE2b-256 806797bb7612a3914a2a4b0d67a131fd7b7b5717a99911f6791d151f0b6516ef

See more details on using hashes here.

Provenance

The following attestation bundles were made for mxlpy-0.37.0-py3-none-any.whl:

Publisher: python-publish.yml on Computational-Biology-Aachen/MxlPy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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