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)
  • MxlModels supplies flat, single-file versions of MxlBricks models for easy inspection
  • MxlWeb brings simulation of mechanistic models to the browser!
  • pysbml simplifies SBML models for import/export with MxlPy
  • Parameteriser looks up kinetic parameters from BRENDA and other databases

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.50.0.tar.gz (5.3 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.50.0-py3-none-any.whl (220.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mxlpy-0.50.0.tar.gz
Algorithm Hash digest
SHA256 f3513d00832dbc5c6e5d01395a33fe6075951141525507ee2a19412d89398bf2
MD5 3aca6e2f63380fa53deffa281caa461a
BLAKE2b-256 f69416c429dea7a9caad43fcbd4d8784802df836213b9e99cafb736ed420b1bd

See more details on using hashes here.

Provenance

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

Publisher: release.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.50.0-py3-none-any.whl.

File metadata

  • Download URL: mxlpy-0.50.0-py3-none-any.whl
  • Upload date:
  • Size: 220.5 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.50.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5a4faeee09e6a4040ea452db0375e840011948269c1810cb6d733941035fa514
MD5 0c176ee89c8023ce5a26b06c2aaebc1b
BLAKE2b-256 ef3c49b11a2bfdf1f62c8d2d6fbe1733759a5c4a6961c9dbc3af9059f750874e

See more details on using hashes here.

Provenance

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

Publisher: release.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