Skip to main content

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

Project description

Latest release PyPI CI status Test coverage


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

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

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

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


Install Python package

  1. Install XPP

  2. Install this package

    pip install biosimulators-xpp

Install Docker image

docker pull


Local usage

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

BioSimulators-compliant command-line interface to the XPP simulation program <>.

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


Documentation is available at


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.

Questions and comments

Please contact the BioSimulators Team with any questions or comments.

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

biosimulators_xpp-0.0.2.tar.gz (11.9 kB view hashes)

Uploaded source

Built Distribution

biosimulators_xpp-0.0.2-py2.py3-none-any.whl (12.0 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page