Skip to main content

Latest release PyPI CI status Test coverage All Contributors

BioSimulators-COBRApy

BioSimulators-compliant command-line interface and Docker image for the COBRApy simulation program.

This command-line interface and Docker image enable users to use COBRApy to execute COMBINE/OMEX archives that describe one or more simulation experiments (in SED-ML format) of one or more models (in SBML format).

A list of the algorithms and algorithm parameters supported by COBRApy is available at BioSimulators.

A simple web application and web service for using COBRApy to execute COMBINE/OMEX archives is also available at runBioSimulations.

Installation

Install Python package

pip install biosimulators-cobrapy

Install Docker image

docker pull ghcr.io/biosimulators/cobrapy

Usage

SED-ML targets for simulation predictions

BioSimulators-COBRApy recognizes the following targets for simulation predictions:

  • FBA (KISAO_0000437), parsimonious FBA (KISAO_0000528), geometric FBA (KISAO_0000527):

    • Objective: fbc:objective/@value

    • Reaction flux: sbml:reaction/@flux

    • Reaction reduced cost: sbml:reaction/@reducedCost

    • Species shadow price: sbml:species/@shadowPrice

  • FVA (KISAO_0000526):

    • Minimum reaction flux: sbml:reaction/@minFlux

    • Maximum reaction flux: sbml:reaction/@maxFlux

Please see https://docs.biosimulations.org for more information.

Local usage

usage: biosimulators-cobrapy [-h] [-d] [-q] -i ARCHIVE [-o OUT_DIR] [-v]

BioSimulators-compliant command-line interface to the COBRApy simulation program <https://opencobra.github.io/cobrapy/>.

optional arguments:
  -h, --help            show this help message and exit
  -d, --debug           full application debug mode
  -q, --quiet           suppress all console output
  -i ARCHIVE, --archive ARCHIVE
                        Path to OMEX file which contains one or more SED-ML-
                        encoded simulation experiments
  -o OUT_DIR, --out-dir OUT_DIR
                        Directory to save outputs
  -v, --version         show program's version number and exit

Usage through Docker container

The entrypoint to the Docker image supports the same command-line interface described above.

For example, the following command could be used to use the Docker image to execute the COMBINE/OMEX archive ./modeling-study.omex and save its outputs to ./.

docker run \
  --tty \
  --rm \
  --mount type=bind,source="$(pwd)",target=/root/in,readonly \
  --mount type=bind,source="$(pwd)",target=/root/out \
  ghcr.io/biosimulators/cobrapy:latest \
    -i /root/in/modeling-study.omex \
    -o /root/out

Documentation

Documentation is available at https://docs.biosimulators.org/Biosimulators_COBRApy/.

License

This package is released under the MIT license.

Development team

This package was developed by the Center for Reproducible Biomedical Modeling and the Karr Lab at the Icahn School of Medicine at Mount Sinai with assistance from the contributors listed here.

Questions and comments

Please contact the BioSimulators Team with any questions or comments.

Metadata

Release files for biosimulators-cobrapy 0.1.23

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for biosimulators-cobrapy 0.1.23
File Size Uploaded Provenance Actions
biosimulators_cobrapy-0.1.23.tar.gz 14.7 kB Without provenance Details for biosimulators_cobrapy-0.1.23.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for biosimulators-cobrapy 0.1.23
File Interpreter ABI Platform Actions
biosimulators_cobrapy-0.1.23-py2.py3-none-any.whl Python 3, Python 2 none any Details for biosimulators_cobrapy-0.1.23-py2.py3-none-any.whl

Total release size: 29.0 kB

Release files / biosimulators_cobrapy-0.1.23.tar.gz

Download URL biosimulators_cobrapy-0.1.23.tar.gz
Size 14.7 kB
Tags Source
SHA-256 checksum
How to use checksums
16ffd086ee4ec48030d7deb7984b91d9f5b833fe3580c2a8e927d364d1aba63b
BLAKE2b-256 checksum
How to use checksums
7fa5fdec20abe990b77f7b37f86065315edbdb01902bf3e234f63e99e43e1965
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.1 keyring/23.5.0 rfc3986/1.5.0 colorama/0.4.4 CPython/3.9.10

Release files / biosimulators_cobrapy-0.1.23-py2.py3-none-any.whl

Download URL biosimulators_cobrapy-0.1.23-py2.py3-none-any.whl
Size 14.3 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
89032433a0b853df3a909823b24b07c7bb000b87156151d7a634d7688a26b856
BLAKE2b-256 checksum
How to use checksums
92fec3dd753b9ede4f807a56db81065449ef3037f98c882c9b224806a25822c0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.1 keyring/23.5.0 rfc3986/1.5.0 colorama/0.4.4 CPython/3.9.10

Security for biosimulators-cobrapy 0.1.23

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page