[](https://github.com/biosimulations/Biosimulators_tellurium/releases)
[](https://pypi.org/project/biosimulators_tellurium/)
[](https://github.com/biosimulators/Biosimulators_tellurium/actions?query=workflow%3A%22Continuous+integration%22)
[](https://codecov.io/gh/biosimulators/Biosimulators_tellurium)
[](#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.
Raw data
{
"_id": null,
"home_page": "https://tellurium.readthedocs.io/en/latest/",
"name": "biosimulators-tellurium",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "systems, biology, modeling, simulation",
"author": "Center for Reproducible Biomedical Modeling",
"author_email": "info@biosimulators.org",
"download_url": "https://files.pythonhosted.org/packages/83/28/ade1441cb920ad07b9f87609b1b7da3b44956a530f1499ea10bec70aa5d8/biosimulators_tellurium-0.1.44.tar.gz",
"platform": null,
"description": "[](https://github.com/biosimulations/Biosimulators_tellurium/releases)\n[](https://pypi.org/project/biosimulators_tellurium/)\n[](https://github.com/biosimulators/Biosimulators_tellurium/actions?query=workflow%3A%22Continuous+integration%22)\n[](https://codecov.io/gh/biosimulators/Biosimulators_tellurium)\n[](#contributors-)\n\n# BioSimulators-tellurium\nBioSimulators-compliant command-line interface and Docker image for the [tellurium](http://tellurium.analogmachine.org/) simulation program.\n\nThis 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])).\n\nA list of the algorithms and algorithm parameters supported by tellurium is available at [BioSimulators](https://biosimulators.org/simulators/tellurium).\n\nA simple web application and web service for using tellurium to execute COMBINE/OMEX archives is also available at [runBioSimulations](https://run.biosimulations.org).\n\n## Installation\n\n### Dependencies\n\n* Python\n* pip\n* libncurses\n* libxml\n\n### Install Python package\n```\npip install biosimulators-tellurium\n```\n\n### Install Docker image\n```\ndocker pull ghcr.io/biosimulators/tellurium\n```\n\n## Usage\n\n### Local usage\n```\nusage: biosimulators-tellurium [-h] [-d] [-q] -i ARCHIVE [-o OUT_DIR] [-v]\n\nBioSimulators-compliant command-line interface to the tellurium simulation program <http://tellurium.analogmachine.org>.\n\noptional 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```\n\n### Usage through Docker container\nThe entrypoint to the Docker image supports the same command-line interface described above.\n\nFor 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 `./`.\n\n```\ndocker 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```\n\n## Documentation\nDocumentation is available at https://docs.biosimulators.org/Biosimulators_tellurium/.\n\n## License\nThis package is released under the [MIT license](LICENSE).\n\n## Development team\nThis 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).\n\n## Questions and comments\nPlease contact the [BioSimulators Team](mailto:info@biosimulators.org) with any questions or comments.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "BioSimulators-compliant command-line interface to the Tellurium/roadrunner simulator <https://tellurium.readthedocs.io/>.",
"version": "0.1.44",
"project_urls": {
"Homepage": "https://tellurium.readthedocs.io/en/latest/",
"Repository": "https://github.com/biosimulators/Biosimulators_tellurium"
},
"split_keywords": [
"systems",
" biology",
" modeling",
" simulation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "87f35dd24e0f41d9c62fd555887b08771e17afa4c0e5cbebaa89c8af673d0c87",
"md5": "57958cef9c5791c9cb5e2204abbe0e17",
"sha256": "fe38001d96aabccc367ace9ea52c6c1bbd0ba72e63833ed26a7157fb8862d633"
},
"downloads": -1,
"filename": "biosimulators_tellurium-0.1.44-py3-none-any.whl",
"has_sig": false,
"md5_digest": "57958cef9c5791c9cb5e2204abbe0e17",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 16987,
"upload_time": "2024-10-10T21:49:34",
"upload_time_iso_8601": "2024-10-10T21:49:34.003765Z",
"url": "https://files.pythonhosted.org/packages/87/f3/5dd24e0f41d9c62fd555887b08771e17afa4c0e5cbebaa89c8af673d0c87/biosimulators_tellurium-0.1.44-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8328ade1441cb920ad07b9f87609b1b7da3b44956a530f1499ea10bec70aa5d8",
"md5": "cc556bbacab123323c52669623d13105",
"sha256": "eee9e1f71cec9adbef3d0040371b87bdd8b8406c523631909e3d942b89b5594b"
},
"downloads": -1,
"filename": "biosimulators_tellurium-0.1.44.tar.gz",
"has_sig": false,
"md5_digest": "cc556bbacab123323c52669623d13105",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 15652,
"upload_time": "2024-10-10T21:49:35",
"upload_time_iso_8601": "2024-10-10T21:49:35.473029Z",
"url": "https://files.pythonhosted.org/packages/83/28/ade1441cb920ad07b9f87609b1b7da3b44956a530f1499ea10bec70aa5d8/biosimulators_tellurium-0.1.44.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-10 21:49:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "biosimulators",
"github_project": "Biosimulators_tellurium",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "biosimulators-tellurium"
}
JSON
