[](https://github.com/biosimulations/Biosimulators_COPASI/releases)
[](https://pypi.org/project/biosimulators_copasi/)
[](https://github.com/biosimulators/Biosimulators_COPASI/actions?query=workflow%3A%22Continuous+integration%22)
[](https://codecov.io/gh/biosimulators/Biosimulators_COPASI)
[](#contributors-)
# BioSimulators-COPASI
BioSimulators-compliant command-line interface and Docker image for the [COPASI](http://copasi.org/) simulation program.
This command-line interface and Docker image enable users to use COPASI 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 COPASI is available at [BioSimulators](https://biosimulators.org/simulators/copasi).
A simple web application and web service for using COPASI to execute COMBINE/OMEX archives is also available at [runBioSimulations](https://run.biosimulations.org).
## Installation
### Install Python package
```
pip install biosimulators-copasi
```
### Install Docker image
```
docker pull ghcr.io/biosimulators/copasi
```
## Usage
### Local usage
```
usage: biosimulators-copasi [-h] [-d] [-q] -i ARCHIVE [-o OUT_DIR] [-v]
BioSimulators-compliant command-line interface to the COPASI simulation program <http://copasi.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/copasi:latest \
-i /root/in/modeling-study.omex \
-o /root/out
```
## Documentation
Documentation is available at https://docs.biosimulators.org/Biosimulators_COPASI/.
## License
This package is released under the [MIT license](LICENSE). COPASI is released under the [Artistic 2.0 License](http://copasi.org/Download/License/).
## Development team
This package was developed by the [Center for Reproducible Biomedical Modeling](http://reproduciblebiomodels.org). COPASI was developed by a [team](http://copasi.org/About/Team/) at the University of Connecticut, the University of Heidelberg, and the University of Virginia 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://basico.readthedocs.io/en/latest/",
"name": "biosimulators-copasi",
"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/3b/60/d194a24a4ff34242a83f68a2dfe6719d34700129acc2853b1487914b7bbd/biosimulators_copasi-0.2.23.tar.gz",
"platform": null,
"description": "[](https://github.com/biosimulations/Biosimulators_COPASI/releases)\n[](https://pypi.org/project/biosimulators_copasi/)\n[](https://github.com/biosimulators/Biosimulators_COPASI/actions?query=workflow%3A%22Continuous+integration%22)\n[](https://codecov.io/gh/biosimulators/Biosimulators_COPASI)\n[](#contributors-)\n\n\n# BioSimulators-COPASI\nBioSimulators-compliant command-line interface and Docker image for the [COPASI](http://copasi.org/) simulation program.\n\nThis command-line interface and Docker image enable users to use COPASI 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 COPASI is available at [BioSimulators](https://biosimulators.org/simulators/copasi).\n\nA simple web application and web service for using COPASI to execute COMBINE/OMEX archives is also available at [runBioSimulations](https://run.biosimulations.org).\n\n## Installation\n\n### Install Python package\n```\npip install biosimulators-copasi\n```\n\n### Install Docker image\n```\ndocker pull ghcr.io/biosimulators/copasi\n```\n\n## Usage\n\n### Local usage\n```\nusage: biosimulators-copasi [-h] [-d] [-q] -i ARCHIVE [-o OUT_DIR] [-v]\n\nBioSimulators-compliant command-line interface to the COPASI simulation program <http://copasi.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/copasi: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_COPASI/.\n\n## License\nThis package is released under the [MIT license](LICENSE). COPASI is released under the [Artistic 2.0 License](http://copasi.org/Download/License/).\n\n## Development team\nThis package was developed by the [Center for Reproducible Biomedical Modeling](http://reproduciblebiomodels.org). COPASI was developed by a [team](http://copasi.org/About/Team/) at the University of Connecticut, the University of Heidelberg, and the University of Virginia 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\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "BioSimulators-compliant command-line interface to the COPASI simulation program <http://copasi.org>.",
"version": "0.2.23",
"project_urls": {
"Homepage": "https://basico.readthedocs.io/en/latest/",
"Repository": "https://github.com/biosimulators/Biosimulators_COPASI"
},
"split_keywords": [
"systems",
" biology",
" modeling",
" simulation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8f911ad5350e0b84e23a9d26c8b3c4c184734feae03837762b13e280a9f91e33",
"md5": "ee543ed4a1172536a7fd20414762b429",
"sha256": "295f55373489ea7f2066456bf295f807bbcbaa2e38aaddbd8bb154c02586ab17"
},
"downloads": -1,
"filename": "biosimulators_copasi-0.2.23-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ee543ed4a1172536a7fd20414762b429",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 21858,
"upload_time": "2024-11-18T15:23:42",
"upload_time_iso_8601": "2024-11-18T15:23:42.008813Z",
"url": "https://files.pythonhosted.org/packages/8f/91/1ad5350e0b84e23a9d26c8b3c4c184734feae03837762b13e280a9f91e33/biosimulators_copasi-0.2.23-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3b60d194a24a4ff34242a83f68a2dfe6719d34700129acc2853b1487914b7bbd",
"md5": "51bf1a5c4a6779f608f769e531a58bac",
"sha256": "b89ae73a11225d162311560f46613a51a24c5dc7f587d2beb900f8499c1b31fb"
},
"downloads": -1,
"filename": "biosimulators_copasi-0.2.23.tar.gz",
"has_sig": false,
"md5_digest": "51bf1a5c4a6779f608f769e531a58bac",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 20641,
"upload_time": "2024-11-18T15:23:44",
"upload_time_iso_8601": "2024-11-18T15:23:44.156643Z",
"url": "https://files.pythonhosted.org/packages/3b/60/d194a24a4ff34242a83f68a2dfe6719d34700129acc2853b1487914b7bbd/biosimulators_copasi-0.2.23.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-18 15:23:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "biosimulators",
"github_project": "Biosimulators_COPASI",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "biosimulators-copasi"
}
JSON
