Skip to main content

Latest release PyPI CI status Test coverage All Contributors

BioSimulators-OpenCOR

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

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

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

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

Installation

Install Python package and command-line application

  1. Install the requirements for OpenCOR:

    apt-get install -y \
        curl \
        libpulse-mainloop-glib0 \
        libx11-6 \
        libxext6 \
        libxslt1.1 \
        sqlite3
  2. Install OpenCOR:

    url=https://opencor.ws/downloads/snapshots/2021-05-19/OpenCOR-2021-05-19-Linux.tar.gz
    curl $url | tar -xz --directory=/opt/
  3. Add OpenCOR to your system path:

    export PATH=/opt/OpenCOR-2021-05-19-Linux:$PATH
  4. Install pip for this version of Python:

    curl https://bootstrap.pypa.io/get-pip.py | OpenCOR -c PythonShell
  5. Use pip to install this package:

    /opt/OpenCOR-2021-05-19-Linux/python/bin/python -m pip install biosimulators-opencor

Install Docker image

docker pull ghcr.io/biosimulators/opencor

Usage

Local usage

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

BioSimulators-compliant command-line interface to the OpenCOR <https://opencor.ws> 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 \
  ghcr.io/biosimulators/opencor:latest \
    -i /root/in/modeling-study.omex \
    -o /root/out

Documentation

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

License

This package is released under the MIT.

Development team

This package was developed by the Karr Lab at the Icahn School of Medicine at Mount Sinai and the Center for Reproducible Biomedical Modeling 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-opencor 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-opencor 0.0.13
File Size Uploaded
biosimulators_opencor-0.0.13.tar.gz 14.5 kB Details

Built distribution (wheel)

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

Total release size: 29.2 kB

Release files / biosimulators_opencor-0.0.13.tar.gz

Download URL biosimulators_opencor-0.0.13.tar.gz
Size 14.5 kB
Tags Source
SHA-256 checksum
How to use checksums
c5800d36b31f0542cc7c9f42bd38e77d34be1b140454681667bdd68dcf30af36
BLAKE2b-256 checksum
How to use checksums
2dc01b3b50a4163114a7ff67156437b939644f7182d75498e481f09284ecb24a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

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

Download URL biosimulators_opencor-0.0.13-py2.py3-none-any.whl
Size 14.7 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
4e96349e7a54a5972d9dd4396a6bb41ad8a8d269907210535fb09eefd5c07379
BLAKE2b-256 checksum
How to use checksums
bc5e060c3d6ddd12479a0e0a0282964749c344a916277c93d887d2418fb72c10
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

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.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