Skip to content

Documentation for the BioSimulators tools and libraries

Integrated Docker image

A Docker image with a Python environment with most of the validated simulation tools is available at https://github.com/orgs/biosimulators/packages/container/package/biosimulators. An iPython shell for this environment can be launched by installing Docker and running the following commands:

docker pull ghcr.io/biosimulators/biosimulators
docker run -it --rm ghcr.io/biosimulators/biosimulators

This image includes BioSimulators-utils, as well as standardized Python APIs for the simulation tools validated by BioSimulators. Because this image aims to incorporate as many simulation tools as possible within a single Python environment, this image may sometimes lag behind the latest version of each tool.

The Dockerfile for this image is available here.

Information about using the Python APIs in the image is available below.

Standardized interfaces to simulation tools

Below are links to detailed documentation for the command-line applications and Python APIs for the standardized simulation tools.

Template for standardized interfaces to simulation tools

A template repository for creating a standardized interface to a simulation tool is available here.

Core BioSimulators util package

BioSimulators-utils provides (a) several utility command-line programs and a Python API for creating, validating, and executing simulation projects and (b) a Python API for creating standardized interfaces to simulation tools. A tutorial and documentation for the package is available here.

Test suite for test simulation tools

A tutorial and documentation for the BioSimulators test suite for simulation tools is available here.


Last update: 2022-01-20
Back to top