Metadata-Version: 2.3
Name: xsdba
Version: 0.2.0
Summary: Statistical correction and bias adjustment tools for xarray.
Keywords: xsdba
Author-email: Éric Dupuis <dupuis.eric@ouranos.ca>, Trevor James Smith <smith.trevorj@ouranos.ca>
Maintainer-email: Éric Dupuis <dupuis.eric@ouranos.ca>, Trevor James Smith <smith.trevorj@ouranos.ca>
Requires-Python: >=3.10.0
Description-Content-Type: text/x-rst
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Scientific/Engineering :: Mathematics
Requires-Dist: boltons >=20.1
Requires-Dist: bottleneck >=1.3.1
Requires-Dist: cf_xarray>=0.10.0
Requires-Dist: cftime >=1.4.1
Requires-Dist: dask >=2024.8.1
Requires-Dist: h5netcdf>=1.3.0
Requires-Dist: jsonpickle >=3.1.0
Requires-Dist: numba >=0.54.1
Requires-Dist: numpy >=1.23.0,<2.0
Requires-Dist: pint>=0.24.3
Requires-Dist: scipy >=1.9.0
Requires-Dist: statsmodels >=0.14.2
Requires-Dist: typer >=0.12.3
Requires-Dist: xarray >=2023.11.0
Requires-Dist: yamale >=5.0.0
Requires-Dist: xsdba[dev] ; extra == "all"
Requires-Dist: xsdba[docs] ; extra == "all"
Requires-Dist: black ==24.10.0 ; extra == "dev"
Requires-Dist: blackdoc ==0.3.9 ; extra == "dev"
Requires-Dist: bump-my-version >=0.28.0 ; extra == "dev"
Requires-Dist: coverage >=7.5.0 ; extra == "dev"
Requires-Dist: coveralls >=4.0.1 ; extra == "dev"
Requires-Dist: flake8 >=7.1.1 ; extra == "dev"
Requires-Dist: flake8-rst-docstrings >=0.3.0 ; extra == "dev"
Requires-Dist: flit >=3.9.0,<4.0 ; extra == "dev"
Requires-Dist: isort ==5.13.2 ; extra == "dev"
Requires-Dist: mypy ; extra == "dev"
Requires-Dist: netcdf4 ; extra == "dev"
Requires-Dist: numpydoc >=1.8.0 ; extra == "dev"
Requires-Dist: pip >=24.3.1 ; extra == "dev"
Requires-Dist: pooch >=1.8.0 ; extra == "dev"
Requires-Dist: pre-commit >=3.5.0 ; extra == "dev"
Requires-Dist: pytest <9.0.0 ; extra == "dev"
Requires-Dist: pytest-cov >=5.0.0 ; extra == "dev"
Requires-Dist: pytest-xdist >=3.2.0 ; extra == "dev"
Requires-Dist: ruff >=0.8.2 ; extra == "dev"
Requires-Dist: tox >=4.23.2 ; extra == "dev"
Requires-Dist: watchdog >=4.0.0 ; extra == "dev"
Requires-Dist: xclim >= 0.53.2 ; extra == "dev"
Requires-Dist: xdoctest>=1.1.5 ; extra == "dev"
Requires-Dist: furo >=2023.9.10 ; extra == "docs"
Requires-Dist: ipykernel ; extra == "docs"
Requires-Dist: ipython >=8.5.0 ; extra == "docs"
Requires-Dist: jupyter_client ; extra == "docs"
Requires-Dist: nbsphinx >=0.9.5 ; extra == "docs"
Requires-Dist: nc-time-axis >=1.4.1 ; extra == "docs"
Requires-Dist: pooch >=1.8.0 ; extra == "docs"
Requires-Dist: pygments<2.19 ; extra == "docs"
Requires-Dist: sphinx >=7.0.0 ; extra == "docs"
Requires-Dist: sphinx-autobuild >=2024.4.16 ; extra == "docs"
Requires-Dist: sphinx-autodoc-typehints ; extra == "docs"
Requires-Dist: sphinx-codeautolink ; extra == "docs"
Requires-Dist: sphinx-copybutton ; extra == "docs"
Requires-Dist: sphinx-intl ; extra == "docs"
Requires-Dist: sphinx-mdinclude ; extra == "docs"
Requires-Dist: sphinxcontrib-bibtex ; extra == "docs"
Project-URL: About Ouranos, https://ouranos.ca/en/
Project-URL: Changelog, https://xsdba.readthedocs.io/en/stable/changelog.html
Project-URL: Homepage, https://xsdba.readthedocs.io/
Project-URL: Issue tracker, https://github.com/Ouranosinc/xsdba/issues
Project-URL: Source, https://github.com/Ouranosinc/xsdba
Provides-Extra: all
Provides-Extra: dev
Provides-Extra: docs

===========================================================
xsdba: Statistical Downscaling and Bias Adjustment library
===========================================================

