xscen

A climate change scenario-building analysis framework, built with Intake-esm catalogs and xarray-based packages such as xclim and xESMF.
https://github.com/Ouranosinc/xscen

Category: Climate Change
Sub Category: Climate Data Processing and Analysis

Keywords from Contributors

archiving climate-science anuclim climate-analysis icclim netcdf4 xclim hydrology earth-system-model climate

Last synced: about 12 hours ago
JSON representation

Repository metadata

A climate change scenario-building analysis framework.

• Host: GitHub
• URL: https://github.com/Ouranosinc/xscen
• Owner: Ouranosinc
• License: apache-2.0
• Created: 2022-06-02T19:59:19.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2025-10-21T15:02:22.000Z (13 days ago)
• Last Synced: 2025-10-23T15:52:44.386Z (11 days ago)
• Language: Python
• Homepage: https://xscen.readthedocs.io/
• Size: 13.3 MB
• Stars: 20
• Watchers: 5
• Forks: 3
• Open Issues: 44
• Releases: 20
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Citation: CITATION.cff
  • Security: SECURITY.md
  • Authors: AUTHORS.rst
  • Zenodo: .zenodo.json

README.rst

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

+----------------------------+-------------------------------------------------------+
| Versions                   | |pypi| |conda|                                        |
+----------------------------+-------------------------------------------------------+
| Documentation and Support  | |docs| |versions|                                     |
+----------------------------+-------------------------------------------------------+
| Open Source                | |license| |ossf-score| |zenodo|                       |
+----------------------------+-------------------------------------------------------+
| Coding Standards           | |ruff| |pre-commit| |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
---------------
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
.. _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| 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

.. |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

        

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit and templated with cookiecutter.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: "1.2.0"
title: "xscen"
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: "software"
authors:
  - given-names: "Gabriel"
    family-names: "Rondeau-Genesse"
    affiliation: "Ouranos"
    city: "Montreal"
    country: "CA"
    email: 'rondeau-genesse.gabriel@ouranos.ca'
    orcid: "https://orcid.org/0000-0003-3389-9406"
  - given-names: "Pascal"
    family-names: "Bourgault"
    affiliation: "Ouranos"
    city: "Montreal"
    country: "CA"
    email: 'bourgault.pascal@ouranos.ca'
    orcid: "https://orcid.org/0000-0003-1192-0403"
  - given-names: "Juliette"
    family-names: "Lavoie"
    affiliation: "Ouranos"
    city: "Montreal"
    country: "CA"
    orcid: "https://orcid.org/0000-0002-4708-5182"
  - given-names: "Trevor James"
    family-names: "Smith"
    affiliation: "Ouranos"
    city: "Montreal"
    country: "CA"
    email: 'smith.trevorj@ouranos.ca'
    orcid: "https://orcid.org/0000-0001-5393-8359"
  - given-names: "Sarah"
    family-names: "Gammon"
    affiliation: "Ouranos"
    city: "Montreal"
    country: "CA"
    email: 'gammon.sarah@ouranos.ca'
    orcid: "https://orcid.org/0009-0007-6082-9063"
  - given-names: "Travis"
    family-names: "Logan"
    affiliation: "Ouranos"
    city: "Montreal"
    country: "CA"
    email: 'logan.travis@ouranos.ca'
    orcid: "https://orcid.org/0000-0002-2212-9580"
  - given-names: "Louis-Philippe"
    family-names: "Caron"
    affiliation: "Ouranos"
    city: "Montreal"
    country: "CA"
    email: 'caron.louis-philippe@ouranos.ca'
    orcid: "https://orcid.org/0000-0001-5221-0147"
  - given-names: "Marco"
    family-names: "Braun"
    affiliation: "Ouranos"
    city: "Montreal"
    country: "CA"
    email: 'braun.marco@ouranos.ca'
    orcid: "https://orcid.org/0000-0001-5061-3217"
  - given-names: "Sarah-Claude"
    family-names: "Bourdeau-Goulet"
    affiliation: "Ouranos"
    city: "Montreal"
    country: "CA"
    email: 'bourdeau-goulet.sarah-claude@ouranos.ca'
    orcid: "https://orcid.org/0000-0002-6125-2557"
  - given-names: "Blaise"
    family-names: "Gauvin St-Denis"
    affiliation: "Ouranos"
    city: "Montreal"
    country: "CA"
    email: 'gauvin-st-denis.blaise@ouranos.ca'
    orcid: "https://orcid.org/0009-0004-9049-2092"
  - given-names: "Éric"
    family-names: "Dupuis"
    affiliation: "Ouranos"
    city: "Montreal"
    country: "CA"
    email: 'dupuis.eric@ouranos.ca'
    orcid: "https://orcid.org/0000-0001-7976-4596"
  - given-names: "Artem"
    family-names: "Buyalo"
    affiliation: "Ouranos"
    city: "Montreal"
    country: "CA"
    orcid: "https://orcid.org/0009-0006-3403-6636"
