# pyPESTO - Parameter EStimation TOolbox for python
<img src="https://raw.githubusercontent.com/ICB-DCM/pyPESTO/master/doc/logo/logo_wordmark.png" width="50%" alt="pyPESTO logo"/>
**pyPESTO** is a widely applicable and highly customizable toolbox for
parameter estimation.
[![PyPI](https://badge.fury.io/py/pypesto.svg)](https://badge.fury.io/py/pypesto)
[![CI](https://github.com/ICB-DCM/pyPESTO/workflows/CI/badge.svg)](https://github.com/ICB-DCM/pyPESTO/actions)
[![Coverage](https://codecov.io/gh/ICB-DCM/pyPESTO/branch/master/graph/badge.svg)](https://codecov.io/gh/ICB-DCM/pyPESTO)
[![Documentation](https://readthedocs.org/projects/pypesto/badge/?version=latest)](https://pypesto.readthedocs.io)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.2553546.svg)](https://doi.org/10.5281/zenodo.2553546)
## Feature overview
pyPESTO features include:
* Multi-start local optimization
* Profile computation
* Result visualization
* Interface to [AMICI](https://github.com/AMICI-dev/AMICI/) for efficient
simulation and sensitivity analysis of ordinary differential equation (ODE)
models
([example](https://github.com/ICB-DCM/pyPESTO/blob/main/doc/example/amici.ipynb))
* Parameter estimation pipeline for systems biology problems specified in
[SBML](http://sbml.org/) and [PEtab](https://github.com/PEtab-dev/PEtab)
([example](https://github.com/ICB-DCM/pyPESTO/blob/master/doc/example/petab_import.ipynb))
* Parameter estimation with ordinal data as described in
[Schmiester et al. (2020)](https://doi.org/10.1007/s00285-020-01522-w) and
[Schmiester et al. (2021)](https://doi.org/10.1093/bioinformatics/btab512).
([example](https://github.com/ICB-DCM/pyPESTO/blob/master/doc/example/ordinal.ipynb))
* Parameter estimation with censored data. ([example](https://github.com/ICB-DCM/pyPESTO/blob/master/doc/example/censored.ipynb))
* Parameter estimation with nonlinear-monotone data. ([example](https://github.com/ICB-DCM/pyPESTO/blob/master/doc/example/nonlinear_monotone.ipynb))
## Quick install
The simplest way to install **pyPESTO** is via pip:
```shell
pip3 install pypesto
```
More information is available here:
https://pypesto.readthedocs.io/en/latest/install.html
## Documentation
The documentation is hosted on readthedocs.io:
<https://pypesto.readthedocs.io>
## Examples
Multiple use cases are discussed in the documentation. In particular, there are
jupyter notebooks in the [doc/example](doc/example) directory.
## Contributing
We are happy about any contributions. For more information on how to contribute
to pyPESTO check out
<https://pypesto.readthedocs.io/en/latest/contribute.html>
## How to Cite
**Citeable DOI for the latest pyPESTO release:**
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.2553546.svg)](https://doi.org/10.5281/zenodo.2553546)
When using pyPESTO in your project, please cite
* Schälte, Y., Fröhlich, F., Jost, P. J., Vanhoefer, J., Pathirana, D., Stapor, P.,
Lakrisenko, P., Wang, D., Raimúndez, E., Merkt, S., Schmiester, L., Städter, P.,
Grein, S., Dudkin, E., Doresic, D., Weindl, D., & Hasenauer, J. (2023). pyPESTO: A
modular and scalable tool for parameter estimation for dynamic models,
Bioinformatics, 2023, btad711, [doi:10.1093/bioinformatics/btad711](https://doi.org/10.1093/bioinformatics/btad711)
When presenting work that employs pyPESTO, feel free to use one of the icons in
[doc/logo/](https://github.com/ICB-DCM/pyPESTO/tree/main/doc/logo):
<p align="center">
<img src="https://raw.githubusercontent.com/ICB-DCM/pyPESTO/master/doc/logo/logo.png" height="75" alt="AMICI Logo">
</p>
There is a list of [publications using pyPESTO](https://pypesto.readthedocs.io/en/latest/references.html).
If you used pyPESTO in your work, we are happy to include
your project, please let us know via a GitHub issue.
## References
pyPESTO supersedes [**PESTO**](https://github.com/ICB-DCM/PESTO/) a parameter estimation
toolbox for MATLAB, whose development is discontinued.
Raw data
{
"_id": null,
"home_page": "https://github.com/icb-dcm/pypesto",
"name": "pypesto",
"maintainer": "Paul Jonas Jost, Maren Philipps, Domagoj Dore\u0161i\u0107, Fabian Fr\u00f6hlich",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "paul.jost@uni-bonn.de, maren.philipps@uni-bonn.de, domagoj.doresic@uni-bonn.de, fabian.frohlich@crick.ac.uk",
"keywords": "parameter inference, optimization, sampling, profiles, ODE, AMICI, systems biology",
"author": "The pyPESTO developers",
"author_email": "yannik.schaelte@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/19/85/a35130e4fcca1966e388e6bc6a89634e245b8a28239632368878559511cf/pypesto-0.4.2.tar.gz",
"platform": null,
"description": "# pyPESTO - Parameter EStimation TOolbox for python\n\n<img src=\"https://raw.githubusercontent.com/ICB-DCM/pyPESTO/master/doc/logo/logo_wordmark.png\" width=\"50%\" alt=\"pyPESTO logo\"/>\n\n**pyPESTO** is a widely applicable and highly customizable toolbox for\nparameter estimation.\n\n[![PyPI](https://badge.fury.io/py/pypesto.svg)](https://badge.fury.io/py/pypesto)\n[![CI](https://github.com/ICB-DCM/pyPESTO/workflows/CI/badge.svg)](https://github.com/ICB-DCM/pyPESTO/actions)\n[![Coverage](https://codecov.io/gh/ICB-DCM/pyPESTO/branch/master/graph/badge.svg)](https://codecov.io/gh/ICB-DCM/pyPESTO)\n[![Documentation](https://readthedocs.org/projects/pypesto/badge/?version=latest)](https://pypesto.readthedocs.io)\n[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.2553546.svg)](https://doi.org/10.5281/zenodo.2553546)\n\n## Feature overview\n\npyPESTO features include:\n\n* Multi-start local optimization\n* Profile computation\n* Result visualization\n* Interface to [AMICI](https://github.com/AMICI-dev/AMICI/) for efficient\n simulation and sensitivity analysis of ordinary differential equation (ODE)\n models\n ([example](https://github.com/ICB-DCM/pyPESTO/blob/main/doc/example/amici.ipynb))\n* Parameter estimation pipeline for systems biology problems specified in\n [SBML](http://sbml.org/) and [PEtab](https://github.com/PEtab-dev/PEtab)\n ([example](https://github.com/ICB-DCM/pyPESTO/blob/master/doc/example/petab_import.ipynb))\n* Parameter estimation with ordinal data as described in\n [Schmiester et al. (2020)](https://doi.org/10.1007/s00285-020-01522-w) and\n [Schmiester et al. (2021)](https://doi.org/10.1093/bioinformatics/btab512).\n ([example](https://github.com/ICB-DCM/pyPESTO/blob/master/doc/example/ordinal.ipynb))\n* Parameter estimation with censored data. ([example](https://github.com/ICB-DCM/pyPESTO/blob/master/doc/example/censored.ipynb))\n* Parameter estimation with nonlinear-monotone data. ([example](https://github.com/ICB-DCM/pyPESTO/blob/master/doc/example/nonlinear_monotone.ipynb))\n\n## Quick install\n\nThe simplest way to install **pyPESTO** is via pip:\n\n```shell\npip3 install pypesto\n```\n\nMore information is available here:\nhttps://pypesto.readthedocs.io/en/latest/install.html\n\n## Documentation\n\nThe documentation is hosted on readthedocs.io:\n<https://pypesto.readthedocs.io>\n\n## Examples\n\nMultiple use cases are discussed in the documentation. In particular, there are\njupyter notebooks in the [doc/example](doc/example) directory.\n\n## Contributing\n\nWe are happy about any contributions. For more information on how to contribute\nto pyPESTO check out\n<https://pypesto.readthedocs.io/en/latest/contribute.html>\n\n## How to Cite\n\n**Citeable DOI for the latest pyPESTO release:**\n[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.2553546.svg)](https://doi.org/10.5281/zenodo.2553546)\n\nWhen using pyPESTO in your project, please cite\n* Sch\u00e4lte, Y., Fr\u00f6hlich, F., Jost, P. J., Vanhoefer, J., Pathirana, D., Stapor, P.,\n Lakrisenko, P., Wang, D., Raim\u00fandez, E., Merkt, S., Schmiester, L., St\u00e4dter, P.,\n Grein, S., Dudkin, E., Doresic, D., Weindl, D., & Hasenauer, J. (2023). pyPESTO: A\n modular and scalable tool for parameter estimation for dynamic models,\n Bioinformatics, 2023, btad711, [doi:10.1093/bioinformatics/btad711](https://doi.org/10.1093/bioinformatics/btad711)\n\nWhen presenting work that employs pyPESTO, feel free to use one of the icons in\n[doc/logo/](https://github.com/ICB-DCM/pyPESTO/tree/main/doc/logo):\n\n<p align=\"center\">\n <img src=\"https://raw.githubusercontent.com/ICB-DCM/pyPESTO/master/doc/logo/logo.png\" height=\"75\" alt=\"AMICI Logo\">\n</p>\n\nThere is a list of [publications using pyPESTO](https://pypesto.readthedocs.io/en/latest/references.html).\nIf you used pyPESTO in your work, we are happy to include\nyour project, please let us know via a GitHub issue.\n\n## References\n\npyPESTO supersedes [**PESTO**](https://github.com/ICB-DCM/PESTO/) a parameter estimation\ntoolbox for MATLAB, whose development is discontinued.\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "python-based Parameter EStimation TOolbox",
"version": "0.4.2",
"project_urls": {
"Bug Tracker": "https://github.com/icb-dcm/pypesto/issues",
"Changelog": "https://pypesto.readthedocs.io/en/latest/changelog.html",
"Documentation": "https://pypesto.readthedocs.io",
"Download": "https://github.com/icb-dcm/pypesto/releases",
"Homepage": "https://github.com/icb-dcm/pypesto"
},
"split_keywords": [
"parameter inference",
" optimization",
" sampling",
" profiles",
" ode",
" amici",
" systems biology"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1985a35130e4fcca1966e388e6bc6a89634e245b8a28239632368878559511cf",
"md5": "d0b695f3e84f8147a40169af2eae8b6f",
"sha256": "d4c2409768294a06b0a2b2cef0e03843e0fee6102fb414ed235090509f446aab"
},
"downloads": -1,
"filename": "pypesto-0.4.2.tar.gz",
"has_sig": false,
"md5_digest": "d0b695f3e84f8147a40169af2eae8b6f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 300476,
"upload_time": "2024-04-15T18:10:46",
"upload_time_iso_8601": "2024-04-15T18:10:46.034663Z",
"url": "https://files.pythonhosted.org/packages/19/85/a35130e4fcca1966e388e6bc6a89634e245b8a28239632368878559511cf/pypesto-0.4.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-15 18:10:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "icb-dcm",
"github_project": "pypesto",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "pypesto"
}