biosimulators-amici


Namebiosimulators-amici JSON
Version 0.1.24 PyPI version JSON
download
home_pagehttps://github.com/biosimulators/Biosimulators_AMICI>
SummaryBioSimulators-compliant command-line interface to the AMICI simulation program <https://github.com/AMICI-dev/amici>.
upload_time2023-06-28 22:23:09
maintainer
docs_urlNone
authorCenter for Reproducible Biomedical Modeling
requires_python
licenseMIT
keywords biosimulators systems biology computational biology mathematical model kinetic model simulation sbml sed-ml combine omex
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            |Latest release| |PyPI| |CI status| |Test coverage| |All Contributors|

BioSimulators-AMICI
===================

BioSimulators-compliant command-line interface to the
`AMICI <https://github.com/AMICI-dev/AMICI>`__ simulation program.

This command-line interface and Docker image enable users to use AMICI
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 AMICI is
available at
`BioSimulators <https://biosimulators.org/simulators/amici>`__.

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

Installation
------------

Dependencies
~~~~~~~~~~~~

-  Python >= 3.7
-  pip
-  libatlas
-  g++
-  swig

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 <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_AMICI
   :target: https://github.com/biosimulations/Biosimulators_AMICI/releases
.. |PyPI| image:: https://img.shields.io/pypi/v/biosimulators_amici
   :target: https://pypi.org/project/biosimulators_amici/
.. |CI status| image:: https://github.com/biosimulators/Biosimulators_AMICI/workflows/Continuous%20integration/badge.svg
   :target: https://github.com/biosimulators/Biosimulators_AMICI/actions?query=workflow%3A%22Continuous+integration%22
.. |Test coverage| image:: https://codecov.io/gh/biosimulators/Biosimulators_AMICI/branch/dev/graph/badge.svg
   :target: https://codecov.io/gh/biosimulators/Biosimulators_AMICI