+----------------------------+-----------------------------------------------------+
| Versions                   | |pypi| |versions|                                   |
+----------------------------+-----------------------------------------------------+
| Documentation and Support  | |docs|                                              |
+----------------------------+-----------------------------------------------------+
| Open Source                | |license| |ossf|                                    |
+----------------------------+-----------------------------------------------------+
| Coding Standards           | |black| |ruff| |pre-commit|                         |
+----------------------------+-----------------------------------------------------+
| Development Status         | |status| |build| |coveralls|                        |
+----------------------------+-----------------------------------------------------+

Statistical correction and bias adjustment tools for xarray.

* Free software: Apache Software License 2.0
* Documentation: https://xsdba.readthedocs.io.

Features
--------

* The `xsdba` submodule provides a collection of bias-adjustment methods meant to correct for systematic biases found in climate model simulations relative to observations.
  Almost all adjustment algorithms conform to the `train` - `adjust` scheme, meaning that adjustment factors are first estimated on training data sets, then applied in a distinct step to the data to be adjusted.
  Given a reference time series (`ref`), historical simulations (`hist`) and simulations to be adjusted (`sim`), any bias-adjustment method would be applied by first estimating the adjustment factors between the historical simulation and the observation series, and then applying these factors to `sim``, which could be a future simulation:

* Time grouping (months, day of year, season) can be done within bias adjustment methods.

* Properties and measures utilities can be used to assess the quality of adjustments.

Quick Install
-------------
`xsdba` can be installed from PyPI:

.. code-block:: shell

    $ pip install xsdba

Documentation
-------------
The official documentation is at https://xsdba.readthedocs.io/

How to make the most of `xsdba`: `Basic Usage Examples`_ and `In-Depth Examples`_.

.. _Basic Usage Examples: https://xsdba.readthedocs.io/en/latest/notebooks/example.html
.. _In-Depth Examples: https://xsdba.readthedocs.io/en/latest/notebooks/advanced_example.html


Credits
-------

This package was created with Cookiecutter_ and the `Ouranosinc/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/cookiecutter/cookiecutter
.. _`Ouranosinc/cookiecutter-pypackage`: https://github.com/Ouranosinc/cookiecutter-pypackage


.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
        :target: https://github.com/psf/black
        :alt: Python Black

.. |build| image:: https://github.com/Ouranosinc/xsdba/actions/workflows/main.yml/badge.svg
        :target: https://github.com/Ouranosinc/xsdba/actions
        :alt: Build Status

.. |coveralls| image:: https://coveralls.io/repos/github/Ouranosinc/xsdba/badge.svg
        :target: https://coveralls.io/github/Ouranosinc/xsdba
        :alt: Coveralls

.. |docs| image:: https://readthedocs.org/projects/xsdba/badge/?version=latest
        :target: https://xsdba.readthedocs.io/en/latest/?version=latest
        :alt: Documentation Status

.. |license| image:: https://img.shields.io/github/license/Ouranosinc/xsdba.svg
        :target: https://github.com/Ouranosinc/xsdba/blob/main/LICENSE
        :alt: License

.. |ossf| image:: https://api.securityscorecards.dev/projects/github.com/Ouranosinc/xsdba/badge
        :target: https://securityscorecards.dev/viewer/?uri=github.com/Ouranosinc/xsdba
        :alt: OpenSSF Scorecard

.. |pre-commit| image:: https://results.pre-commit.ci/badge/github/Ouranosinc/xsdba/main.svg
        :target: https://results.pre-commit.ci/latest/github/Ouranosinc/xsdba/main
        :alt: pre-commit.ci status

.. |pypi| image:: https://img.shields.io/pypi/v/xsdba.svg
        :target: https://pypi.python.org/pypi/xsdba
        :alt: PyPI

.. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
        :target: https://github.com/astral-sh/ruff
        :alt: Ruff

.. |status| image:: https://www.repostatus.org/badges/latest/active.svg
        :target: https://www.repostatus.org/#active
        :alt: Project Status: Active – The project has reached a stable, usable state and is being actively developed.

.. |versions| image:: https://img.shields.io/pypi/pyversions/xsdba.svg
        :target: https://pypi.python.org/pypi/xsdba
        :alt: Supported Python Versions

.. |logo| image:: https://raw.githubusercontent.com/Ouranosinc/xsdba/main/docs/logos/xsdba-logo-small-light.png
        :target: https://github.com/Ouranosinc/xsdba
        :alt: Xsdba
        :class: xsdba-logo-small no-theme

.. |logo-light| image:: https://raw.githubusercontent.com/Ouranosinc/xsdba/main/docs/logos/xsdba-logo-small-light.png
        :target: https://github.com/Ouranosinc/xsdba
        :alt:
        :class: xclim-logo-small only-light-inline

.. |logo-dark| image:: https://raw.githubusercontent.com/Ouranosinc/xsdba/main/docs/logos/xsdba-logo-small-dark.png
        :target: https://github.com/Ouranosinc/xsdba
        :alt:
        :class: xclim-logo-small only-dark-inline

