Skip to main content

Latest release PyPI CI status Test coverage All Contributors

BioSimulators-GINsim

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

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

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

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

Installation

Install Python package

  1. Install Java, Python, and pip

  2. Install the GINsim Python package

  3. Install this package

    pip install biosimulators-ginsim

Install Docker image

docker pull ghcr.io/biosimulators/ginsim

Usage

Local usage

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

BioSimulators-compliant command-line interface to the GINsim simulation program <http://ginsim.org/>.

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

Documentation

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

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-ginsim 0.0.9

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-ginsim 0.0.9
File Size Uploaded
biosimulators_ginsim-0.0.9.tar.gz 13.1 kB Details

Built distribution (wheel)

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

Total release size: 26.1 kB

Release files / biosimulators_ginsim-0.0.9.tar.gz

Download URL biosimulators_ginsim-0.0.9.tar.gz
Size 13.1 kB
Tags Source
SHA-256 checksum
How to use checksums
6532c034a20965d6ba7957c13928e120bc398aff2b7393c95072363b083e2c80
BLAKE2b-256 checksum
How to use checksums
306d9ba043265028973465ab1f81845994478852742807279b3a8dedc37bb21d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

Release files / biosimulators_ginsim-0.0.9-py2.py3-none-any.whl

Download URL biosimulators_ginsim-0.0.9-py2.py3-none-any.whl
Size 13.0 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
3999c96f8295b94759a66a8859e65613ed1e7db03fbd4efbfb6e2aadb6e6e26e
BLAKE2b-256 checksum
How to use checksums
e50321e89f19edc31fd294451116ffd90cca71c927e1ef46760295666abf8f7d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

Release history Release notifications | RSS feed

This release

0.0.9 This release

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