===========================================================
xsdba: Statistical Downscaling and Bias Adjustment library
===========================================================
+----------------------------+-----------------------------------------------------+
| Versions | |pypi| |conda| |versions| |
+----------------------------+-----------------------------------------------------+
| Documentation and Support | |docs| |
+----------------------------+-----------------------------------------------------+
| Open Source | |license| |ossf-score| |zenodo| |
+----------------------------+-----------------------------------------------------+
| Coding Standards | |black| |isort| |ruff| |ossf-bp| |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`_.
`xsdba` was first developed as the submodule `sdba` of `xclim`_. A `migration guide`_ is available for users of `sdba`.
.. _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
.. _xclim: https://xclim.readthedocs.io/
.. _migration guide: https://xsdba.readthedocs.io/en/stable/xclim_migration_guide.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
.. |conda| image:: https://img.shields.io/conda/vn/conda-forge/xsdba.svg
:target: https://anaconda.org/conda-forge/xsdba
:alt: Conda-forge Build Version
.. |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
.. |isort| image:: https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336
:target: https://pycqa.github.io/isort/
:alt: Isort
.. |license| image:: https://img.shields.io/github/license/Ouranosinc/xsdba.svg
:target: https://github.com/Ouranosinc/xsdba/blob/main/LICENSE
:alt: License
.. |ossf-bp| image:: https://bestpractices.coreinfrastructure.org/projects/10045/badge
:target: https://bestpractices.coreinfrastructure.org/projects/10045
:alt: Open Source Security Foundation Best Practices
.. |ossf-score| 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
.. |zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.14983948.svg
:target: https://doi.org/10.5281/zenodo.14983948
:alt: DOI
.. |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
Raw data
{
"_id": null,
"home_page": null,
"name": "xsdba",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10.0",
"maintainer_email": "\u00c9ric Dupuis <dupuis.eric@ouranos.ca>, Trevor James Smith <smith.trevorj@ouranos.ca>",
"keywords": "xsdba, bias adjustment, statistics, statistical downscaling, xarray, xclim",
"author": null,
"author_email": "\u00c9ric Dupuis <dupuis.eric@ouranos.ca>, Pascal Bourgault <bourgault.pascal@ouranos.ca>",
"download_url": "https://files.pythonhosted.org/packages/ed/30/611365d39a6f0ac3c6ea48599209beee591b3f4fd83d6f94751d4ca456d0/xsdba-0.5.0.tar.gz",
"platform": null,
"description": "===========================================================\nxsdba: Statistical Downscaling and Bias Adjustment library\n===========================================================\n\n+----------------------------+-----------------------------------------------------+\n| Versions | |pypi| |conda| |versions| |\n+----------------------------+-----------------------------------------------------+\n| Documentation and Support | |docs| |\n+----------------------------+-----------------------------------------------------+\n| Open Source | |license| |ossf-score| |zenodo| |\n+----------------------------+-----------------------------------------------------+\n| Coding Standards | |black| |isort| |ruff| |ossf-bp| |pre-commit| |\n+----------------------------+-----------------------------------------------------+\n| Development Status | |status| |build| |coveralls| |\n+----------------------------+-----------------------------------------------------+\n\nStatistical correction and bias adjustment tools for xarray.\n\n* Free software: Apache Software License 2.0\n* Documentation: https://xsdba.readthedocs.io.\n\nFeatures\n--------\n\n* The `xsdba` submodule provides a collection of bias-adjustment methods meant to correct for systematic biases found in climate model simulations relative to observations.\n 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.\n 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:\n\n* Time grouping (months, day of year, season) can be done within bias adjustment methods.\n\n* Properties and measures utilities can be used to assess the quality of adjustments.\n\nQuick Install\n-------------\n`xsdba` can be installed from PyPI:\n\n.. code-block:: shell\n\n $ pip install xsdba\n\nDocumentation\n-------------\nThe official documentation is at https://xsdba.readthedocs.io/\n\nHow to make the most of `xsdba`: `Basic Usage Examples`_ and `In-Depth Examples`_.\n\n`xsdba` was first developed as the submodule `sdba` of `xclim`_. A `migration guide`_ is available for users of `sdba`.\n\n.. _Basic Usage Examples: https://xsdba.readthedocs.io/en/latest/notebooks/example.html\n.. _In-Depth Examples: https://xsdba.readthedocs.io/en/latest/notebooks/advanced_example.html\n.. _xclim: https://xclim.readthedocs.io/\n.. _migration guide: https://xsdba.readthedocs.io/en/stable/xclim_migration_guide.html\n\nCredits\n-------\n\nThis package was created with Cookiecutter_ and the `Ouranosinc/cookiecutter-pypackage`_ project template.\n\n.. _Cookiecutter: https://github.com/cookiecutter/cookiecutter\n.. _`Ouranosinc/cookiecutter-pypackage`: https://github.com/Ouranosinc/cookiecutter-pypackage\n\n.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Python Black\n\n.. |build| image:: https://github.com/Ouranosinc/xsdba/actions/workflows/main.yml/badge.svg\n :target: https://github.com/Ouranosinc/xsdba/actions\n :alt: Build Status\n\n.. |conda| image:: https://img.shields.io/conda/vn/conda-forge/xsdba.svg\n :target: https://anaconda.org/conda-forge/xsdba\n :alt: Conda-forge Build Version\n\n.. |coveralls| image:: https://coveralls.io/repos/github/Ouranosinc/xsdba/badge.svg\n :target: https://coveralls.io/github/Ouranosinc/xsdba\n :alt: Coveralls\n\n.. |docs| image:: https://readthedocs.org/projects/xsdba/badge/?version=latest\n :target: https://xsdba.readthedocs.io/en/latest/?version=latest\n :alt: Documentation Status\n\n.. |isort| image:: https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336\n :target: https://pycqa.github.io/isort/\n :alt: Isort\n\n.. |license| image:: https://img.shields.io/github/license/Ouranosinc/xsdba.svg\n :target: https://github.com/Ouranosinc/xsdba/blob/main/LICENSE\n :alt: License\n\n.. |ossf-bp| image:: https://bestpractices.coreinfrastructure.org/projects/10045/badge\n :target: https://bestpractices.coreinfrastructure.org/projects/10045\n :alt: Open Source Security Foundation Best Practices\n\n.. |ossf-score| image:: https://api.securityscorecards.dev/projects/github.com/Ouranosinc/xsdba/badge\n :target: https://securityscorecards.dev/viewer/?uri=github.com/Ouranosinc/xsdba\n :alt: OpenSSF Scorecard\n\n.. |pre-commit| image:: https://results.pre-commit.ci/badge/github/Ouranosinc/xsdba/main.svg\n :target: https://results.pre-commit.ci/latest/github/Ouranosinc/xsdba/main\n :alt: pre-commit.ci status\n\n.. |pypi| image:: https://img.shields.io/pypi/v/xsdba.svg\n :target: https://pypi.python.org/pypi/xsdba\n :alt: PyPI\n\n.. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\n :target: https://github.com/astral-sh/ruff\n :alt: Ruff\n\n.. |status| image:: https://www.repostatus.org/badges/latest/active.svg\n :target: https://www.repostatus.org/#active\n :alt: Project Status: Active \u2013 The project has reached a stable, usable state and is being actively developed.\n\n.. |versions| image:: https://img.shields.io/pypi/pyversions/xsdba.svg\n :target: https://pypi.python.org/pypi/xsdba\n :alt: Supported Python Versions\n\n.. |zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.14983948.svg\n :target: https://doi.org/10.5281/zenodo.14983948\n :alt: DOI\n\n.. |logo| image:: https://raw.githubusercontent.com/Ouranosinc/xsdba/main/docs/logos/xsdba-logo-small-light.png\n :target: https://github.com/Ouranosinc/xsdba\n :alt: Xsdba\n :class: xsdba-logo-small no-theme\n\n.. |logo-light| image:: https://raw.githubusercontent.com/Ouranosinc/xsdba/main/docs/logos/xsdba-logo-small-light.png\n :target: https://github.com/Ouranosinc/xsdba\n :alt:\n :class: xclim-logo-small only-light-inline\n\n.. |logo-dark| image:: https://raw.githubusercontent.com/Ouranosinc/xsdba/main/docs/logos/xsdba-logo-small-dark.png\n :target: https://github.com/Ouranosinc/xsdba\n :alt:\n :class: xclim-logo-small only-dark-inline\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Statistical correction and bias adjustment tools for xarray.",
"version": "0.5.0",
"project_urls": {
"About Ouranos": "https://ouranos.ca/en/",
"Changelog": "https://xsdba.readthedocs.io/en/stable/changelog.html",
"Homepage": "https://xsdba.readthedocs.io/",
"Issue tracker": "https://github.com/Ouranosinc/xsdba/issues",
"Source": "https://github.com/Ouranosinc/xsdba"
},
"split_keywords": [
"xsdba",
" bias adjustment",
" statistics",
" statistical downscaling",
" xarray",
" xclim"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "91d962f4e49e1f07ca57b3386128d9cc15397be2dccc76b60352a14c90014985",
"md5": "8f12006063fce6fec5fbf1a8ee21999c",
"sha256": "1483ddd9bcfd56e155af18f3c3af88868e1a5a145cd360a1a5870c74b17ad024"
},
"downloads": -1,
"filename": "xsdba-0.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8f12006063fce6fec5fbf1a8ee21999c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10.0",
"size": 134004,
"upload_time": "2025-07-21T18:32:47",
"upload_time_iso_8601": "2025-07-21T18:32:47.981710Z",
"url": "https://files.pythonhosted.org/packages/91/d9/62f4e49e1f07ca57b3386128d9cc15397be2dccc76b60352a14c90014985/xsdba-0.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "ed30611365d39a6f0ac3c6ea48599209beee591b3f4fd83d6f94751d4ca456d0",
"md5": "13055c228cfb4c7180c1e0c0fc04c1f2",
"sha256": "7c216720112eda0ee2061c5f45e33eef5b8f4c7aad39861fafcae11271946f48"
},
"downloads": -1,
"filename": "xsdba-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "13055c228cfb4c7180c1e0c0fc04c1f2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10.0",
"size": 250726,
"upload_time": "2025-07-21T18:32:49",
"upload_time_iso_8601": "2025-07-21T18:32:49.716371Z",
"url": "https://files.pythonhosted.org/packages/ed/30/611365d39a6f0ac3c6ea48599209beee591b3f4fd83d6f94751d4ca456d0/xsdba-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-21 18:32:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Ouranosinc",
"github_project": "xsdba",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "xsdba"
}
JSON
