<!--
SPDX-FileCopyrightText: 2021-2024 Helmholtz-Zentrum hereon GmbH
SPDX-License-Identifier: CC-BY-4.0
-->
# psy-reg: Psyplot plugin for visualizing and calculating regression plots
[![CI](https://codebase.helmholtz.cloud/psyplot/psy-reg/badges/main/pipeline.svg)](https://codebase.helmholtz.cloud/psyplot/psy-reg/-/pipelines?page=1&scope=all&ref=main)
[![Code coverage](https://codebase.helmholtz.cloud/psyplot/psy-reg/badges/main/coverage.svg)](https://codebase.helmholtz.cloud/psyplot/psy-reg/-/graphs/main/charts)
[![Latest Release](https://codebase.helmholtz.cloud/psyplot/psy-reg/-/badges/release.svg)](https://codebase.helmholtz.cloud/psyplot/psy-reg)
<!-- TODO: uncomment the following line when the package is published at https://pypi.org -->
<!-- [![PyPI version](https://img.shields.io/pypi/v/psy-reg.svg)](https://pypi.python.org/pypi/psy-reg/) -->
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
[![PEP8](https://img.shields.io/badge/code%20style-pep8-orange.svg)](https://www.python.org/dev/peps/pep-0008/)
[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
<!-- TODO: uncomment the following line when the package is registered at https://api.reuse.software -->
<!-- [![REUSE status](https://api.reuse.software/badge/codebase.helmholtz.cloud/psyplot/psy-reg)](https://api.reuse.software/info/codebase.helmholtz.cloud/psyplot/psy-reg) -->
Welcome to the psyplot plugin for visualizating and calculating
regression plots. This package uses the [scipy](https://www.scipy.org/)
and [statsmodels](https://www.statsmodels.org/stable/index.html)
packages to evaluate your data, fit a regression to it and visualize it
through the [psy-simple](http://psyplot.github.io/psy-simple/) plugin.
It\'s plot methods are the
[linreg](http://psyplot.github.io/psy-reg/generated/psyplot.project.plot.linreg.html#psyplot.project.plot.linreg)
and
[densityreg](http://psyplot.github.io/psy-reg/generated/psyplot.project.plot.densityreg.html#psyplot.project.plot.densityreg)
plot methods.
See the full documentation on
[psyplot.github.io/psy-reg/](http://psyplot.github.io/psy-reg) for all
[plot methods](http://psyplot.github.io/psy-simple/plot_methods), and
checkout the [examples](http://psyplot.github.io/examples/).
## Installation
Install this package in a dedicated python environment via
```bash
python -m venv venv
source venv/bin/activate
pip install psy-reg
```
To use this in a development setup, clone the [source code][source code] from
gitlab, start the development server and make your changes::
```bash
git clone https://codebase.helmholtz.cloud/psyplot/psy-reg
cd psy-reg
python -m venv venv
source venv/bin/activate
make dev-install
```
More detailed installation instructions my be found in the [docs][docs].
[source code]: https://codebase.helmholtz.cloud/psyplot/psy-reg
[docs]: https://psyplot.github.io/psy-reginstallation.html
## Technical note
This package has been generated from the template
https://codebase.helmholtz.cloud/psyplot/psyplot-plugin-template.git.
See the template repository for instructions on how to update the skeleton for
this package.
## License information
Copyright © 2021-2024 Helmholtz-Zentrum hereon GmbH
Code files in this repository are licensed under the
LGPL-3.0-only, if not stated otherwise
in the file.
Documentation files in this repository are licensed under CC-BY-4.0, if not stated otherwise in the file.
Supplementary and configuration files in this repository are licensed
under CC0-1.0, if not stated otherwise
in the file.
Please check the header of the individual files for more detailed
information.
### License management
License management is handled with [``reuse``](https://reuse.readthedocs.io/).
If you have any questions on this, please have a look into the
[contributing guide][contributing] or contact the maintainers of
`psy-reg`.
[contributing]: https://psyplot.github.io/psy-regcontributing.html
Raw data
{
"_id": null,
"home_page": null,
"name": "psy-reg",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "\"Philipp S. Sommer\" <philipp.sommer@hereon.de>",
"keywords": "visualization, psyplot, netcdf, matplotlib, regression, statistics",
"author": null,
"author_email": "\"Philipp S. Sommer\" <philipp.sommer@hereon.de>",
"download_url": "https://files.pythonhosted.org/packages/a4/f4/8e339ea1d0027005062c65f6aaf8159b591dca7a01ced3957514ecc5a893/psy_reg-1.5.0.tar.gz",
"platform": null,
"description": "<!--\nSPDX-FileCopyrightText: 2021-2024 Helmholtz-Zentrum hereon GmbH\n\nSPDX-License-Identifier: CC-BY-4.0\n-->\n\n# psy-reg: Psyplot plugin for visualizing and calculating regression plots\n\n[![CI](https://codebase.helmholtz.cloud/psyplot/psy-reg/badges/main/pipeline.svg)](https://codebase.helmholtz.cloud/psyplot/psy-reg/-/pipelines?page=1&scope=all&ref=main)\n[![Code coverage](https://codebase.helmholtz.cloud/psyplot/psy-reg/badges/main/coverage.svg)](https://codebase.helmholtz.cloud/psyplot/psy-reg/-/graphs/main/charts)\n[![Latest Release](https://codebase.helmholtz.cloud/psyplot/psy-reg/-/badges/release.svg)](https://codebase.helmholtz.cloud/psyplot/psy-reg)\n<!-- TODO: uncomment the following line when the package is published at https://pypi.org -->\n<!-- [![PyPI version](https://img.shields.io/pypi/v/psy-reg.svg)](https://pypi.python.org/pypi/psy-reg/) -->\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)\n[![PEP8](https://img.shields.io/badge/code%20style-pep8-orange.svg)](https://www.python.org/dev/peps/pep-0008/)\n[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)\n<!-- TODO: uncomment the following line when the package is registered at https://api.reuse.software -->\n<!-- [![REUSE status](https://api.reuse.software/badge/codebase.helmholtz.cloud/psyplot/psy-reg)](https://api.reuse.software/info/codebase.helmholtz.cloud/psyplot/psy-reg) -->\n\n\nWelcome to the psyplot plugin for visualizating and calculating\nregression plots. This package uses the [scipy](https://www.scipy.org/)\nand [statsmodels](https://www.statsmodels.org/stable/index.html)\npackages to evaluate your data, fit a regression to it and visualize it\nthrough the [psy-simple](http://psyplot.github.io/psy-simple/) plugin.\n\nIt\\'s plot methods are the\n[linreg](http://psyplot.github.io/psy-reg/generated/psyplot.project.plot.linreg.html#psyplot.project.plot.linreg)\nand\n[densityreg](http://psyplot.github.io/psy-reg/generated/psyplot.project.plot.densityreg.html#psyplot.project.plot.densityreg)\nplot methods.\n\nSee the full documentation on\n[psyplot.github.io/psy-reg/](http://psyplot.github.io/psy-reg) for all\n[plot methods](http://psyplot.github.io/psy-simple/plot_methods), and\ncheckout the [examples](http://psyplot.github.io/examples/).\n\n\n## Installation\n\nInstall this package in a dedicated python environment via\n\n```bash\npython -m venv venv\nsource venv/bin/activate\npip install psy-reg\n```\n\nTo use this in a development setup, clone the [source code][source code] from\ngitlab, start the development server and make your changes::\n\n```bash\ngit clone https://codebase.helmholtz.cloud/psyplot/psy-reg\ncd psy-reg\npython -m venv venv\nsource venv/bin/activate\nmake dev-install\n```\n\nMore detailed installation instructions my be found in the [docs][docs].\n\n\n[source code]: https://codebase.helmholtz.cloud/psyplot/psy-reg\n[docs]: https://psyplot.github.io/psy-reginstallation.html\n\n## Technical note\n\nThis package has been generated from the template\nhttps://codebase.helmholtz.cloud/psyplot/psyplot-plugin-template.git.\n\nSee the template repository for instructions on how to update the skeleton for\nthis package.\n\n\n## License information\n\nCopyright \u00a9 2021-2024 Helmholtz-Zentrum hereon GmbH\n\n\n\nCode files in this repository are licensed under the\nLGPL-3.0-only, if not stated otherwise\nin the file.\n\nDocumentation files in this repository are licensed under CC-BY-4.0, if not stated otherwise in the file.\n\nSupplementary and configuration files in this repository are licensed\nunder CC0-1.0, if not stated otherwise\nin the file.\n\nPlease check the header of the individual files for more detailed\ninformation.\n\n\n\n### License management\n\nLicense management is handled with [``reuse``](https://reuse.readthedocs.io/).\nIf you have any questions on this, please have a look into the\n[contributing guide][contributing] or contact the maintainers of\n`psy-reg`.\n\n[contributing]: https://psyplot.github.io/psy-regcontributing.html\n",
"bugtrack_url": null,
"license": "LGPL-3.0-only",
"summary": "Psyplot plugin for visualizing and calculating regression plots",
"version": "1.5.0",
"project_urls": {
"Documentation": "https://psyplot.github.io/psy-reg",
"Homepage": "https://codebase.helmholtz.cloud/psyplot/psy-reg",
"Source": "https://codebase.helmholtz.cloud/psyplot/psy-reg",
"Tracker": "https://codebase.helmholtz.cloud/psyplot/psy-reg/issues/"
},
"split_keywords": [
"visualization",
" psyplot",
" netcdf",
" matplotlib",
" regression",
" statistics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "601c999165724cc2972f4efa44993d7fb176e44ae35e2dfe0c55f786b38c3181",
"md5": "ee8e2644619ab59a91fb85bd99073836",
"sha256": "7787d0f9369954d5cec5cfe272ec37be791a62f030f5f3405850d7c271d0e933"
},
"downloads": -1,
"filename": "psy_reg-1.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ee8e2644619ab59a91fb85bd99073836",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 37571,
"upload_time": "2024-07-16T13:43:43",
"upload_time_iso_8601": "2024-07-16T13:43:43.248630Z",
"url": "https://files.pythonhosted.org/packages/60/1c/999165724cc2972f4efa44993d7fb176e44ae35e2dfe0c55f786b38c3181/psy_reg-1.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a4f48e339ea1d0027005062c65f6aaf8159b591dca7a01ced3957514ecc5a893",
"md5": "a1a35c0e9f965e1b0792679c2b2712b8",
"sha256": "c8003fe474a0a26330c0492b0e704e3956413813c8e25bb5cb538de40cdf49f1"
},
"downloads": -1,
"filename": "psy_reg-1.5.0.tar.gz",
"has_sig": false,
"md5_digest": "a1a35c0e9f965e1b0792679c2b2712b8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 40590,
"upload_time": "2024-07-16T13:43:45",
"upload_time_iso_8601": "2024-07-16T13:43:45.017448Z",
"url": "https://files.pythonhosted.org/packages/a4/f4/8e339ea1d0027005062c65f6aaf8159b591dca7a01ced3957514ecc5a893/psy_reg-1.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-16 13:43:45",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "psy-reg"
}