BioSimulators-AMICI
BioSimulators-compliant command-line interface to the AMICI simulation program.
This command-line interface and Docker image enable users to use AMICI to execute COMBINE/OMEX archives that describe one or more simulation experiments (in SED-ML format) of one or more models (in SBML format).
A list of the algorithms and algorithm parameters supported by AMICI is available at BioSimulators.
A simple web application and web service for using AMICI to execute COMBINE/OMEX archives is also available at runBioSimulations.
Installation
Dependencies
- Python >= 3.11
- pip
- g++
Install Python package
pip install biosimulators-amici
Install Docker image
docker pull ghcr.io/biosimulators/amici
Usage
Local usage
usage: biosimulators-amici [-h] [-d] [-q] -i ARCHIVE [-o OUT_DIR] [-v]
BioSimulators-compliant command-line interface to the AMICI simulation program <https://github.com/AMICI-dev/AMICI>.
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/amici:latest \
-i /root/in/modeling-study.omex \
-o /root/out
Documentation
Documentation is available at https://docs.biosimulators.org/Biosimulators_AMICI/.
License
This package is released under the MIT license.
Development team
This package was developed by the Center for Reproducible Biomedical Modeling and the Karr Lab at the Icahn School of Medicine at Mount Sinai in New York with assistance from the contributors listed here.
Questions and comments
Please contact the BioSimulators Team with any questions or comments.
Metadata
Release files for biosimulators-amici 0.1.30
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| biosimulators_amici-0.1.30.tar.gz | 4.6 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| biosimulators_amici-0.1.30-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 9.2 MB
Release files / biosimulators_amici-0.1.30.tar.gz
| Download URL | biosimulators_amici-0.1.30.tar.gz |
|---|---|
| Size | 4.6 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
25c50a76f0e9e6a46800622fd286c52f9e0e775c4c875653dfe20a61a47d71b9
|
|
BLAKE2b-256 checksum How to use checksums |
a43b4426cc59256032003a7c57f20af8dfd180497b2341bb5ab586648219342b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.14
|
Release files / biosimulators_amici-0.1.30-py3-none-any.whl
| Download URL | biosimulators_amici-0.1.30-py3-none-any.whl |
|---|---|
| Size | 4.6 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d5fe60c4b5b3dc7aa9b62124668b93c8003b3e685c26b1e6d2dc404da9b464c3
|
|
BLAKE2b-256 checksum How to use checksums |
4468bf41a6c10d7047996044e86ae46a5bad7b36f5626469e40334e278df2c6f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.14
|