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 climate-analysis netcdf4 xclim anuclim icclim climate earth-system-model observation

Last synced: about 23 hours ago
JSON representation

Repository metadata

A climate change scenario-building analysis framework.

README.rst

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

+----------------------------+-------------------------------------------------------+
| Versions                   | |pypi| |conda| |versions|                             |
+----------------------------+-------------------------------------------------------+
| Documentation and Support  | |docs|                                                |
+----------------------------+-------------------------------------------------------+
| Open Source                | |license| |ossf-score| |zenodo|                       |
+----------------------------+-------------------------------------------------------+
| Coding Standards           | |black| |isort| |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/

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

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

        

Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 12 days ago

Total Commits: 2,468
Total Committers: 14
Avg Commits per committer: 176.286
Development Distribution Score (DDS): 0.741

Commits in past year: 699
Committers in past year: 12
Avg Commits per committer in past year: 58.25
Development Distribution Score (DDS) in past year: 0.707

Name Email Commits
RondeauG r****l@o****a 638
Zeitsperre 1****e 486
juliettelavoie j****e@h****a 467
Pascal Bourgault b****l@o****a 338
bumpversion[bot] b****]@o****a 160
pre-commit-ci[bot] 6****] 106
dependabot[bot] 4****] 79
Éric Dupuis e****1@u****a 74
Marco Braun B****o@o****a 71
Sarah-Claude Bourdeau 8****e 23
SarahG-579462 g****h@o****a 11
Pascal Bourgault b****l@o****a 9
Eric Dupuis e****s@d****a 4
Blaise Gauvin St-Denis s****e@o****a 2

Committer domains:


Issue and Pull Request metadata

Last synced: 2 days ago

Total issues: 104
Total pull requests: 450
Average time to close issues: 3 months
Average time to close pull requests: 5 days
Total issue authors: 13
Total pull request authors: 12
Average comments per issue: 1.96
Average comments per pull request: 0.94
Merged pull request: 388
Bot issues: 5
Bot pull requests: 184

Past year issues: 19
Past year pull requests: 199
Past year average time to close issues: 28 days
Past year average time to close pull requests: 6 days
Past year issue authors: 6
Past year pull request authors: 9
Past year average comments per issue: 2.58
Past year average comments per pull request: 0.96
Past year merged pull request: 155
Past year bot issues: 3
Past year bot pull requests: 96

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

Top Issue Authors

  • RondeauG (39)
  • juliettelavoie (23)
  • aulemahal (16)
  • SarahG-579462 (6)
  • Zeitsperre (5)
  • github-actions[bot] (5)
  • coxipi (2)
  • mccrayc (2)
  • sarahclaude (2)
  • vindelico (1)
  • sg2475962 (1)
  • lou-a (1)
  • bstdenis (1)

Top Pull Request Authors

  • dependabot[bot] (144)
  • RondeauG (76)
  • Zeitsperre (75)
  • aulemahal (60)
  • pre-commit-ci[bot] (40)
  • juliettelavoie (37)
  • coxipi (9)
  • vindelico (4)
  • SarahG-579462 (2)
  • sg2475962 (1)
  • sarahclaude (1)
  • bstdenis (1)

Top Issue Labels

  • enhancement (40)
  • bug (32)
  • documentation (7)
  • CI (5)
  • help wanted (3)
  • wontfix (2)
  • good first issue (1)

Top Pull Request Labels

  • dependencies (149)
  • CI (77)
  • github_actions (75)
  • python (69)
  • docs (27)
  • documentation (16)
  • bug (9)
  • enhancement (9)
  • xclim (1)

Package metadata

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.12.3 (published 13 days ago)
  • Last Synced: 2025-06-05T11:16:16.105Z (3 days ago)
  • Versions: 20
  • 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.12.3 (published 13 days ago)
  • Last Synced: 2025-06-05T11:17:33.338Z (3 days ago)
  • Versions: 20
  • 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 Software License
  • Latest release: 0.12.3 (published 13 days ago)
  • Last Synced: 2025-06-06T10:40:33.313Z (2 days ago)
  • Versions: 16
  • Dependent Packages: 1
  • Dependent Repositories: 1
  • Downloads: 621 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

.github/workflows/bump-version.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • ad-m/github-push-action master composite
.github/workflows/codeql-analysis.yml actions
  • actions/checkout v3 composite
  • github/codeql-action/analyze v1 composite
  • github/codeql-action/autobuild v1 composite
  • github/codeql-action/init v1 composite
.github/workflows/conda-build.yml actions
  • actions/checkout v3 composite
  • haya14busa/action-cond v1 composite
  • mamba-org/provision-with-micromamba main composite
  • uibcdf/action-build-and-upload-conda-packages v1.2.0 composite
.github/workflows/first_pull_request.yml actions
  • actions/github-script v6 composite
.github/workflows/label.yml actions
  • actions/labeler v4 composite
.github/workflows/main.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • mamba-org/setup-micromamba v1 composite
  • styfle/cancel-workflow-action 0.11.0 composite
.github/workflows/publish-pypi.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • pypa/gh-action-pypi-publish release/v1 composite
.github/workflows/remove-obsolete-cache.yml actions
  • actions/checkout v3 composite
.github/workflows/tag-testpypi.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • pypa/gh-action-pypi-publish release/v1 composite
setup.py pypi
.github/workflows/actions-versions-updater.yml actions
  • actions/checkout v4.1.1 composite
  • saadmk11/github-actions-version-updater v0.8.1 composite
pyproject.toml pypi
  • 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 *
environment.yml conda
  • 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
  • nc-time-axis >=1.3.1
  • netcdf4
  • numpy
  • pandas >=2.0
  • parse
  • pip
  • pyarrow >=1.0.0
  • python >=3.9
  • pyyaml
  • rechunker
  • shapely >=2.0
  • sparse
  • toolz
  • xarray <2023.11.0
  • xclim >=0.46.0
  • xesmf >=0.7
  • zarr

Score: 13.121458968549907