Skip to main content

Python based automated model reduction tools for SBML models

Project description

AutoReduce: An automated model reduction tool

Python toolbox to automatically obtain reduced model expressions using time-scale separation, conservation laws, and other assumptions.

Build Lint codecov PyPI version Documentation Status

Overview

AutoReduce is a Python package for automated model reduction of SBML models. It provides tools for:

  • Automated model reduction using QSSA (Quasi-Steady State Approximation)
  • Hill function approximation
  • Integration with BioCRNPyler for synthetic biology models
  • Analysis of gene expression models

Refer to the bioRxiv paper and Journal of Robust and Nonlinear Control paper for more details.

Quick Start

from autoreduce.converters import load_sbml

# Load your SBML model
sys = load_sbml('your_sbml_file.xml', outputs=['your_output'])

# Solve conservation laws
conservation_laws = sys.solve_conservation_laws(
    conserved_sets=[
        ['species1', 'species2', 'species3'],  # First conserved set
        ['species4', 'species5']               # Second conserved set
    ],
    states_to_eliminate=['species_to_eliminate1', 'species_to_eliminate2']
)

# Solve timescale separation using QSSA
reduced_qssa_model = sys.solve_timescale_separation(
    ['fast_species1', 'fast_species2']
    )

For more examples, check out the documentation.

Installation

Install the latest version of AutoReduce:

pip install autoreduce

Install with all optional dependencies:

pip install autoreduce[all]

For development installation:

git clone https://github.com/ayush9pandey/autoreduce.git
cd autoreduce
pip install -e ".[all]"

Documentation

Full documentation is available at autoreduce.readthedocs.io.

Contributing

We welcome contributions! Please see our contributing guide for details.

Versions

AutoReduce versions:

  • 0.3.0 (current release): Major updates including improved API and documentation
  • 0.2.0 (alpha release): pip install autoreduce==0.2.0
  • 0.1.0 (alpha release): pip install autoreduce==0.1.0

Contact

For questions, feedback, or suggestions, please contact:

License

Released under the BSD 3-Clause License (see LICENSE)

Copyright (c) 2025, Ayush Pandey. All rights reserved.

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

autoreduce-0.3.0.tar.gz (648.8 kB view details)

Uploaded Source

Built Distribution

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

autoreduce-0.3.0-py3-none-any.whl (28.7 kB view details)

Uploaded Python 3

File details

Details for the file autoreduce-0.3.0.tar.gz.

File metadata

  • Download URL: autoreduce-0.3.0.tar.gz
  • Upload date:
  • Size: 648.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for autoreduce-0.3.0.tar.gz
Algorithm Hash digest
SHA256 d10d40f668081f9cc52c148338acf0f8e83cee29d7d73afe730af729f038c501
MD5 bf08fa954a95aeb92d97965eaa8973e6
BLAKE2b-256 2aa230ee902c481b4bbddf5dfbd1bf4743eabb653c11a0bc4e22a26d99fec9ce

See more details on using hashes here.

Provenance

The following attestation bundles were made for autoreduce-0.3.0.tar.gz:

Publisher: pypi-deploy.yml on ayush9pandey/AutoReduce

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

File details

Details for the file autoreduce-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: autoreduce-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 28.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for autoreduce-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 496be066b62dd4c21dfa009ee3d10e0b979e1d63877cced2b13f009c399a3767
MD5 f0594f32a26d89e2edfc2b2b48d852a4
BLAKE2b-256 663c59f4298441fc2b0814b110992ed5b64b13c93f1315ecb0834ade510dc5ff

See more details on using hashes here.

Provenance

The following attestation bundles were made for autoreduce-0.3.0-py3-none-any.whl:

Publisher: pypi-deploy.yml on ayush9pandey/AutoReduce

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