Skip to main content

Latest release PyPI CI status Test coverage

BioSimulators-BoolNet

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

This command-line interface and Docker image enable users to use BoolNet 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 format).

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

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

Installation

Install Python package

pip install biosimulators-boolnet

Install Docker image

docker pull ghcr.io/biosimulators/boolnet

Usage

Local usage

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

BioSimulators-compliant command-line interface to the BoolNet simulation program <https://sysbio.uni-ulm.de/?Software:BoolNet>.

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

Documentation

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

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.

Questions and comments

Please contact the BioSimulators Team with any questions or comments.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

biosimulators_boolnet-0.1.17.tar.gz (13.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

biosimulators_boolnet-0.1.17-py2.py3-none-any.whl (14.2 kB view details)

Uploaded Python 2Python 3

File details

Details for the file biosimulators_boolnet-0.1.17.tar.gz.

File metadata

  • Download URL: biosimulators_boolnet-0.1.17.tar.gz
  • Upload date:
  • Size: 13.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.7

File hashes

Hashes for biosimulators_boolnet-0.1.17.tar.gz
Algorithm Hash digest
SHA256 c77649f241c538431efe8343d4ea3a2468aa4450eb9f7f4d257c9fb2f42219c9
MD5 df4c0a997f3be24d675a9bf436223011
BLAKE2b-256 23753207e7d81630f0f93a9246a23a822a7c2bce6488eac7e2a41b04a724f351

See more details on using hashes here.

File details

Details for the file biosimulators_boolnet-0.1.17-py2.py3-none-any.whl.

File metadata

  • Download URL: biosimulators_boolnet-0.1.17-py2.py3-none-any.whl
  • Upload date:
  • Size: 14.2 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.7

File hashes

Hashes for biosimulators_boolnet-0.1.17-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 cf8c728339241344495c4cbc5ec858355931d57d666786cbe79cbb5824501453
MD5 a7b8c37abed1cf983f72e90966463f71
BLAKE2b-256 3d4a0e6754a2ba74be03907505a8e08f800f0ab6c449bd32402abadb0ab2d232

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page