============ xscen |logo|

+----------------------------+-------------------------------------------------------+ | Versions | |pypi| |conda| | +----------------------------+-------------------------------------------------------+ | Documentation and Support | |docs| |versions| | +----------------------------+-------------------------------------------------------+ | Open Source | |license| |ossf-score| |zenodo| | +----------------------------+-------------------------------------------------------+ | Coding Standards | |ruff| |prek| |pre-commit-ci| |ossf-bp| |fossa| | +----------------------------+-------------------------------------------------------+ | Development Status | |status| |build| |coveralls| | +----------------------------+-------------------------------------------------------+

A climate change scenario-building analysis framework, built with intake-esm catalogs and xarray-based packages such as xclim and xESMF.

For documentation concerning xscen, see: https://xscen.readthedocs.io/en/latest/

Features

• Supports workflows with YAML configuration files for better transparency, reproducibility, and long-term backups.
• intake-esm_-based catalog to find and manage climate data.
• Climate dataset extraction, subsetting, and temporal aggregation.
• Calculate missing variables through intake-esm's DerivedVariableRegistry_.
• Regridding powered by xESMF_.
• Bias adjustment tools provided by xsdba_.

Installation

Please refer to the installation docs_.

Acknowledgments

xscen development is funded through Ouranos_, a not-for-profit collaborative innovation organization fostering resilient adaptation to climate change, based in Québec, Canada.

.. image:: https://raw.githubusercontent.com/Ouranosinc/.github/refs/heads/main/images/logo-ouranos-horizontal-couleur.svg :target: https://www.ouranos.ca/en :align: center

This package was created with Cookiecutter_ and the Ouranosinc/cookiecutter-pypackage_ project template.

.. _Cookiecutter: https://github.com/cookiecutter/cookiecutter .. _DerivedVariableRegistry: https://intake-esm.readthedocs.io/en/latest/how-to/define-and-use-derived-variable-registry.html .. _Ouranos: https://www.ouranos.ca/en .. _Ouranosinc/cookiecutter-pypackage: https://github.com/Ouranosinc/cookiecutter-pypackage .. _installation docs: https://xscen.readthedocs.io/en/latest/installation.html .. _intake-esm: https://intake-esm.readthedocs.io/ .. _xESMF: https://xesmf.readthedocs.io/ .. _xclim: https://xclim.readthedocs.io/ .. _xsdba: https://xsdba.readthedocs.io/

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

.. |conda| image:: https://img.shields.io/conda/vn/conda-forge/xscen.svg :target: https://anaconda.org/conda-forge/xscen :alt: Conda Build

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

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

.. |fossa| image:: https://app.fossa.com/api/projects/git%2Bgithub.com%2FOuranosinc%2Fxscen.svg?type=shield :target: https://app.fossa.com/projects/git%2Bgithub.com%2FOuranosinc%2Fxscen?ref=badge_shield :alt: FOSSA

.. |license| image:: https://img.shields.io/pypi/l/figanos :target: https://github.com/Ouranosinc/figanos/blob/main/LICENSE :alt: License

.. |logo| image:: https://raw.githubusercontent.com/Ouranosinc/xscen/main/docs/_static/_images/xscen-logo-small.png :target: https://github.com/Ouranosinc/xscen :alt: xscen Logo

.. |ossf-bp| image:: https://bestpractices.coreinfrastructure.org/projects/9945/badge :target: https://bestpractices.coreinfrastructure.org/projects/9945 :alt: Open Source Security Foundation Best Practices

.. |ossf-score| image:: https://api.securityscorecards.dev/projects/github.com/Ouranosinc/xscen/badge :target: https://securityscorecards.dev/viewer/?uri=github.com/Ouranosinc/xscen :alt: Open Source Security Foundation Scorecard

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

.. |prek| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/j178/prek/master/docs/assets/badge-v0.json :target: https://github.com/j178/prek :alt: prek

.. |pypi| image:: https://img.shields.io/pypi/v/xscen.svg :target: https://pypi.python.org/pypi/xscen :alt: Python Package Index

.. |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/xscen.svg :target: https://pypi.python.org/pypi/xscen :alt: Supported Python Versions

.. |zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.7897542.svg :target: https://doi.org/10.5281/zenodo.7897542 :alt: Zenodo DOI