py-cordex


Namepy-cordex JSON
Version 0.7.1 PyPI version JSON
download
home_pageNone
SummaryCreation of cordex grids and meta data
upload_time2024-06-04 11:15:55
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseMIT License Copyright (c) 2020, Lars Buntemeyer Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords cordex xarray metadata cf conventions
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
py-cordex: create cordex grids and meta data
============================================

+----------------------------+-----------------------------------------------------+
| Versions                   | |pypi| |conda|                                      |
+----------------------------+-----------------------------------------------------+
| Documentation              | |docs| |versions| |binder|                          |
+----------------------------+-----------------------------------------------------+
| Open Source                | |license| |fair| |fossa| |zenodo|                   |
+----------------------------+-----------------------------------------------------+
| Coding Standards           | |black| |pre-commit|                                |
+----------------------------+-----------------------------------------------------+
| Development Status         | |ci| |codecov|                                      |
+----------------------------+-----------------------------------------------------+
| Funding                    | |funding|                                           |
+----------------------------+-----------------------------------------------------+

This package offers python tools for the `CORDEX <https://cordex.org/>`_ community and should make your work with CORDEX grids and meta data easy.
Most of the tools leverage the ``xarray`` API to create grid and coordinate informations and data of CORDEX domains in the
form of an ``xarray.Dataset`` directly from the official `CORDEX archive specifications <https://cordex.org/experiment-guidelines/experiment-protocol-rcms/>`_.

Features
--------

* Tools to manage CORDEX grids as xarray datasets.
* Includes coordinate transformations, bounds and vertices for CORDEX datasets.
* Utitlities for cmorization to make the CORDEX ensembles more consistent.
* Preprocessing for easy access to a homogenized CORDEX ensemble dataset.

For planned features, please have a look at the `issues <https://github.com/euro-cordex/py-cordex/issues>`_, grab one, and `contribute <https://py-cordex.readthedocs.io/en/latest/contributing.html>`_!

Meta data
^^^^^^^^^
Access to meta data should be automatic and machine readable to avoid humans to do boring, repetitiv tasks that are error prone.
For that purpose, easy access to meta information should be guaranteed by tables collected `here <https://github.com/euro-cordex/tables>`_.

Installation
------------

You can install py-cordex using pip or conda, e.g.

.. code-block:: console

    pip install py-cordex

or

.. code-block:: console

    conda install -c conda-forge py-cordex

Installation from source
------------------------

For instructions to install py-cordex from source, please have a look at the
`contributing guide <https://py-cordex.readthedocs.io/en/stable/contributing.html>`_.
If you want to contribute, please get in contact as early as possible, e.g.,
using `draft pull requests <https://github.blog/2019-02-14-introducing-draft-pull-requests>`_.


Credits
-------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage

Parts of this package have been developed within the project Pilot Lab Exascale Earth System Modelling (`PL-ExaESM <https://www.exaesm.de/>`_).


.. |pypi| image:: https://img.shields.io/pypi/v/py-cordex.svg
        :target: https://pypi.python.org/pypi/py-cordex
        :alt: Python Package Index Build

.. |conda| image:: https://img.shields.io/conda/vn/conda-forge/py-cordex.svg
        :target: https://anaconda.org/conda-forge/py-cordex
        :alt: Conda-forge Build Version

.. |ci| image:: https://github.com/euro-cordex/py-cordex/actions/workflows/ci.yaml/badge.svg
        :target: https://github.com/euro-cordex/py-cordex/actions/workflows/ci.yaml
        :alt: Build Status

.. |codecov| image:: https://codecov.io/gh/euro-cordex/py-cordex/branch/master/graph/badge.svg
        :target: https://codecov.io/gh/euro-cordex/py-cordex
        :alt: Covecov

.. |docs| image:: https://readthedocs.org/projects/py-cordex/badge
        :target: https://py-cordex.readthedocs.io/en/latest
        :alt: Documentation Status

.. |binder| image:: http://mybinder.org/badge_logo.svg
        :target: https://mybinder.org/v2/gh/WCRP-CORDEX/binder-sandbox/main?urlpath=git-pull%3Frepo%3Dhttps%253A%252F%252Fgithub.com%252Feuro-cordex%252Fpy-cordex%26urlpath%3Dlab%252Ftree%252Fpy-cordex%252Fdocs%252Fnotebooks%252Fintroduction.ipynb%26branch%3Dmain
        :alt: py-cordex examples

.. |zenodo| image:: https://zenodo.org/badge/304687410.svg
        :target: https://zenodo.org/badge/latestdoi/304687410
        :alt: DOI

.. |license| image:: https://img.shields.io/github/license/euro-cordex/py-cordex.svg
        :target: https://github.com/euro-cordex/py-cordex/blob/master/LICENSE
        :alt: License

