xscen


Namexscen JSON
Version 0.11.0 PyPI version JSON
download
home_pageNone
SummaryA climate change scenario-building analysis framework, built with xclim/xarray.
upload_time2025-01-23 15:11:10
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10.0
licenseNone
keywords xscen
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ============
xscen |logo|
============

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

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/

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

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

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "xscen",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10.0",
    "maintainer_email": "Gabriel Rondeau-Genesse <rondeau-genesse.gabriel@ouranos.ca>, Trevor James Smith <smith.trevorj@ouranos.ca>",
    "keywords": "xscen",
    "author": null,
    "author_email": "Gabriel Rondeau-Genesse <rondeau-genesse.gabriel@ouranos.ca>, Pascal Bourgault <bourgault.pascal@ouranos.ca>, Juliette Lavoie <lavoie.juliette@ouranos.ca>",
    "download_url": "https://files.pythonhosted.org/packages/7d/cc/7c4e58ccf14def036d2c90abb37b29fe9c167d615645f06cb914c2dfef46/xscen-0.11.0.tar.gz",
    "platform": null,
    "description": "============\nxscen |logo|\n============\n\n+----------------------------+-----------------------------------------------------+\n| Versions                   | |pypi| |conda| |versions|                           |\n+----------------------------+-----------------------------------------------------+\n| Documentation and Support  | |docs|                                              |\n+----------------------------+-----------------------------------------------------+\n| Open Source                | |license| |ossf-score| |zenodo|                     |\n+----------------------------+-----------------------------------------------------+\n| Coding Standards           | |black| |ruff| |pre-commit| |ossf-bp| |fossa|       |\n+----------------------------+-----------------------------------------------------+\n| Development Status         | |status| |build| |coveralls|                        |\n+----------------------------+-----------------------------------------------------+\n\nA climate change scenario-building analysis framework, built with `intake-esm` catalogs and `xarray`-based packages such as `xclim` and `xESMF`.\n\nFor documentation concerning `xscen`, see: https://xscen.readthedocs.io/en/latest/\n\nFeatures\n--------\n* Supports workflows with YAML configuration files for better transparency, reproducibility, and long-term backups.\n* `intake-esm`_-based catalog to find and manage climate data.\n* Climate dataset extraction, subsetting, and temporal aggregation.\n* Calculate missing variables through `intake-esm`'s `DerivedVariableRegistry`_.\n* Regridding powered by `xESMF`_.\n* Bias adjustment tools provided by `xclim`_.\n\nInstallation\n------------\n\nPlease refer to the `installation docs`_.\n\nAcknowledgments\n---------------\nThis package was created with Cookiecutter_ and the `Ouranosinc/cookiecutter-pypackage`_ project template.\n\n.. _Cookiecutter: https://github.com/cookiecutter/cookiecutter\n.. _DerivedVariableRegistry: https://intake-esm.readthedocs.io/en/latest/how-to/define-and-use-derived-variable-registry.html\n.. _Ouranosinc/cookiecutter-pypackage: https://github.com/Ouranosinc/cookiecutter-pypackage\n.. _installation docs: https://xscen.readthedocs.io/en/latest/installation.html\n.. _intake-esm: https://intake-esm.readthedocs.io/\n.. _xESMF: https://xesmf.readthedocs.io/\n.. _xclim: https://xclim.readthedocs.io/\n\n.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n        :target: https://github.com/psf/black\n        :alt: Python Black\n\n.. |build| image:: https://github.com/Ouranosinc/xscen/actions/workflows/main.yml/badge.svg\n        :target: https://github.com/Ouranosinc/xscen/actions/workflows/main.yml\n        :alt: Build Status\n\n.. |conda| image:: https://img.shields.io/conda/vn/conda-forge/xscen.svg\n        :target: https://anaconda.org/conda-forge/xscen\n        :alt: Conda Build\n\n.. |coveralls| image:: https://coveralls.io/repos/github/Ouranosinc/xscen/badge.svg\n        :target: https://coveralls.io/github/Ouranosinc/xscen\n        :alt: Coveralls\n\n.. |docs| image:: https://readthedocs.org/projects/xscen/badge/?version=latest\n        :target: https://xscen.readthedocs.io/en/latest\n        :alt: Documentation Status\n\n.. |fossa| image:: https://app.fossa.com/api/projects/git%2Bgithub.com%2FOuranosinc%2Fxscen.svg?type=shield\n        :target: https://app.fossa.com/projects/git%2Bgithub.com%2FOuranosinc%2Fxscen?ref=badge_shield\n        :alt: FOSSA\n\n.. |license| image:: https://img.shields.io/pypi/l/figanos\n        :target: https://github.com/Ouranosinc/figanos/blob/main/LICENSE\n        :alt: License\n\n.. |logo| image:: https://raw.githubusercontent.com/Ouranosinc/xscen/main/docs/_static/_images/xscen-logo-small.png\n        :target: https://github.com/Ouranosinc/xscen\n        :alt: xscen Logo\n\n.. |ossf-bp| image:: https://bestpractices.coreinfrastructure.org/projects/9945/badge\n        :target: https://bestpractices.coreinfrastructure.org/projects/9945\n        :alt: Open Source Security Foundation Best Practices\n\n.. |ossf-score| image:: https://api.securityscorecards.dev/projects/github.com/Ouranosinc/xscen/badge\n        :target: https://securityscorecards.dev/viewer/?uri=github.com/Ouranosinc/xscen\n        :alt: Open Source Security Foundation Scorecard\n\n.. |pre-commit| image:: https://results.pre-commit.ci/badge/github/Ouranosinc/xscen/main.svg\n        :target: https://results.pre-commit.ci/latest/github/Ouranosinc/xscen/main\n        :alt: pre-commit.ci status\n\n.. |pypi| image:: https://img.shields.io/pypi/v/xscen.svg\n        :target: https://pypi.python.org/pypi/xscen\n        :alt: Python Package Index\n\n.. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\n        :target: https://github.com/astral-sh/ruff\n        :alt: Ruff\n\n.. |status| image:: https://www.repostatus.org/badges/latest/active.svg\n        :target: https://www.repostatus.org/#active\n        :alt: Project Status: Active  The project has reached a stable, usable state and is being actively developed.\n\n.. |versions| image:: https://img.shields.io/pypi/pyversions/xscen.svg\n        :target: https://pypi.python.org/pypi/xscen\n        :alt: Supported Python Versions\n\n.. |zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.7897542.svg\n        :target: https://doi.org/10.5281/zenodo.7897542\n        :alt: Zenodo DOI\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A climate change scenario-building analysis framework, built with xclim/xarray.",
    "version": "0.11.0",
    "project_urls": {
        "About Ouranos": "https://ouranos.ca/en/",
        "Changelog": "https://xscen.readthedocs.io/en/stable/changelog.html",
        "Homepage": "https://xscen.readthedocs.io/",
        "Issue tracker": "https://github.com/Ouranosinc/xscen/issues",
        "Source": "https://github.com/Ouranosinc/xscen"
    },
    "split_keywords": [
        "xscen"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "588ef3b72adfe9d4eca11d751524e22642ecbe799044b04b09995f09f689d19b",
                "md5": "e37f5c0072702698238a429f6f10b27b",
                "sha256": "37a4634839d8221982cb0b9b048c2f1fd1379c3de7488ebfbdb7f5e4193640c7"
            },
            "downloads": -1,
            "filename": "xscen-0.11.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e37f5c0072702698238a429f6f10b27b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10.0",
            "size": 363968,
            "upload_time": "2025-01-23T15:11:08",
            "upload_time_iso_8601": "2025-01-23T15:11:08.254668Z",
            "url": "https://files.pythonhosted.org/packages/58/8e/f3b72adfe9d4eca11d751524e22642ecbe799044b04b09995f09f689d19b/xscen-0.11.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7dcc7c4e58ccf14def036d2c90abb37b29fe9c167d615645f06cb914c2dfef46",
                "md5": "044219d5676559f07cee0b90afe9d92c",
                "sha256": "ee71f49f331456e9862556e4dbffb68d6331b6f9d434a3570623b15fd7086f5d"
            },
            "downloads": -1,
            "filename": "xscen-0.11.0.tar.gz",
            "has_sig": false,
            "md5_digest": "044219d5676559f07cee0b90afe9d92c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10.0",
            "size": 517984,
            "upload_time": "2025-01-23T15:11:10",
            "upload_time_iso_8601": "2025-01-23T15:11:10.642548Z",
            "url": "https://files.pythonhosted.org/packages/7d/cc/7c4e58ccf14def036d2c90abb37b29fe9c167d615645f06cb914c2dfef46/xscen-0.11.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-23 15:11:10",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Ouranosinc",
    "github_project": "xscen",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "xscen"
}
        
Elapsed time: 0.51076s