|Latest release| |PyPI| |CI status| |Test coverage| |All Contributors|
BioSimulators-tellurium
=======================
BioSimulators-compliant command-line interface and Docker image for the
`tellurium <http://tellurium.analogmachine.org/>`__ simulation program.
This command-line interface and Docker image enable users to use
tellurium 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 models (in `SBML format <http://sbml.org]>`__).
A list of the algorithms and algorithm parameters supported by tellurium
is available at
`BioSimulators <https://biosimulators.org/simulators/tellurium>`__.
A simple web application and web service for using tellurium to execute
COMBINE/OMEX archives is also available at
`runBioSimulations <https://run.biosimulations.org>`__.
Installation
------------
Dependencies
~~~~~~~~~~~~
- Python
- pip
- libncurses
- libxml
Install Python package
~~~~~~~~~~~~~~~~~~~~~~
::
pip install biosimulators-tellurium
Install Docker image
~~~~~~~~~~~~~~~~~~~~
::
docker pull ghcr.io/biosimulators/tellurium
Usage
-----
Local usage
~~~~~~~~~~~
::
usage: biosimulators-tellurium [-h] [-d] [-q] -i ARCHIVE [-o OUT_DIR] [-v]
BioSimulators-compliant command-line interface to the tellurium simulation program <http://tellurium.analogmachine.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/tellurium:latest \
-i /root/in/modeling-study.omex \
-o /root/out
Documentation
-------------
Documentation is available at
https://docs.biosimulators.org/Biosimulators_tellurium/.
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:info@biosimulators.org>`__ with any questions or comments.
.. |Latest release| image:: https://img.shields.io/github/v/tag/biosimulators/Biosimulators_tellurium
:target: https://github.com/biosimulations/Biosimulators_tellurium/releases
.. |PyPI| image:: https://img.shields.io/pypi/v/biosimulators_tellurium
:target: https://pypi.org/project/biosimulators_tellurium/
.. |CI status| image:: https://github.com/biosimulators/Biosimulators_tellurium/workflows/Continuous%20integration/badge.svg
:target: https://github.com/biosimulators/Biosimulators_tellurium/actions?query=workflow%3A%22Continuous+integration%22
.. |Test coverage| image:: https://codecov.io/gh/biosimulators/Biosimulators_tellurium/branch/dev/graph/badge.svg
:target: https://codecov.io/gh/biosimulators/Biosimulators_tellurium
.. |All Contributors| image:: https://img.shields.io/github/all-contributors/biosimulators/Biosimulators_tellurium/HEAD
:target: #contributors-
Raw data
{
"_id": null,
"home_page": "https://github.com/biosimulators/Biosimulators_tellurium",
"name": "biosimulators-tellurium",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "systems biology,computational biology,kinetic modeling,numerical simulation,stochastic,SBML,SED-ML,COMBINE,BioSimulators",
"author": "BioSimulators Team",
"author_email": "info@biosimulators.org",
"download_url": "https://files.pythonhosted.org/packages/d4/90/dfa72caad7d7a53d2103f96989eea93ffaf9751cde24c2ceabd482662760/biosimulators_tellurium-0.1.42.tar.gz",
"platform": null,
"description": "|Latest release| |PyPI| |CI status| |Test coverage| |All Contributors|\n\nBioSimulators-tellurium\n=======================\n\nBioSimulators-compliant command-line interface and Docker image for the\n`tellurium <http://tellurium.analogmachine.org/>`__ simulation program.\n\nThis command-line interface and Docker image enable users to use\ntellurium to execute `COMBINE/OMEX\narchives <https://combinearchive.org/>`__ that describe one or more\nsimulation experiments (in `SED-ML format <https://sed-ml.org>`__) of\none or more models (in `SBML format <http://sbml.org]>`__).\n\nA list of the algorithms and algorithm parameters supported by tellurium\nis available at\n`BioSimulators <https://biosimulators.org/simulators/tellurium>`__.\n\nA simple web application and web service for using tellurium to execute\nCOMBINE/OMEX archives is also available at\n`runBioSimulations <https://run.biosimulations.org>`__.\n\nInstallation\n------------\n\nDependencies\n~~~~~~~~~~~~\n\n- Python\n- pip\n- libncurses\n- libxml\n\nInstall Python package\n~~~~~~~~~~~~~~~~~~~~~~\n\n::\n\n pip install biosimulators-tellurium\n\nInstall Docker image\n~~~~~~~~~~~~~~~~~~~~\n\n::\n\n docker pull ghcr.io/biosimulators/tellurium\n\nUsage\n-----\n\nLocal usage\n~~~~~~~~~~~\n\n::\n\n usage: biosimulators-tellurium [-h] [-d] [-q] -i ARCHIVE [-o OUT_DIR] [-v]\n\n BioSimulators-compliant command-line interface to the tellurium simulation program <http://tellurium.analogmachine.org>.\n\n optional arguments:\n -h, --help show this help message and exit\n -d, --debug full application debug mode\n -q, --quiet suppress all console output\n -i ARCHIVE, --archive ARCHIVE\n Path to OMEX file which contains one or more SED-ML-\n encoded simulation experiments\n -o OUT_DIR, --out-dir OUT_DIR\n Directory to save outputs\n -v, --version show program's version number and exit\n\nUsage through Docker container\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nThe entrypoint to the Docker image supports the same command-line\ninterface described above.\n\nFor example, the following command could be used to use the Docker image\nto execute the COMBINE/OMEX archive ``./modeling-study.omex`` and save\nits outputs to ``./``.\n\n::\n\n docker run \\\n --tty \\\n --rm \\\n --mount type=bind,source=\"$(pwd)\",target=/root/in,readonly \\\n --mount type=bind,source=\"$(pwd)\",target=/root/out \\\n ghcr.io/biosimulators/tellurium:latest \\\n -i /root/in/modeling-study.omex \\\n -o /root/out\n\nDocumentation\n-------------\n\nDocumentation is available at\nhttps://docs.biosimulators.org/Biosimulators_tellurium/.\n\nLicense\n-------\n\nThis package is released under the `MIT license <LICENSE>`__.\n\nDevelopment team\n----------------\n\nThis package was developed by the `Center for Reproducible Biomedical\nModeling <http://reproduciblebiomodels.org>`__ and the `Karr\nLab <https://www.karrlab.org>`__ at the Icahn School of Medicine at\nMount Sinai in New York with assistance from the contributors listed\n`here <CONTRIBUTORS.md>`__.\n\nQuestions and comments\n----------------------\n\nPlease contact the `BioSimulators\nTeam <mailto:info@biosimulators.org>`__ with any questions or comments.\n\n.. |Latest release| image:: https://img.shields.io/github/v/tag/biosimulators/Biosimulators_tellurium\n :target: https://github.com/biosimulations/Biosimulators_tellurium/releases\n.. |PyPI| image:: https://img.shields.io/pypi/v/biosimulators_tellurium\n :target: https://pypi.org/project/biosimulators_tellurium/\n.. |CI status| image:: https://github.com/biosimulators/Biosimulators_tellurium/workflows/Continuous%20integration/badge.svg\n :target: https://github.com/biosimulators/Biosimulators_tellurium/actions?query=workflow%3A%22Continuous+integration%22\n.. |Test coverage| image:: https://codecov.io/gh/biosimulators/Biosimulators_tellurium/branch/dev/graph/badge.svg\n :target: https://codecov.io/gh/biosimulators/Biosimulators_tellurium\n.. |All Contributors| image:: https://img.shields.io/github/all-contributors/biosimulators/Biosimulators_tellurium/HEAD\n :target: #contributors-\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "BioSimulators-compliant command-line interface to the tellurium simulation program <http://tellurium.analogmachine.org>.",
"version": "0.1.42",
"project_urls": {
"Download": "https://github.com/biosimulators/Biosimulators_tellurium",
"Homepage": "https://github.com/biosimulators/Biosimulators_tellurium"
},
"split_keywords": [
"systems biology",
"computational biology",
"kinetic modeling",
"numerical simulation",
"stochastic",
"sbml",
"sed-ml",
"combine",
"biosimulators"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fa4bc1d340ddceb1ed51a299464a779952cbbfb7a90a6558b30820295bc5978e",
"md5": "52fcb22d9f6e87f9f210f378e17edc7e",
"sha256": "e9874d48da68dac7f970a041a310844f4d9ea700e370c827c7b7e8da44ea6690"
},
"downloads": -1,
"filename": "biosimulators_tellurium-0.1.42-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "52fcb22d9f6e87f9f210f378e17edc7e",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 17211,
"upload_time": "2023-08-22T20:17:03",
"upload_time_iso_8601": "2023-08-22T20:17:03.315324Z",
"url": "https://files.pythonhosted.org/packages/fa/4b/c1d340ddceb1ed51a299464a779952cbbfb7a90a6558b30820295bc5978e/biosimulators_tellurium-0.1.42-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d490dfa72caad7d7a53d2103f96989eea93ffaf9751cde24c2ceabd482662760",
"md5": "6fe8a6f8a52fc5549c49384cacc1fcf3",
"sha256": "7870da42a77e5f34c4e6edb4be448fb04eb29bb367182faea3de6a5df722590e"
},
"downloads": -1,
"filename": "biosimulators_tellurium-0.1.42.tar.gz",
"has_sig": false,
"md5_digest": "6fe8a6f8a52fc5549c49384cacc1fcf3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 17542,
"upload_time": "2023-08-22T20:17:04",
"upload_time_iso_8601": "2023-08-22T20:17:04.971819Z",
"url": "https://files.pythonhosted.org/packages/d4/90/dfa72caad7d7a53d2103f96989eea93ffaf9751cde24c2ceabd482662760/biosimulators_tellurium-0.1.42.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-22 20:17:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "biosimulators",
"github_project": "Biosimulators_tellurium",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "biosimulators-tellurium"
}
JSON
