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.3.0.tar.gz (101.2 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.3.0-py3-none-any.whl (133.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ibicus-1.3.0.tar.gz
Algorithm Hash digest
SHA256 6ca88bc9b3bf36a66141149a2d7ad25b85f252af0c23fc7e895ce31e30d019af
MD5 8ae9b236ab610d78cf31d27272d02f03
BLAKE2b-256 654084f6bfdc71716d4f066656be1cde1a715fc2c7d370d44886c057f5612881

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for ibicus-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 30df4c2e1fd32d4b5c8182763def3844a3c9bf3b8f978d8fca53e514f9793077
MD5 48be184cc3548ea2f88d513c8a5f05af
BLAKE2b-256 ebf5259c4b4781f1b90c6f696076ee00e1cbb617d61320b1aa99b5178fdb3303

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