================
index_calculator
================
.. image:: https://github.com/ludwiglierhammer/index_calculator/actions/workflows/ci.yml/badge.svg
:target: https://github.com/ludwiglierhammer/index_calculator/actions/workflows/ci.yml
.. image:: https://codecov.io/gh/ludwiglierhammer/index_calculator/branch/master/graph/badge.svg
:target: https://codecov.io/gh/ludwiglierhammer/index_calculator
.. image:: https://img.shields.io/pypi/v/index_calculator.svg
:target: https://pypi.python.org/pypi/index_calculator
.. image:: https://readthedocs.org/projects/index_calculator/badge/?version=latest
:target: https://index-calculator.readthedocs.io/en/latest/?version=latest
:alt: Documentation Status
.. image:: https://results.pre-commit.ci/badge/github/ludwiglierhammer/index_calculator/master.svg
:target: https://results.pre-commit.ci/latest/github/ludwiglierhammer/index_calculator/master
:alt: pre-commit.ci status
Python index_calculator is an xclim wrapper to calculate climate indices from CMORized netCDF files.
* Free software: MIT license
* Documentation: 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.
Installation
------------
You can install the package directly with pip:
.. code-block:: console
pip install index_calculator
If you want to contribute, I recommend cloning the repository and installing the package in development mode, e.g.
.. code-block:: console
git clone https://github.com/ludwiglierhammer/index_calculator
cd index_calculator
pip install -e .
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
* numpy
* pandas
* xarray
* xclim
Contact
-------
In cases of any problems, needs or wishes do not hesitate to contact:
ludwig.lierhammer@hereon.de
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
=======
History
=======
0.1.0 (2022-03-08)
------------------
* First release on PyPI.
0.2.0 (2022-07-07)
------------------
* documentation on readthedocs
* tests
* new cli arguments added
0.2.1 (2022-07-12)
------------------
* install data and tables via pip
0.3.0 (2022-07-19)
------------------
* new indices implemented
* CD: number of cold and dry days
* CHDYYx: Maximum number of consecutive heat days
* CSDI: Cold spell duration index
* CW: Number of cold and wet days
* DTR: Mean of daily temperature range
* GD: Number of growing degree days
* GDYYx: Number of consecutive growing degree days
* HD17: Number of heating degree days
* PRCPTOT: Total precipitation amount
* RDYYp: Number of wet days with precip over percentile
* RYYpTOT: Precipitation fraction with precip over percentile
* TG10p: Fraction of days with mean temperature under 10th percentile
* TG90p: Fraction of days with mean temperature under 90th percentile
* TX10p: Fraction of days with maximum temperature under 10th percentile
* TX90p: Fraction of days with maximum temperature under 90th percentile
* TN10p: Fraction of days with minimum temperature under 10th percentile
* TN90p: Fraction of days with minimum temperature under 90th percentile
* WD: Number of warm and dry days
* WSDI: Warm spell duration index
* WW: Number of warm and wet days
0.3.1 (2022-07-20)
------------------
* adjustments fro automatically project-specific outfile name generation
0.3.2 (2022-07-21)
------------------
* project-specific directory structure for cordex, cmip5 and cmip6
Raw data
{
"_id": null,
"home_page": "https://github.com/ludwiglierhammer/index_calculator",
"name": "index-calculator",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "index_calculator",
"author": "Ludwig Lierhammer",
"author_email": "ludwig.lierhammer@hereon.de",
"download_url": "https://files.pythonhosted.org/packages/b5/31/6375dea60b7eca7a616dd32d0b1fe7bc27e57c58c35f338b6702fadf043a/index_calculator-0.3.2.tar.gz",
"platform": null,
"description": "================\nindex_calculator\n================\n\n.. 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\n.. image:: https://codecov.io/gh/ludwiglierhammer/index_calculator/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/ludwiglierhammer/index_calculator\n\n.. image:: https://img.shields.io/pypi/v/index_calculator.svg\n :target: https://pypi.python.org/pypi/index_calculator\n\n.. 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.. image:: https://results.pre-commit.ci/badge/github/ludwiglierhammer/index_calculator/master.svg\n :target: https://results.pre-commit.ci/latest/github/ludwiglierhammer/index_calculator/master\n :alt: pre-commit.ci status\n\nPython index_calculator is an xclim wrapper to calculate climate indices from CMORized netCDF files.\n\n\n* Free software: MIT license\n* Documentation: https://index-calculator.readthedocs.io.\n\n\nFeatures\n--------\n\n* Calculate climate indices via xclim.\n* Write standardized netCDF attributes.\n* Write on disk with a project-specific output file name.\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, I recommend cloning the repository 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 pip install -e .\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* numpy\n\n* pandas\n\n* xarray\n\n* xclim\n\n\nContact\n-------\nIn cases of any problems, needs or wishes do not hesitate to contact:\n\nludwig.lierhammer@hereon.de\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\n\n=======\nHistory\n=======\n\n0.1.0 (2022-03-08)\n------------------\n\n* First release on PyPI.\n\n0.2.0 (2022-07-07)\n------------------\n\n* documentation on readthedocs\n* tests\n* new cli arguments added\n\n0.2.1 (2022-07-12)\n------------------\n\n* install data and tables via pip\n\n0.3.0 (2022-07-19)\n------------------\n\n* new indices implemented\n\n * CD: number of cold and dry days\n * CHDYYx: Maximum number of consecutive heat days\n * CSDI: Cold spell duration index\n * CW: Number of cold and wet days\n * DTR: Mean of daily temperature range\n * GD: Number of growing degree days\n * GDYYx: Number of consecutive growing degree days\n * HD17: Number of heating degree days\n * PRCPTOT: Total precipitation amount\n * RDYYp: Number of wet days with precip over percentile\n * RYYpTOT: Precipitation fraction with precip over percentile\n * TG10p: Fraction of days with mean temperature under 10th percentile\n * TG90p: Fraction of days with mean temperature under 90th percentile\n * TX10p: Fraction of days with maximum temperature under 10th percentile\n * TX90p: Fraction of days with maximum temperature under 90th percentile\n * TN10p: Fraction of days with minimum temperature under 10th percentile\n * TN90p: Fraction of days with minimum temperature under 90th percentile\n * WD: Number of warm and dry days\n * WSDI: Warm spell duration index\n * WW: Number of warm and wet days\n\n0.3.1 (2022-07-20)\n------------------\n\n* adjustments fro automatically project-specific outfile name generation\n\n0.3.2 (2022-07-21)\n------------------\n\n* project-specific directory structure for cordex, cmip5 and cmip6\n",
"bugtrack_url": null,
"license": "MIT license",
"summary": "Python index-calculator is an xclim wrapperto calculate climate indices from CMORized netCDF files.",
"version": "0.3.2",
"split_keywords": [
"index_calculator"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "caad56ee4149b3f234ceb09095467250",
"sha256": "07c75767612847470635c5f21faf737bb31596457181c19a57973724d2f43a35"
},
"downloads": -1,
"filename": "index_calculator-0.3.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "caad56ee4149b3f234ceb09095467250",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 14713252,
"upload_time": "2022-07-21T13:04:50",
"upload_time_iso_8601": "2022-07-21T13:04:50.425084Z",
"url": "https://files.pythonhosted.org/packages/ad/08/7337ddf5edb2713bca3d54049649e5736fd68fea4a5b0c9db9410ade9911/index_calculator-0.3.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "640eeed0f4f0f4fb8425d32021acde6c",
"sha256": "19ebab3aafe3a5714f6e6ae9c95759c0bc022f7dad02e55221d7ad9753fa834d"
},
"downloads": -1,
"filename": "index_calculator-0.3.2.tar.gz",
"has_sig": false,
"md5_digest": "640eeed0f4f0f4fb8425d32021acde6c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 14718693,
"upload_time": "2022-07-21T13:04:54",
"upload_time_iso_8601": "2022-07-21T13:04:54.432579Z",
"url": "https://files.pythonhosted.org/packages/b5/31/6375dea60b7eca7a616dd32d0b1fe7bc27e57c58c35f338b6702fadf043a/index_calculator-0.3.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-07-21 13:04:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "ludwiglierhammer",
"github_project": "index_calculator",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "index-calculator"
}
JSON
