Data

Tools

Indexes

Applications

Experiments

Open Source Science

xscen

A climate change scenario-building analysis framework.

https://github.com/ouranosinc/xscen

Science Score: 59.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 3 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ✓
    Committers with academic emails
    1 of 15 committers (6.7%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.5%) to scientific vocabulary

Keywords from Contributors

anuclim climate-analysis climate-science icclim netcdf4 xclim archiving hydrology climate raven
Last synced: 6 months ago · JSON representation

Repository

A climate change scenario-building analysis framework.

Basic Info
Statistics
  • Stars: 20
  • Watchers: 5
  • Forks: 3
  • Open Issues: 44
  • Releases: 19
Created over 3 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Security Authors Zenodo

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

  • Name: Ouranos inc.
  • Login: Ouranosinc
  • Kind: organization
  • Location: Canada

Consortium on regional climatology

GitHub Events

Total
  • Create event: 128
  • Commit comment event: 2
  • Release event: 9
  • Issues event: 36
  • Watch event: 4
  • Delete event: 117
  • Issue comment event: 158
  • Push event: 533
  • Pull request review comment event: 115
  • Pull request review event: 193
  • Pull request event: 225
Last Year
  • Create event: 128
  • Commit comment event: 2
  • Release event: 9
  • Issues event: 36
  • Watch event: 4
  • Delete event: 117
  • Issue comment event: 158
  • Push event: 533
  • Pull request review comment event: 115
  • Pull request review event: 193
  • Pull request event: 225

Committers

Last synced: 6 months ago

All Time
  • Total Commits: 2,547
  • Total Committers: 15
  • Avg Commits per committer: 169.8
  • Development Distribution Score (DDS): 0.75
Past Year
  • Commits: 659
  • Committers: 11
  • Avg Commits per committer: 59.909
  • Development Distribution Score (DDS): 0.701
Top Committers
Name Email Commits
RondeauG r****l@o****a 638
Zeitsperre 1****e 498
juliettelavoie j****e@h****a 492
Pascal Bourgault b****l@o****a 354
bumpversion[bot] b****]@o****a 160
pre-commit-ci[bot] 6****] 109
dependabot[bot] 4****] 91
É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 19
Pascal Bourgault b****l@o****a 9
Eric Dupuis e****s@d****a 4
ArtemBuyalo a****o@m****a 3
Blaise Gauvin St-Denis s****e@o****a 2
Committer Domains (Top 20 + Academic)
ouranos.ca: 7 mail.mcgill.ca: 1 doris.ouranos.ca: 1 umontreal.ca: 1 hotmail.ca: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 105
  • Total pull requests: 652
  • Average time to close issues: 3 months
  • Average time to close pull requests: 5 days
  • Total issue authors: 14
  • Total pull request authors: 13
  • Average comments per issue: 1.75
  • Average comments per pull request: 0.92
  • Merged pull requests: 527
  • Bot issues: 6
  • Bot pull requests: 267
Past Year
  • Issues: 19
  • Pull requests: 294
  • Average time to close issues: 6 days
  • Average time to close pull requests: 5 days
  • Issue authors: 7
  • Pull request authors: 9
  • Average comments per issue: 1.63
  • Average comments per pull request: 0.93
  • Merged pull requests: 202
  • Bot issues: 3
  • Bot pull requests: 118
View more stats
Top Authors
Issue Authors
  • RondeauG (37)
  • juliettelavoie (24)
  • aulemahal (16)
  • Zeitsperre (6)
  • SarahG-579462 (6)
  • github-actions[bot] (5)
  • coxipi (2)
  • mccrayc (2)
  • sarahclaude (2)
  • vindelico (1)
  • sg2475962 (1)
  • dependabot[bot] (1)
  • lou-a (1)
  • bstdenis (1)
Pull Request Authors
  • dependabot[bot] (223)
  • RondeauG (107)
  • Zeitsperre (104)
  • aulemahal (85)
  • juliettelavoie (57)
  • pre-commit-ci[bot] (44)
  • coxipi (17)
  • vindelico (5)
  • SarahG-579462 (5)
  • bstdenis (2)
  • ArtemBuyalo (1)
  • sarahclaude (1)
  • sg2475962 (1)
Top Labels
Issue Labels
enhancement (42) bug (31) documentation (8) CI (5) help wanted (3) wontfix (2) good first issue (1) dependencies (1) github_actions (1)
Pull Request Labels
dependencies (232) CI (120) github_actions (113) python (109) docs (34) documentation (18) enhancement (11) bug (10) xclim (1)

Packages

  • Total packages: 3
  • Total downloads:
    • pypi 541 last-month
  • Total dependent packages: 1
    (may contain duplicates)
  • Total dependent repositories: 1
    (may contain duplicates)
  • Total versions: 59
  • Total maintainers: 3
proxy.golang.org: github.com/ouranosinc/xscen
  • Versions: 21
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 6 months ago
proxy.golang.org: github.com/Ouranosinc/xscen
  • Versions: 21
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 6 months ago
pypi.org: xscen

A climate change scenario-building analysis framework, built with xclim/xarray.

  • Versions: 17
  • Dependent Packages: 1
  • Dependent Repositories: 1
  • Downloads: 541 Last month
Rankings
Dependent packages count: 4.8%
Stargazers count: 16.1%
Average: 19.5%
Dependent repos count: 21.5%
Forks count: 22.6%
Downloads: 32.3%
Maintainers (3)
Zeitsperre juliettelavoie RondeauG
Last synced: 6 months ago

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