peak-performance


Namepeak-performance JSON
Version 0.7.1 PyPI version JSON
download
home_pageNone
SummaryA Python toolbox to fit chromatography peaks with uncertainty.
upload_time2024-10-13 14:47:24
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseAGPLv3
keywords hplc mass-spectrometry uncertainty quantification
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![PyPI version](https://img.shields.io/pypi/v/peak-performance)](https://pypi.org/project/peak-performance/)
[![pipeline](https://github.com/jubiotech/peak-performance/workflows/pipeline/badge.svg)](https://github.com/JuBiotech/peak-performance/actions)
[![coverage](https://codecov.io/gh/jubiotech/peak-performance/branch/main/graph/badge.svg)](https://app.codecov.io/gh/JuBiotech/peak-performance)
[![documentation](https://readthedocs.org/projects/peak-performance/badge/?version=latest)](https://peak-performance.readthedocs.io/en/latest)
[![DOI](https://zenodo.org/badge/713469041.svg)](https://zenodo.org/doi/10.5281/zenodo.10255543)

# About PeakPerformance
PeakPerformance employs Bayesian modeling for chromatographic peak data fitting.
This has the innate advantage of providing uncertainty quantification while jointly estimating all peak parameters united in a single peak model.
As Markov Chain Monte Carlo (MCMC) methods are utilized to infer the posterior probability distribution, convergence checks and the aformentioned uncertainty quantification are applied as novel quality metrics for a robust peak recognition.

# First steps
Be sure to check out our thorough [documentation](https://peak-performance.readthedocs.io/en/latest). It contains not only information on how to install PeakPerformance and prepare raw data for its application but also detailed treatises about the implemented model structures, validation with both synthetic and experimental data against a commercially available vendor software, exemplary usage of diagnostic plots and investigation of various effects.
Furthermore, you will find example notebooks and data sets showcasing different aspects of PeakPerformance.

# How to contribute
If you encounter bugs while using PeakPerformance, please bring them to our attention by opening an issue. When doing so, describe the problem in detail and add screenshots/code snippets and whatever other helpful material you can provide.
When contributing code, create a local clone of PeakPerformance, create a new branch, and open a pull request (PR).

# How to cite
Head over to Zenodo to [generate a BibTeX citation](https://doi.org/10.5281/zenodo.10255543) for the latest release.
A publication has just been submitted to a scientific journal. Once published, this section will be updated.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "peak-performance",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "hplc, mass-spectrometry, uncertainty quantification",
    "author": null,
    "author_email": "Jochen Nie\u00dfer <j.niesser@fz-juelich.de>, Michael Osthege <m.osthege@fz-juelich.de>",
    "download_url": null,
    "platform": null,
    "description": "[![PyPI version](https://img.shields.io/pypi/v/peak-performance)](https://pypi.org/project/peak-performance/)\n[![pipeline](https://github.com/jubiotech/peak-performance/workflows/pipeline/badge.svg)](https://github.com/JuBiotech/peak-performance/actions)\n[![coverage](https://codecov.io/gh/jubiotech/peak-performance/branch/main/graph/badge.svg)](https://app.codecov.io/gh/JuBiotech/peak-performance)\n[![documentation](https://readthedocs.org/projects/peak-performance/badge/?version=latest)](https://peak-performance.readthedocs.io/en/latest)\n[![DOI](https://zenodo.org/badge/713469041.svg)](https://zenodo.org/doi/10.5281/zenodo.10255543)\n\n# About PeakPerformance\nPeakPerformance employs Bayesian modeling for chromatographic peak data fitting.\nThis has the innate advantage of providing uncertainty quantification while jointly estimating all peak parameters united in a single peak model.\nAs Markov Chain Monte Carlo (MCMC) methods are utilized to infer the posterior probability distribution, convergence checks and the aformentioned uncertainty quantification are applied as novel quality metrics for a robust peak recognition.\n\n# First steps\nBe sure to check out our thorough [documentation](https://peak-performance.readthedocs.io/en/latest). It contains not only information on how to install PeakPerformance and prepare raw data for its application but also detailed treatises about the implemented model structures, validation with both synthetic and experimental data against a commercially available vendor software, exemplary usage of diagnostic plots and investigation of various effects.\nFurthermore, you will find example notebooks and data sets showcasing different aspects of PeakPerformance.\n\n# How to contribute\nIf you encounter bugs while using PeakPerformance, please bring them to our attention by opening an issue. When doing so, describe the problem in detail and add screenshots/code snippets and whatever other helpful material you can provide.\nWhen contributing code, create a local clone of PeakPerformance, create a new branch, and open a pull request (PR).\n\n# How to cite\nHead over to Zenodo to [generate a BibTeX citation](https://doi.org/10.5281/zenodo.10255543) for the latest release.\nA publication has just been submitted to a scientific journal. Once published, this section will be updated.\n",
    "bugtrack_url": null,
    "license": "AGPLv3",
    "summary": "A Python toolbox to fit chromatography peaks with uncertainty.",
    "version": "0.7.1",
    "project_urls": {
        "documentation": "https://jugit.fz-juelich.de/IBG-1/micropro/peak-performance",
        "homepage": "https://jugit.fz-juelich.de/IBG-1/micropro/peak-performance",
        "repository": "https://jugit.fz-juelich.de/IBG-1/micropro/peak-performance"
    },
    "split_keywords": [
        "hplc",
        " mass-spectrometry",
        " uncertainty quantification"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0d14d9877ed82ffbf0a78924e3d2dfe286e15b8ff357c9f5a84be404ccabf505",
                "md5": "ffe616d290023c7ae41e4922a19687c7",
                "sha256": "79ae425866e825d08749f942f425ac3f20690ef129e2d3096351a640cab213dc"
            },
            "downloads": -1,
            "filename": "peak_performance-0.7.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ffe616d290023c7ae41e4922a19687c7",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 43441,
            "upload_time": "2024-10-13T14:47:24",
            "upload_time_iso_8601": "2024-10-13T14:47:24.317302Z",
            "url": "https://files.pythonhosted.org/packages/0d/14/d9877ed82ffbf0a78924e3d2dfe286e15b8ff357c9f5a84be404ccabf505/peak_performance-0.7.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-13 14:47:24",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "peak-performance"
}
        
Elapsed time: 1.00939s