Skip to main content

Latest release PyPI CI status Test coverage All Contributors

BioSimulators-XPP

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.

Installation

Install Python package

  1. Install XPP

  2. Install this package

    pip install biosimulators-xpp

Install Docker image

docker pull ghcr.io/biosimulators/xpp

Usage

Local usage

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

BioSimulators-compliant command-line interface to the XPP simulation program <http://www.math.pitt.edu/~bard/xpp/xpp.html>.

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

Documentation

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

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-xpp 0.0.13

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-xpp 0.0.13
File Size Uploaded
biosimulators_xpp-0.0.13.tar.gz 14.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for biosimulators-xpp 0.0.13
File Interpreter ABI Platform
biosimulators_xpp-0.0.13-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 28.6 kB

Release files / biosimulators_xpp-0.0.13.tar.gz

Download URL biosimulators_xpp-0.0.13.tar.gz
Size 14.4 kB
Tags Source
SHA-256 checksum
How to use checksums
e964518d260de57c7937589b6aafa6067d68352ab64dc3a164e72194b048d074
BLAKE2b-256 checksum
How to use checksums
a969e5cda681ea82efc850d3a23bd59fcda042053d495c8c26a0396bae4254fc
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.63.0 importlib-metadata/4.11.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

Release files / biosimulators_xpp-0.0.13-py2.py3-none-any.whl

Download URL biosimulators_xpp-0.0.13-py2.py3-none-any.whl
Size 14.1 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
c1aa73973a1ab56ce2920fc9e89df5489c67e78fc03b20455e358f12cfd1ca3f
BLAKE2b-256 checksum
How to use checksums
a9b1a1001b29a754989ad539e3b483e4939a15ee86e0978cc2a05f743f50708a
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.63.0 importlib-metadata/4.11.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

Release history Release notifications | RSS feed

This release

0.0.13 This release

2 release files

0.0.12

2 release files

0.0.11

2 release files

0.0.10

2 release files

0.0.9

2 release files

0.0.8

2 release files

0.0.7

2 release files

0.0.6

2 release files

0.0.5

2 release files

0.0.4

2 release files

0.0.3

2 release files

0.0.2

2 release files

0.0.1

2 release files

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