.. |fair| image:: https://img.shields.io/badge/fair--software.eu-%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8B-yellow
        :target: https://fair-software.eu
        :alt: FAIR Software Compliance

.. |fossa| image:: https://app.fossa.com/api/projects/git%2Bgithub.com%2Feuro-cordex%2Fpy-cordex.svg?type=shield
        :target: https://app.fossa.com/projects/git%2Bgithub.com%2Feuro-cordex%2Fpy-cordex?ref=badge_shield
        :alt: FOSSA

.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
        :target: https://github.com/psf/black
        :alt: Python Black

.. |pre-commit| image:: https://results.pre-commit.ci/badge/github/euro-cordex/py-cordex/master.svg
        :target: https://results.pre-commit.ci/latest/github/euro-cordex/py-cordex/master
        :alt: pre-commit.ci status

.. |versions| image:: https://img.shields.io/pypi/pyversions/py-cordex.svg
        :target: https://pypi.python.org/pypi/py-cordex
        :alt: Supported Python Versions

.. |funding| image:: https://img.shields.io/badge/Powered%20by-ExaESM-blue.svg
        :target: https://www.exaesm.de/
        :alt: Funding

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "py-cordex",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "cordex, xarray, metadata, CF conventions",
    "author": null,
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/7b/8c/debd412b3d026f2f3ce7b5a5c9e02f372a33c80659ffce557ec4e4607946/py_cordex-0.7.1.tar.gz",
    "platform": null,
    "description": "\npy-cordex: create cordex grids and meta data\n============================================\n\n+----------------------------+-----------------------------------------------------+\n| Versions                   | |pypi| |conda|                                      |\n+----------------------------+-----------------------------------------------------+\n| Documentation              | |docs| |versions| |binder|                          |\n+----------------------------+-----------------------------------------------------+\n| Open Source                | |license| |fair| |fossa| |zenodo|                   |\n+----------------------------+-----------------------------------------------------+\n| Coding Standards           | |black| |pre-commit|                                |\n+----------------------------+-----------------------------------------------------+\n| Development Status         | |ci| |codecov|                                      |\n+----------------------------+-----------------------------------------------------+\n| Funding                    | |funding|                                           |\n+----------------------------+-----------------------------------------------------+\n\nThis package offers python tools for the `CORDEX <https://cordex.org/>`_ community and should make your work with CORDEX grids and meta data easy.\nMost of the tools leverage the ``xarray`` API to create grid and coordinate informations and data of CORDEX domains in the\nform of an ``xarray.Dataset`` directly from the official `CORDEX archive specifications <https://cordex.org/experiment-guidelines/experiment-protocol-rcms/>`_.\n\nFeatures\n--------\n\n* Tools to manage CORDEX grids as xarray datasets.\n* Includes coordinate transformations, bounds and vertices for CORDEX datasets.\n* Utitlities for cmorization to make the CORDEX ensembles more consistent.\n* Preprocessing for easy access to a homogenized CORDEX ensemble dataset.\n\nFor planned features, please have a look at the `issues <https://github.com/euro-cordex/py-cordex/issues>`_, grab one, and `contribute <https://py-cordex.readthedocs.io/en/latest/contributing.html>`_!\n\nMeta data\n^^^^^^^^^\nAccess to meta data should be automatic and machine readable to avoid humans to do boring, repetitiv tasks that are error prone.\nFor that purpose, easy access to meta information should be guaranteed by tables collected `here <https://github.com/euro-cordex/tables>`_.\n\nInstallation\n------------\n\nYou can install py-cordex using pip or conda, e.g.\n\n.. code-block:: console\n\n    pip install py-cordex\n\nor\n\n.. code-block:: console\n\n    conda install -c conda-forge py-cordex\n\nInstallation from source\n------------------------\n\nFor instructions to install py-cordex from source, please have a look at the\n`contributing guide <https://py-cordex.readthedocs.io/en/stable/contributing.html>`_.\nIf you want to contribute, please get in contact as early as possible, e.g.,\nusing `draft pull requests <https://github.blog/2019-02-14-introducing-draft-pull-requests>`_.\n\n\nCredits\n-------\n\nThis package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.\n\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage\n\nParts of this package have been developed within the project Pilot Lab Exascale Earth System Modelling (`PL-ExaESM <https://www.exaesm.de/>`_).\n\n\n.. |pypi| image:: https://img.shields.io/pypi/v/py-cordex.svg\n        :target: https://pypi.python.org/pypi/py-cordex\n        :alt: Python Package Index Build\n\n.. |conda| image:: https://img.shields.io/conda/vn/conda-forge/py-cordex.svg\n        :target: https://anaconda.org/conda-forge/py-cordex\n        :alt: Conda-forge Build Version\n\n.. |ci| image:: https://github.com/euro-cordex/py-cordex/actions/workflows/ci.yaml/badge.svg\n        :target: https://github.com/euro-cordex/py-cordex/actions/workflows/ci.yaml\n        :alt: Build Status\n\n.. |codecov| image:: https://codecov.io/gh/euro-cordex/py-cordex/branch/master/graph/badge.svg\n        :target: https://codecov.io/gh/euro-cordex/py-cordex\n        :alt: Covecov\n\n.. |docs| image:: https://readthedocs.org/projects/py-cordex/badge\n        :target: https://py-cordex.readthedocs.io/en/latest\n        :alt: Documentation Status\n\n.. |binder| image:: http://mybinder.org/badge_logo.svg\n        :target: https://mybinder.org/v2/gh/WCRP-CORDEX/binder-sandbox/main?urlpath=git-pull%3Frepo%3Dhttps%253A%252F%252Fgithub.com%252Feuro-cordex%252Fpy-cordex%26urlpath%3Dlab%252Ftree%252Fpy-cordex%252Fdocs%252Fnotebooks%252Fintroduction.ipynb%26branch%3Dmain\n        :alt: py-cordex examples\n\n.. |zenodo| image:: https://zenodo.org/badge/304687410.svg\n        :target: https://zenodo.org/badge/latestdoi/304687410\n        :alt: DOI\n\n.. |license| image:: https://img.shields.io/github/license/euro-cordex/py-cordex.svg\n        :target: https://github.com/euro-cordex/py-cordex/blob/master/LICENSE\n        :alt: License\n\n.. |fair| image:: https://img.shields.io/badge/fair--software.eu-%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8B-yellow\n        :target: https://fair-software.eu\n        :alt: FAIR Software Compliance\n\n.. |fossa| image:: https://app.fossa.com/api/projects/git%2Bgithub.com%2Feuro-cordex%2Fpy-cordex.svg?type=shield\n        :target: https://app.fossa.com/projects/git%2Bgithub.com%2Feuro-cordex%2Fpy-cordex?ref=badge_shield\n        :alt: FOSSA\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.. |pre-commit| image:: https://results.pre-commit.ci/badge/github/euro-cordex/py-cordex/master.svg\n        :target: https://results.pre-commit.ci/latest/github/euro-cordex/py-cordex/master\n        :alt: pre-commit.ci status\n\n.. |versions| image:: https://img.shields.io/pypi/pyversions/py-cordex.svg\n        :target: https://pypi.python.org/pypi/py-cordex\n        :alt: Supported Python Versions\n\n.. |funding| image:: https://img.shields.io/badge/Powered%20by-ExaESM-blue.svg\n        :target: https://www.exaesm.de/\n        :alt: Funding\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2020, Lars Buntemeyer  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "Creation of cordex grids and meta data",
    "version": "0.7.1",
    "project_urls": {
        "changelog": "https://py-cordex.readthedocs.io/en/latest/whats-new.html",
        "documentation": "https://py-cordex.readthedocs.io",
        "homepage": "https://py-cordex.readthedocs.io",
        "repository": "https://github.com/euro-cordex/py-cordex.git"
    },
    "split_keywords": [
        "cordex",
        " xarray",
        " metadata",
        " cf conventions"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "45672717061fbff921d9d3f0e7fab0272aba26e59c65390bf0a89286fd11280e",
                "md5": "a1e742da320ab3254ac3e59ddf66054e",
                "sha256": "8b1aaf844e6b0b290838be3a1a1b86de5fdc55ff83d062481291c9705a0c509f"
            },
            "downloads": -1,
            "filename": "py_cordex-0.7.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a1e742da320ab3254ac3e59ddf66054e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 41866,
            "upload_time": "2024-06-04T11:15:52",
            "upload_time_iso_8601": "2024-06-04T11:15:52.330912Z",
            "url": "https://files.pythonhosted.org/packages/45/67/2717061fbff921d9d3f0e7fab0272aba26e59c65390bf0a89286fd11280e/py_cordex-0.7.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7b8cdebd412b3d026f2f3ce7b5a5c9e02f372a33c80659ffce557ec4e4607946",
                "md5": "a4b2cbf2eb092b5a426408eb97a0bf32",
                "sha256": "bfda093765738af0667e32bfb47953a0743135c7b0096f699f76b35dfeca360c"
            },
            "downloads": -1,
            "filename": "py_cordex-0.7.1.tar.gz",
            "has_sig": false,
            "md5_digest": "a4b2cbf2eb092b5a426408eb97a0bf32",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 12468617,
            "upload_time": "2024-06-04T11:15:55",
            "upload_time_iso_8601": "2024-06-04T11:15:55.925103Z",
            "url": "https://files.pythonhosted.org/packages/7b/8c/debd412b3d026f2f3ce7b5a5c9e02f372a33c80659ffce557ec4e4607946/py_cordex-0.7.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-06-04 11:15:55",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "euro-cordex",
    "github_project": "py-cordex",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "py-cordex"
}
        
Elapsed time: 0.42662s