Metadata-Version: 2.1
Name: psy-reg
Version: 1.4.0
Summary: Psyplot plugin for visualizing and calculating regression plots
Home-page: https://github.com/psyplot/psy-reg
Author: Philipp S. Sommer
Author-email: psyplot@hereon.de
License: LGPL-3.0-only
Project-URL: Documentation, https://psyplot.github.io/psy-reg
Project-URL: Source, https://github.com/psyplot/psy-reg
Project-URL: Tracker, https://github.com/psyplot/psy-reg/issues
Keywords: visualization netcdf raster cartopy earth-sciences psyplot
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Topic :: Scientific/Engineering :: GIS
Classifier: Topic :: Scientific/Engineering
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/x-rst
License-File: COPYING
License-File: COPYING.LESSER
Requires-Dist: psyplot
Requires-Dist: psy-simple (>=1.3.0)
Requires-Dist: statsmodels
Requires-Dist: scipy

========================================================================
psy-reg: Psyplot plugin for visualizing and calculating regression plots
========================================================================

.. start-badges

.. list-table::
    :stub-columns: 1
    :widths: 10 90

    * - docs
      - |docs|
    * - tests
      - |circleci| |appveyor| |codecov|
    * - package
      - |version| |conda| |github| |zenodo|
    * - implementations
      - |supported-versions| |supported-implementations|

.. |docs| image:: https://img.shields.io/github/deployments/psyplot/psy-reg/github-pages
    :alt: Documentation
    :target: http://psyplot.github.io/psy-reg/

.. |circleci| image:: https://circleci.com/gh/psyplot/psy-reg/tree/master.svg?style=svg
    :alt: CircleCI
    :target: https://circleci.com/gh/psyplot/psy-reg/tree/master

.. |appveyor| image:: https://ci.appveyor.com/api/projects/status/48pqaquat9bennac/branch/master?svg=true
    :alt: AppVeyor
    :target: https://ci.appveyor.com/project/psyplot/psy-reg

.. |codecov| image:: https://codecov.io/gh/psyplot/psy-reg/branch/master/graph/badge.svg
    :alt: Coverage
    :target: https://codecov.io/gh/psyplot/psy-reg

.. |version| image:: https://img.shields.io/pypi/v/psy-reg.svg?style=flat
    :alt: PyPI Package latest release
    :target: https://pypi.python.org/pypi/psy-reg

.. |conda| image:: https://anaconda.org/conda-forge/psy-reg/badges/version.svg
    :alt: conda
    :target: https://anaconda.org/conda-forge/psy-reg

.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/psy-reg.svg?style=flat
    :alt: Supported versions
    :target: https://pypi.python.org/pypi/psy-reg

.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/psy-reg.svg?style=flat
    :alt: Supported implementations
    :target: https://pypi.python.org/pypi/psy-reg

.. |zenodo| image:: https://zenodo.org/badge/83479056.svg
    :alt: Zenodo
    :target: https://zenodo.org/badge/latestdoi/83479056

.. |github| image:: https://img.shields.io/github/release/psyplot/psy-reg.svg
    :target: https://github.com/psyplot/psy-reg/releases/latest
    :alt: Latest github release

.. end-badges

Welcome to the psyplot plugin for visualizating and calculating regression
plots. This package uses the scipy_ and statsmodels_ packages to evaluate your
data, fit a regression to it and visualize it through the psy-simple_ plugin.

It's plot methods are the linreg_ and densityreg_ plot methods.

See the full documentation on
`psyplot.github.io/psy-reg/ <http://psyplot.github.io/psy-reg>`__ for all
`plot methods`_, and checkout the examples_.

.. _psy-simple: http://psyplot.github.io/psy-simple/
.. _statsmodels: https://www.statsmodels.org/stable/index.html
.. _scipy: https://www.scipy.org/
.. _linreg: http://psyplot.github.io/psy-reg/generated/psyplot.project.plot.linreg.html#psyplot.project.plot.linreg
.. _densityreg: http://psyplot.github.io/psy-reg/generated/psyplot.project.plot.densityreg.html#psyplot.project.plot.densityreg
.. _plot methods: http://psyplot.github.io/psy-simple/plot_methods
.. _examples: http://psyplot.github.io/examples/


Copyright
---------
Copyright Â© 2021 Helmholtz-Zentrum Hereon, 2020-2021 Helmholtz-Zentrum
Geesthacht, 2016-2021 University of Lausanne

psy-reg is released under the GNU LGPL-3.O license.
See COPYING and COPYING.LESSER in the root of the repository for full
licensing details.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License version 3.0 as
published by the Free Software Foundation.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU LGPL-3.0 license for more details.

You should have received a copy of the GNU LGPL-3.0 license
along with this program.  If not, see https://www.gnu.org/licenses/.


