Skip to main content

ibicus provides a flexible and user-friendly toolkit for the bias correction of climate models and associated evaluation.

Project description

pypi_release pypi_status PyPI license pypi_downloads docs PyPI pyversions made-with-python made-with-sphinx-doc Maintenance yes Ask Me Anything ! GitHub contributors

ibicus provides a flexible and user-friendly toolkit for the bias correction of climate models and associated evaluation.

ibicus implements a variety of methods for bias correction (8 currently) published in peer-reviewed literature, including ISIMIP (Lange 2019) and CDFt (Michelangeli et al. 2009) and provides a unified interface for their usage. The package enables the user to modify and refine their behavior with settings and parameters, and provides an evaluation framework to assess marginal, temporal, spatial, and multivariate properties of the bias corrected climate model.

Given future climate model data to debias (cm_future), climate model data during a reference period (cm_hist) and observational or reanalysis data during the same reference period (obs) running a debiaser is as easy as:

>>> from ibicus import CDFt
>>> debiaser = CDFt.from_variable("pr")
>>> debiased_cm_future = debiaser.apply(obs, cm_hist, cm_future)

Evaluating dry spell length can be as easy as:

>>> from ibicus.evaluate.metrics import dry_days
>>> spell_length = dry_days.calculate_spell_length(minimum_length: 4, obs = obs, raw = cm_future, ISIMIP = debiased_cm_future)

For more information on the usage have a look at our docs.

Install

ibicus releases are available via PyPI. Just write:

pip install ibicus

For more information about installation and requirements see the install documentation in the docs.

How to cite

If you are using the package, please consider citing:

Spuler, F. R., Wessel, J. B., Comyn-Platt, E., Varndell, J., and Cagnazzo, C.: ibicus: a new open-source Python package and comprehensive interface for statistical bias adjustment and evaluation in climate modelling (v1.0.1), Geosci. Model Dev., 17, 1249–1269, https://doi.org/10.5194/gmd-17-1249-2024, 2024.

Contact

If you have feedback on the package, suggestions for additions, questions you’d like to ask or would like to contribute, please contact us under ibicus.py@gmail.com. Similarly should you encounter bugs or issues using the package please open an issue. or write to us using the email adress above.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ibicus-1.2.0.tar.gz (100.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ibicus-1.2.0-py3-none-any.whl (132.7 kB view details)

Uploaded Python 3

File details

Details for the file ibicus-1.2.0.tar.gz.

File metadata

  • Download URL: ibicus-1.2.0.tar.gz
  • Upload date:
  • Size: 100.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for ibicus-1.2.0.tar.gz
Algorithm Hash digest
SHA256 80621dd3d8978a0b37379581b319eaa4b94b537a539c04cd4bb0aa8433a6ed1f
MD5 dc990ffecff208853c97c55b777ce3bb
BLAKE2b-256 ed6634fce549256ea1743b81e60674cc1d9ebb0ae182ad1382634f6fa125e0b0

See more details on using hashes here.

File details

Details for the file ibicus-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: ibicus-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 132.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for ibicus-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 446cc5f320ca9013797fcacba58a3c0482e85524556d221802d7d5ab8a6004fd
MD5 52c2fb792fcc2c8c66e4fb7b09d6f44f
BLAKE2b-256 d221dcf30bfdcb5b8fc3d8b5286b3a5c6b9d7fda02bec2588999bfc72aa7fc65

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page