biosimulators-libsbmlsim

|Latest release| |PyPI| |CI status| |Test coverage| |All Contributors|

BioSimulators-LibSBMLSim

BioSimulators-compliant command-line interface to the LibSBMLSim <https://fun.bio.keio.ac.jp/software/libsbmlsim/>__ simulation program.

This command-line interface and Docker image enable users to use LibSBMLSim to execute COMBINE/OMEX archives <https://combinearchive.org/>__ that describe one or more simulation experiments (in SED-ML format <https://sed-ml.org>__) of one or more kinetic models in SBML format.

A list of the algorithms and algorithm parameters supported by LibSBMLSim is available at BioSimulators <https://biosimulators.org/simulators/libsbmlsim>__.

A simple web application and web service for using LibSBMLSim to execute COMBINE/OMEX archives is also available at runBioSimulations <https://run.biosimulations.org>__.

Installation

Install Python package

1. Install
   `LibSBMLSim <https://fun.bio.keio.ac.jp/software/libsbmlsim/>`__
2. Install this package
   ::

      pip install biosimulators-libsbmlsim

Install Docker image
~~~~~~~~~~~~~~~~~~~~

::

   docker pull ghcr.io/biosimulators/libsbmlsim

Usage
-----

Local usage
~~~~~~~~~~~

::

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

   BioSimulators-compliant command-line interface to the LibSBMLSim simulation program <https://fun.bio.keio.ac.jp/software/libsbmlsim/>.

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

Documentation

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

License

This package is released under the MIT license <LICENSE>__.

Development team

This package was developed by the Center for Reproducible Biomedical Modeling <http://reproduciblebiomodels.org>__ and the Karr Lab <https://www.karrlab.org>__ at the Icahn School of Medicine at Mount Sinai in New York with assistance from the contributors listed here <CONTRIBUTORS.md>__.

Questions and comments

Please contact the BioSimulators Team <mailto:[e-mail]>__ with any questions or comments.

.. |Latest release| image:: https://img.shields.io/github/v/tag/biosimulators/Biosimulators_LibSBMLSim :target: https://github.com/biosimulations/Biosimulators_LibSBMLSim/releases .. |PyPI| image:: https://img.shields.io/pypi/v/biosimulators_libsbmlsim :target: https://pypi.org/project/biosimulators_libsbmlsim/ .. |CI status| image:: https://github.com/biosimulators/Biosimulators_LibSBMLSim/workflows/Continuous%20integration/badge.svg :target: https://github.com/biosimulators/Biosimulators_LibSBMLSim/actions?query=workflow%3A%22Continuous+integration%22 .. |Test coverage| image:: https://codecov.io/gh/biosimulators/Biosimulators_LibSBMLSim/branch/dev/graph/badge.svg :target: https://codecov.io/gh/biosimulators/Biosimulators_LibSBMLSim .. |All Contributors| image:: https://img.shields.io/github/all-contributors/biosimulators/Biosimulators_LibSBMLSim/HEAD :target: #contributors-