.. |All Contributors| image:: https://img.shields.io/github/all-contributors/biosimulators/Biosimulators_AMICI/HEAD
   :target: #contributors-

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/biosimulators/Biosimulators_AMICI>",
    "name": "biosimulators-amici",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "BioSimulators,systems biology,computational biology,mathematical model,kinetic model,simulation,SBML,SED-ML,COMBINE,OMEX",
    "author": "Center for Reproducible Biomedical Modeling",
    "author_email": "info@biosimulators.org",
    "download_url": "https://files.pythonhosted.org/packages/10/16/822269839c687adca6e170f10db4b240725cc43b63212b58564e0ec5b1ad/biosimulators_amici-0.1.24.tar.gz",
    "platform": null,
    "description": "|Latest release| |PyPI| |CI status| |Test coverage| |All Contributors|\n\nBioSimulators-AMICI\n===================\n\nBioSimulators-compliant command-line interface to the\n`AMICI <https://github.com/AMICI-dev/AMICI>`__ simulation program.\n\nThis command-line interface and Docker image enable users to use AMICI\nto execute `COMBINE/OMEX archives <https://combinearchive.org/>`__ that\ndescribe one or more simulation experiments (in `SED-ML\nformat <https://sed-ml.org>`__) of one or more models (in `SBML\nformat <http://sbml.org]>`__).\n\nA list of the algorithms and algorithm parameters supported by AMICI is\navailable at\n`BioSimulators <https://biosimulators.org/simulators/amici>`__.\n\nA simple web application and web service for using AMICI to execute\nCOMBINE/OMEX archives is also available at\n`runBioSimulations <https://run.biosimulations.org>`__.\n\nInstallation\n------------\n\nDependencies\n~~~~~~~~~~~~\n\n-  Python >= 3.7\n-  pip\n-  libatlas\n-  g++\n-  swig\n\nInstall Python package\n~~~~~~~~~~~~~~~~~~~~~~\n\n::\n\n   pip install biosimulators-amici\n\nInstall Docker image\n~~~~~~~~~~~~~~~~~~~~\n\n::\n\n   docker pull ghcr.io/biosimulators/amici\n\nUsage\n-----\n\nLocal usage\n~~~~~~~~~~~\n\n::\n\n   usage: biosimulators-amici [-h] [-d] [-q] -i ARCHIVE [-o OUT_DIR] [-v]\n\n   BioSimulators-compliant command-line interface to the AMICI simulation program <https://github.com/AMICI-dev/AMICI>.\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/amici: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_AMICI/.\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_AMICI\n   :target: https://github.com/biosimulations/Biosimulators_AMICI/releases\n.. |PyPI| image:: https://img.shields.io/pypi/v/biosimulators_amici\n   :target: https://pypi.org/project/biosimulators_amici/\n.. |CI status| image:: https://github.com/biosimulators/Biosimulators_AMICI/workflows/Continuous%20integration/badge.svg\n   :target: https://github.com/biosimulators/Biosimulators_AMICI/actions?query=workflow%3A%22Continuous+integration%22\n.. |Test coverage| image:: https://codecov.io/gh/biosimulators/Biosimulators_AMICI/branch/dev/graph/badge.svg\n   :target: https://codecov.io/gh/biosimulators/Biosimulators_AMICI\n.. |All Contributors| image:: https://img.shields.io/github/all-contributors/biosimulators/Biosimulators_AMICI/HEAD\n   :target: #contributors-\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "BioSimulators-compliant command-line interface to the AMICI simulation program <https://github.com/AMICI-dev/amici>.",
    "version": "0.1.24",
    "project_urls": {
        "Download": "https://github.com/biosimulators/Biosimulators_AMICI",
        "Homepage": "https://github.com/biosimulators/Biosimulators_AMICI>"
    },
    "split_keywords": [
        "biosimulators",
        "systems biology",
        "computational biology",
        "mathematical model",
        "kinetic model",
        "simulation",
        "sbml",
        "sed-ml",
        "combine",
        "omex"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1b4582088b6088b5630722a88a0963f120e7a5a837e73ac0b19e6f1d02ba123a",
                "md5": "d6018b23f761583713608770d4499d18",
                "sha256": "0f9073e535a3294fab997b8a76ffb6cdd6486d8d365abf8aa56230b94df307a1"
            },
            "downloads": -1,
            "filename": "biosimulators_amici-0.1.24-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d6018b23f761583713608770d4499d18",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 11601,
            "upload_time": "2023-06-28T22:23:06",
            "upload_time_iso_8601": "2023-06-28T22:23:06.939814Z",
            "url": "https://files.pythonhosted.org/packages/1b/45/82088b6088b5630722a88a0963f120e7a5a837e73ac0b19e6f1d02ba123a/biosimulators_amici-0.1.24-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1016822269839c687adca6e170f10db4b240725cc43b63212b58564e0ec5b1ad",
                "md5": "86dd8856a2ec1c6ea257f7d5688452d5",
                "sha256": "313e27b0fe3f29106bb1996e87b7f557134122c21d2525968c749ee67e0df676"
            },
            "downloads": -1,
            "filename": "biosimulators_amici-0.1.24.tar.gz",
            "has_sig": false,
            "md5_digest": "86dd8856a2ec1c6ea257f7d5688452d5",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 2527715,
            "upload_time": "2023-06-28T22:23:09",
            "upload_time_iso_8601": "2023-06-28T22:23:09.186848Z",
            "url": "https://files.pythonhosted.org/packages/10/16/822269839c687adca6e170f10db4b240725cc43b63212b58564e0ec5b1ad/biosimulators_amici-0.1.24.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-06-28 22:23:09",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "biosimulators",
    "github_project": "Biosimulators_AMICI>",
    "github_not_found": true,
    "lcname": "biosimulators-amici"
}
        
Elapsed time: 2.18123s