biosimulators-cbmpy

BioSimulators-CBMPy

BioSimulators-compliant command-line interface to the CBMPy simulation program.

This command-line interface and Docker image enable users to use CBMPy 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 CBMPy is available at BioSimulators.

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

Installation

Install Python package

pip install biosimulators-cbmpy

Install Docker image

docker pull ghcr.io/biosimulators/cbmpy

Usage

Local usage

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

BioSimulators-compliant command-line interface to the CBMPy simulation program <http://cbmpy.sourceforge.net/>.

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/cbmpy:latest \
    -i /root/in/modeling-study.omex \
    -o /root/out

Documentation

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

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 in New York 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-cbmpy 0.1.15

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-cbmpy 0.1.15
File	Size	Uploaded
biosimulators_cbmpy-0.1.15.tar.gz	15.1 kB	Feb 23, 2022	Details

Built distribution (wheel)

Table of built distributions (wheels) for biosimulators-cbmpy 0.1.15
File	Interpreter	ABI	Platform	Reset
biosimulators_cbmpy-0.1.15-py2.py3-none-any.whl 15.4 kB Feb 23, 2022	Python 3, Python 2	none	any	Details

Total release size: 30.5 kB

Release files / biosimulators_cbmpy-0.1.15.tar.gz

Download URL	biosimulators_cbmpy-0.1.15.tar.gz
Size	15.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`a69f5b12f44c6b041e0107da3ef4be8247fff0202cc3955f3ffefe19f1ffa08a`
BLAKE2b-256 checksum How to use checksums	`44fcb95c756fbb09f4057057ab78097bb2c9d824ae04fd35bea8e83d32fd7ccf`
Upload date	Feb 23, 2022
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/2.0.0 colorama/0.4.4 CPython/3.9.10`

Release files / biosimulators_cbmpy-0.1.15-py2.py3-none-any.whl

Download URL	biosimulators_cbmpy-0.1.15-py2.py3-none-any.whl
Size	15.4 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`725e11f14cac0775de5faa36f6fad2457dad5863706d96ef5e131875be2127b3`
BLAKE2b-256 checksum How to use checksums	`e6f2ebb1217ea215b6abf47b59a9630a4891b4007b180709e03410189abf8787`
Upload date	Feb 23, 2022
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/2.0.0 colorama/0.4.4 CPython/3.9.10`