contact:
  - given-names: "Gabriel"
    family-names: "Rondeau-Genesse"
    affiliation: "Ouranos"
    city: "Montreal"
    country: "CA"
    email: 'rondeau-genesse.gabriel@ouranos.ca'
    orcid: "https://orcid.org/0000-0003-3389-9406"
repository-code: "https://github.com/Ouranosinc/xscen"
abstract: "A climate change scenario-building analysis framework, built with xclim/xarray."
license: "Apache-2.0"
version: "0.13.1"

---

Owner metadata

• Name: Ouranos inc.
• Login: Ouranosinc
• Email:
• Kind: organization
• Description: Consortium on regional climatology
• Website: www.ouranos.ca
• Location: Canada
• Twitter: ouranos_cc
• Company:
• Icon url: https://avatars.githubusercontent.com/u/1696763?v=4
• Repositories: 37
• Last ynced at: 2023-02-26T14:20:41.025Z
• Profile URL: https://github.com/Ouranosinc

---

GitHub Events

Total

• Create event: 135
• Commit comment event: 2
• Release event: 9
• Issues event: 37
• Watch event: 4
• Delete event: 125
• Issue comment event: 164
• Push event: 571
• Pull request review comment event: 118
• Pull request review event: 201
• Pull request event: 245

Last Year

• Create event: 129
• Commit comment event: 2
• Release event: 9
• Issues event: 37
• Watch event: 4
• Delete event: 123
• Issue comment event: 163
• Push event: 543
• Pull request review comment event: 108
• Pull request review event: 187
• Pull request event: 237

---

Committers metadata

Last synced: 5 days ago

Name	Email	Commits
RondeauG	r****l@o****a	645
Zeitsperre	1****e	525
juliettelavoie	j****e@h****a	501
Pascal Bourgault	b****l@o****a	359
bumpversion[bot]	b****]@o****a	160
pre-commit-ci[bot]	6****]	113
dependabot[bot]	4****]	100
Éric Dupuis	e****1@u****a	76
Marco Braun	B****o@o****a	71
Sarah-Claude Bourdeau	8****e	23
SarahG-579462	g****h@o****a	19
Pascal Bourgault	b****l@o****a	9
Rondeau-Genesse	g****1@o****a	6
Eric Dupuis	e****s@d****a	4
ArtemBuyalo	a****o@m****a	3
Blaise Gauvin St-Denis	s****e@o****a	2

Committer domains:

• ouranos.ca: 8
• mail.mcgill.ca: 1
• doris.ouranos.ca: 1
• umontreal.ca: 1
• hotmail.ca: 1

---

Issue and Pull Request metadata

Last synced: 13 days ago

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/Ouranosinc/xscen

---

---

---

Package metadata

• Total packages: 3
• Total downloads:
  • pypi: 2,476 last-month
• Total dependent packages: 1 (may contain duplicates)
• Total dependent repositories: 1 (may contain duplicates)
• Total versions: 62
• Total maintainers: 3

---

Dependencies

Score: 14.747888789291254