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
climate-science climate-analysis netcdf4 xclim anuclim icclim climate earth-system-model archiving wps
Last synced: about 22 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 4 years ago)
- Default Branch: main
- Last Pushed: 2026-09-09T17:46:59.000Z (3 days ago)
- Last Synced: 2026-09-10T03:36:13.665Z (3 days ago)
- Language: Python
- Homepage: https://xscen.readthedocs.io/
- Size: 14.2 MB
- Stars: 19
- Watchers: 5
- Forks: 3
- Open Issues: 45
- Releases: 25
-
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
- Agents: AGENTS.md
README.rst
============
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
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.15.2"
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
- Commit comment event: 2
- Create event: 166
- Delete event: 163
- Issue comment event: 178
- Issues event: 43
- Pull request event: 291
- Pull request review comment event: 139
- Pull request review event: 232
- Push event: 698
- Release event: 9
- Watch event: 4
Last Year
- Create event: 38
- Delete event: 46
- Issue comment event: 20
- Issues event: 6
- Pull request event: 66
- Pull request review comment event: 24
- Pull request review event: 39
- Push event: 165
Committers metadata
Last synced: 2 days ago
Total Commits: 2,952
Total Committers: 18
Avg Commits per committer: 164.0
Development Distribution Score (DDS): 0.766
Commits in past year: 380
Committers in past year: 9
Avg Commits per committer in past year: 42.222
Development Distribution Score (DDS) in past year: 0.676
| Name | Commits | |
|---|---|---|
| RondeauG | r****l@o****a | 690 |
| Zeitsperre | 1****e | 623 |
| juliettelavoie | j****e@h****a | 561 |
| Pascal Bourgault | b****l@o****a | 423 |
| bumpversion[bot] | b****]@o****a | 160 |
| pre-commit-ci[bot] | 6****] | 136 |
| dependabot[bot] | 4****] | 131 |
| É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 |
| tlogan2000 | l****s@o****a | 13 |
| 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 |
| Asli Bese | a****e@d****a | 2 |
Committer domains:
- ouranos.ca: 9
- doris.ouranos.ca: 2
- mail.mcgill.ca: 1
- umontreal.ca: 1
- hotmail.ca: 1
Issue and Pull Request metadata
Last synced: 2 days ago
Total issues: 110
Total pull requests: 683
Average time to close issues: 4 months
Average time to close pull requests: 5 days
Total issue authors: 15
Total pull request authors: 17
Average comments per issue: 1.77
Average comments per pull request: 0.92
Merged pull request: 547
Bot issues: 7
Bot pull requests: 280
Past year issues: 4
Past year pull requests: 32
Past year average time to close issues: about 2 hours
Past year average time to close pull requests: 2 days
Past year issue authors: 4
Past year pull request authors: 7
Past year average comments per issue: 0.0
Past year average comments per pull request: 0.97
Past year merged pull request: 21
Past year bot issues: 1
Past year bot pull requests: 14
Top Issue Authors
- RondeauG (38)
- juliettelavoie (24)
- aulemahal (18)
- Zeitsperre (6)
- github-actions[bot] (6)
- SarahG-579462 (6)
- coxipi (2)
- mccrayc (2)
- sarahclaude (2)
- vindelico (1)
- martinguthrie93 (1)
- sg2475962 (1)
- dependabot[bot] (1)
- lou-a (1)
- bstdenis (1)
Top Pull Request Authors
- dependabot[bot] (230)
- RondeauG (110)
- Zeitsperre (106)
- aulemahal (87)
- juliettelavoie (64)
- pre-commit-ci[bot] (50)
- coxipi (17)
- SarahG-579462 (5)
- vindelico (5)
- bstdenis (2)
- sg2475962 (1)
- leandrohstein (1)
- SamrithaS (1)
- martinguthrie93 (1)
- sarahclaude (1)
Top Issue Labels
- enhancement (43)
- bug (33)
- documentation (8)
- CI (6)
- help wanted (3)
- wontfix (2)
- github_actions (1)
- dependencies (1)
- good first issue (1)
Top Pull Request Labels
- dependencies (240)
- CI (137)
- python (115)
- github_actions (114)
- docs (38)
- documentation (18)
- bug (11)
- enhancement (11)
- xclim (1)
Package metadata
- Total packages: 3
-
Total downloads:
- pypi: 441 last-month
- Total dependent packages: 1 (may contain duplicates)
- Total dependent repositories: 1 (may contain duplicates)
- Total versions: 74
- Total maintainers: 3
proxy.golang.org: github.com/ouranosinc/xscen
- Homepage:
- Documentation: https://pkg.go.dev/github.com/ouranosinc/xscen#section-documentation
- Licenses: apache-2.0
- Latest release: v0.15.2 (published 2 months ago)
- Last Synced: 2026-09-11T04:21:08.559Z (2 days ago)
- Versions: 26
- Dependent Packages: 0
- Dependent Repositories: 0
-
Rankings:
- Dependent packages count: 5.395%
- Average: 5.576%
- Dependent repos count: 5.758%
proxy.golang.org: github.com/Ouranosinc/xscen
- Homepage:
- Documentation: https://pkg.go.dev/github.com/Ouranosinc/xscen#section-documentation
- Licenses: apache-2.0
- Latest release: v0.15.2 (published 2 months ago)
- Last Synced: 2026-09-11T04:04:29.390Z (2 days ago)
- Versions: 26
- Dependent Packages: 0
- Dependent Repositories: 0
-
Rankings:
- Dependent packages count: 5.395%
- Average: 5.576%
- Dependent repos count: 5.758%
pypi.org: xscen
A climate change scenario-building analysis framework, built with xclim/xarray.
- Homepage: https://xscen.readthedocs.io/
- Documentation: https://xscen.readthedocs.io/
- Licenses: Apache-2.0
- Latest release: 0.15.2 (published 2 months ago)
- Last Synced: 2026-09-11T04:03:50.707Z (2 days ago)
- Versions: 22
- Dependent Packages: 1
- Dependent Repositories: 1
- Downloads: 441 Last month
-
Rankings:
- Dependent packages count: 4.798%
- Stargazers count: 16.055%
- Average: 19.464%
- Dependent repos count: 21.526%
- Forks count: 22.633%
- Downloads: 32.31%
- Maintainers (3)
Dependencies
- actions/checkout v3 composite
- actions/setup-python v4 composite
- ad-m/github-push-action master composite
- actions/labeler v4 composite
- actions/checkout v3 composite
- actions/setup-python v4 composite
- mamba-org/setup-micromamba v1 composite
- styfle/cancel-workflow-action 0.11.0 composite
- actions/checkout v3 composite
- actions/setup-python v4 composite
- pypa/gh-action-pypi-publish release/v1 composite
- actions/checkout v3 composite
- actions/setup-python v4 composite
- pypa/gh-action-pypi-publish release/v1 composite
- babel *
- cartopy *
- cf_xarray >=0.7.6
- cftime *
- clisops >=0.10
- dask *
- flox *
- fsspec <2023.10.0
- geopandas *
- h5netcdf *
- h5py *
- intake-esm >=2023.07.07
- matplotlib *
- netCDF4 *
- numpy *
- pandas >=2.0
- parse *
- pyarrow *
- pyyaml *
- rechunker *
- shapely >=2.0
- sparse *
- toolz *
- xarray <2023.11.0
- xclim >=0.46.0
- xesmf >=0.7
- zarr *
- actions/checkout 9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 composite
- step-security/harden-runner 9af89fc71515a100421586dfdb3dc9c984fbf411 composite
- actions/github-script 3a2844b7e9c422d3c10d287c895573f7108da1b3 composite
- step-security/harden-runner 9af89fc71515a100421586dfdb3dc9c984fbf411 composite
- actions/checkout 9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 composite
- github/codeql-action/analyze 8aad20d150bbac5944a9f9d289da16a4b0d87c1e composite
- github/codeql-action/init 8aad20d150bbac5944a9f9d289da16a4b0d87c1e composite
- step-security/harden-runner 9af89fc71515a100421586dfdb3dc9c984fbf411 composite
- actions/checkout 9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 composite
- actions/upload-artifact 043fb46d1a93c77aae656e7c1c64a875d1fc6a0a composite
- github/codeql-action/upload-sarif 8aad20d150bbac5944a9f9d289da16a4b0d87c1e composite
- ossf/scorecard-action 4eaacf0543bb3f2c246792bd56e8cdeffafb205a composite
- step-security/harden-runner 9af89fc71515a100421586dfdb3dc9c984fbf411 composite
- annotated-types ==0.7.0
- anyio ==4.8.0
- astroid ==4.0.4
- bracex ==2.4
- bump-my-version ==1.4.1
- cachetools ==7.0.5
- certifi ==2024.7.4
- charset-normalizer ==3.3.2
- click ==8.1.7
- colorama ==0.4.6
- deptry ==0.25.1
- dill ==0.3.9
- distlib ==0.3.8
- docutils ==0.21.2
- exceptiongroup ==1.3.1
- filelock ==3.25.2
- flit ==3.12.0
- flit-core ==3.12.0
- h11 ==0.16.0
- httpcore2 ==2.5.0
- httpx2 ==2.5.0
- idna ==3.18
- isort ==6.0.1
- markdown-it-py ==3.0.0
- mccabe ==0.7.0
- mdurl ==0.1.2
- packaging ==26.0
- pip ==26.1.2
- platformdirs ==4.9.4
- pluggy ==1.6.0
- prompt-toolkit ==3.0.36
- pydantic ==2.13.4
- pydantic-core ==2.46.4
- pydantic-settings ==2.3.4
- pygments ==2.20.0
- pylint ==4.0.6
- pyproject-api ==1.10.0
- python-discovery ==1.4.2
- python-dotenv ==1.2.2
- questionary ==2.0.1
- requests ==2.33.0
- requirements-parser ==0.11.0
- rich ==13.7.1
- rich-click ==1.8.3
- sniffio ==1.3.1
- tomli ==2.4.1
- tomli-w ==1.2.0
- tomlkit ==0.13.0
- tox ==4.56.0
- tox-gh ==1.7.1
- truststore ==0.10.4
- types-setuptools ==75.8.0.20250110
- typing-extensions ==4.15.0
- typing-inspection ==0.4.2
- urllib3 ==2.7.0
- virtualenv ==21.2.0
- wcmatch ==8.5.2
- wcwidth ==0.2.13
- actions/checkout 9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 composite
- actions/create-github-app-token bcd2ba49218906704ab6c1aa796996da409d3eb1 composite
- dependabot/fetch-metadata 25dd0e34f4fe68f24cc83900b1fe3fe149efef98 composite
- step-security/harden-runner 9af89fc71515a100421586dfdb3dc9c984fbf411 composite
- actions/checkout 9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 composite
- mamba-org/setup-micromamba d7c9bd84e824b79d2af72a2d4196c7f4300d3476 composite
- step-security/harden-runner 9af89fc71515a100421586dfdb3dc9c984fbf411 composite
- xarray-contrib/issue-from-pytest-log 8e905db353437cda1d6a773de245343fbfc940dd composite
- step-security/harden-runner 9af89fc71515a100421586dfdb3dc9c984fbf411 composite
- bump-my-version ==1.4.1
- deptry ==0.25.1
- exceptiongroup ==1.3.1
- flit ==3.12.0
- pip ==26.1.2
- pydantic ==2.13.4
- pylint ==4.0.6
- tox ==4.56.0
- tox-gh ==1.7.1
- actions/checkout 9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 composite
- actions/dependency-review-action a1d282b36b6f3519aa1f3fc636f609c47dddb294 composite
- step-security/harden-runner 9af89fc71515a100421586dfdb3dc9c984fbf411 composite
Score: 13.1495737932759