| Name | index-calculator JSON |
| Version |
0.12.0
JSON |
| download |
| home_page | None |
| Summary | Python index-calculator is an xclim wrapper |
| upload_time | 2024-07-16 10:39:13 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT License Copyright (c) 2022, Ludwig Lierhammer 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 |
index_calculator
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
|
| coveralls test coverage |
No coveralls.
|
============================================================================================
Calculate climate indicators with standardized project-specific attributes: index_calculator
============================================================================================
+----------------------------+-----------------------------------------------------+
| Versions | |pypi| |versions| |
+----------------------------+-----------------------------------------------------+
| Documentation and Support | |docs| |
+----------------------------+-----------------------------------------------------+
| Open Source | |license| |zenodo| |
+----------------------------+-----------------------------------------------------+
| Coding Standards | |black| |ruff| |pre-commit| |security| |fossa| |
+----------------------------+-----------------------------------------------------+
| Development Status | |status| |build| |coveralls| |
+----------------------------+-----------------------------------------------------+
Python index_calculator is an xclim wrapper to calculate climate indicators from CMORized netCDF files.
Documentation
-------------
The official documentation is at https://index-calculator.readthedocs.io/
Features
--------
* Calculate climate indices via xclim_.
* Write standardized netCDF attributes.
* Write on disk with a project-specific output file name.
Available projects
------------------
You can calculate climate indicators using index_calculator with the projects listed in the table below.
+--------------------+--------------+
| CMIP | CMIP5, CMIP6 |
+--------------------+--------------+
| CORDEX | CORDEX |
+--------------------+--------------+
| Observational data | E-OBS, HYRAS |
+--------------------+--------------+
| Reanalysis data | ERA5 |
+--------------------+--------------+
Installation
------------
You can install the package directly with pip:
.. code-block:: console
pip install index_calculator
If you want to contribute, we recommend cloning the repository, setup a conda environmant and installing the package in development mode, e.g.
.. code-block:: console
git clone https://github.com/ludwiglierhammer/index_calculator
cd index_calculator
conda env create -f ci/requirements/environment.yml
conda activate xcalc-tests
pip install -e . --no-deps
This will install the package but you can still edit it and you don't need the package in your :code:`PYTHONPATH`
Requirements
------------
* python3.6 or higher
* xclim
* numpy
* pandas
* xarray
* cf_xarray
* cftime
Credits
-------
This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
.. _xclim: https://xclim.readthedocs.io/en/latest/
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
.. |pypi| image:: https://img.shields.io/pypi/v/index_calculator.svg
:target: https://pypi.python.org/pypi/index_calculator
:alt: Python Package Index Build
.. |docs| image:: https://readthedocs.org/projects/index_calculator/badge/?version=latest
:target: https://index-calculator.readthedocs.io/en/latest/?version=latest
:alt: Documentation Status
.. |versions| image:: https://img.shields.io/pypi/pyversions/index_calculator.svg
:target: https://pypi.python.org/pypi/index_calculator
:alt: Supported Python Versions
.. |license| image:: https://img.shields.io/github/license/ludwiglierhammer/index_calculator.svg
:target: https://github.com/ludwiglierhammer/index_calculator/blob/master/LICENSE
:alt: License
.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Python Black
.. |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
.. |pre-commit| image:: https://results.pre-commit.ci/badge/github/climate-service-center/index_calculator/main.svg
:target: https://results.pre-commit.ci/latest/github/climate-service-center/index_calculator/main
:alt: pre-commit.ci status
.. |fossa| image:: https://app.fossa.com/api/projects/git%2Bgithub.com%2Fludwiglierhammer%2Findex_calculator.svg?type=shield
:target: https://app.fossa.com/projects/git%2Bgithub.com%2Fludwiglierhammer%2Findex_calculator?ref=badge_shield
:alt: FOSSA
.. |security| image:: https://www.bestpractices.dev/projects/8143/badge
:target: https://www.bestpractices.dev/projects/8143
:alt: Open Source Security Foundation
.. |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.
.. |build| image:: https://github.com/ludwiglierhammer/index_calculator/actions/workflows/ci.yml/badge.svg
:target: https://github.com/ludwiglierhammer/index_calculator/actions/workflows/ci.yml
:alt: Build Status
.. |coveralls| image:: https://codecov.io/gh/ludwiglierhammer/index_calculator/branch/master/graph/badge.svg
:target: https://codecov.io/gh/ludwiglierhammer/index_calculator
:alt: Coveralls
.. |zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.7762679.svg
:target: https://doi.org/10.5281/zenodo.7762679
:alt: DOI
Raw data
{
"_id": null,
"home_page": null,
"name": "index-calculator",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "index_calculator",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/e1/ef/c230aee61d1eff35c9b1f6d9730cf730fdd5a1fad2f36b466f5710caef9e/index_calculator-0.12.0.tar.gz",
"platform": null,
"description": "============================================================================================\nCalculate climate indicators with standardized project-specific attributes: index_calculator\n============================================================================================\n\n+----------------------------+-----------------------------------------------------+\n| Versions | |pypi| |versions| |\n+----------------------------+-----------------------------------------------------+\n| Documentation and Support | |docs| |\n+----------------------------+-----------------------------------------------------+\n| Open Source | |license| |zenodo| |\n+----------------------------+-----------------------------------------------------+\n| Coding Standards | |black| |ruff| |pre-commit| |security| |fossa| |\n+----------------------------+-----------------------------------------------------+\n| Development Status | |status| |build| |coveralls| |\n+----------------------------+-----------------------------------------------------+\n\nPython index_calculator is an xclim wrapper to calculate climate indicators from CMORized netCDF files.\n\nDocumentation\n-------------\nThe official documentation is at https://index-calculator.readthedocs.io/\n\nFeatures\n--------\n* Calculate climate indices via xclim_.\n* Write standardized netCDF attributes.\n* Write on disk with a project-specific output file name.\n\nAvailable projects\n------------------\nYou can calculate climate indicators using index_calculator with the projects listed in the table below.\n\n+--------------------+--------------+\n| CMIP | CMIP5, CMIP6 |\n+--------------------+--------------+\n| CORDEX | CORDEX |\n+--------------------+--------------+\n| Observational data | E-OBS, HYRAS |\n+--------------------+--------------+\n| Reanalysis data | ERA5 |\n+--------------------+--------------+\n\nInstallation\n------------\n\nYou can install the package directly with pip:\n\n.. code-block:: console\n\n pip install index_calculator\n\nIf you want to contribute, we recommend cloning the repository, setup a conda environmant and installing the package in development mode, e.g.\n\n.. code-block:: console\n\n git clone https://github.com/ludwiglierhammer/index_calculator\n cd index_calculator\n conda env create -f ci/requirements/environment.yml\n conda activate xcalc-tests\n pip install -e . --no-deps\n\nThis will install the package but you can still edit it and you don't need the package in your :code:`PYTHONPATH`\n\n\nRequirements\n------------\n\n* python3.6 or higher\n\n* xclim\n\n* numpy\n\n* pandas\n\n* xarray\n\n* cf_xarray\n\n* cftime\n\nCredits\n-------\n\nThis package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.\n\n.. _xclim: https://xclim.readthedocs.io/en/latest/\n\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage\n\n.. |pypi| image:: https://img.shields.io/pypi/v/index_calculator.svg\n :target: https://pypi.python.org/pypi/index_calculator\n :alt: Python Package Index Build\n\n.. |docs| image:: https://readthedocs.org/projects/index_calculator/badge/?version=latest\n :target: https://index-calculator.readthedocs.io/en/latest/?version=latest\n :alt: Documentation Status\n\n.. |versions| image:: https://img.shields.io/pypi/pyversions/index_calculator.svg\n :target: https://pypi.python.org/pypi/index_calculator\n :alt: Supported Python Versions\n\n.. |license| image:: https://img.shields.io/github/license/ludwiglierhammer/index_calculator.svg\n :target: https://github.com/ludwiglierhammer/index_calculator/blob/master/LICENSE\n :alt: License\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.. |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.. |pre-commit| image:: https://results.pre-commit.ci/badge/github/climate-service-center/index_calculator/main.svg\n :target: https://results.pre-commit.ci/latest/github/climate-service-center/index_calculator/main\n :alt: pre-commit.ci status\n\n.. |fossa| image:: https://app.fossa.com/api/projects/git%2Bgithub.com%2Fludwiglierhammer%2Findex_calculator.svg?type=shield\n :target: https://app.fossa.com/projects/git%2Bgithub.com%2Fludwiglierhammer%2Findex_calculator?ref=badge_shield\n :alt: FOSSA\n\n.. |security| image:: https://www.bestpractices.dev/projects/8143/badge\n :target: https://www.bestpractices.dev/projects/8143\n :alt: Open Source Security Foundation\n\n.. |status| image:: https://www.repostatus.org/badges/latest/active.svg\n :target: https://www.repostatus.org/#active\n :alt: Project Status: Active \u2013 The project has reached a stable, usable state and is being actively developed.\n\n.. |build| image:: https://github.com/ludwiglierhammer/index_calculator/actions/workflows/ci.yml/badge.svg\n :target: https://github.com/ludwiglierhammer/index_calculator/actions/workflows/ci.yml\n :alt: Build Status\n\n.. |coveralls| image:: https://codecov.io/gh/ludwiglierhammer/index_calculator/branch/master/graph/badge.svg\n\t :target: https://codecov.io/gh/ludwiglierhammer/index_calculator\n\t :alt: Coveralls\n\n.. |zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.7762679.svg\n :target: https://doi.org/10.5281/zenodo.7762679\n :alt: DOI\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2022, Ludwig Lierhammer 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": "Python index-calculator is an xclim wrapper",
"version": "0.12.0",
"project_urls": {
"changelog": "https://index-calculator.readthedocs.io/en/latest/history.html",
"documentation": "https://index-calculator.readthedocs.io",
"homepage": "https://index-calculator.readthedocs.io",
"repository": "https://github.com/ludwiglierhammer/index_calculator.git"
},
"split_keywords": [
"index_calculator"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "58304d8d1b5602863212882186bc7eb32dd987dcd5629e99ce23acc27f5e1fb6",
"md5": "06d492183d88a746ef10f61a62bf7d35",
"sha256": "c35e65ac081f77955f5f4261922980df5f615c62771c6239662cd607798ce933"
},
"downloads": -1,
"filename": "index_calculator-0.12.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "06d492183d88a746ef10f61a62bf7d35",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 33009,
"upload_time": "2024-07-16T10:39:11",
"upload_time_iso_8601": "2024-07-16T10:39:11.258903Z",
"url": "https://files.pythonhosted.org/packages/58/30/4d8d1b5602863212882186bc7eb32dd987dcd5629e99ce23acc27f5e1fb6/index_calculator-0.12.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e1efc230aee61d1eff35c9b1f6d9730cf730fdd5a1fad2f36b466f5710caef9e",
"md5": "16b0a40aed801469cccd529078ca6715",
"sha256": "44dd3770b2005f0207d7220a499abcfd9b5c2a3bfb9c3af61adecdcb079d1595"
},
"downloads": -1,
"filename": "index_calculator-0.12.0.tar.gz",
"has_sig": false,
"md5_digest": "16b0a40aed801469cccd529078ca6715",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 1001128,
"upload_time": "2024-07-16T10:39:13",
"upload_time_iso_8601": "2024-07-16T10:39:13.036876Z",
"url": "https://files.pythonhosted.org/packages/e1/ef/c230aee61d1eff35c9b1f6d9730cf730fdd5a1fad2f36b466f5710caef9e/index_calculator-0.12.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-16 10:39:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ludwiglierhammer",
"github_project": "index_calculator",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"lcname": "index-calculator"
}
