Data

Tools

Indexes

Applications

Experiments

Open Source Science

ibicus

Flexible and user-friendly toolkit for the bias correction of climate models and associated evaluation.

https://github.com/ecmwf-projects/ibicus

Science Score: 39.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 2 DOI reference(s) in README
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.0%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

Flexible and user-friendly toolkit for the bias correction of climate models and associated evaluation.

Basic Info
Statistics
  • Stars: 65
  • Watchers: 5
  • Forks: 13
  • Open Issues: 3
  • Releases: 10
Created about 4 years ago · Last pushed 10 months ago
Metadata Files
Readme License

README.rst 

******
ibicus
******

|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, 12491269, 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.


.. |pypi_release| image:: https://img.shields.io/pypi/v/ibicus?color=green
    :target: https://pypi.org/project/ibicus

.. |pypi_status| image:: https://img.shields.io/pypi/status/ibicus
    :target: https://pypi.org/project/ibicus

.. |pypi_downloads| image:: https://img.shields.io/pypi/dm/ibicus
  :target: https://pypi.org/project/ibicus

.. |docs| image:: https://readthedocs.org/projects/ibicus/badge/?version=latest
  :target: https://ibicus.readthedocs.io/en/latest/?badge=latest

.. |Maintenance yes| image:: https://img.shields.io/badge/Maintained%3F-yes-green.svg
   :target: https://github.com/ecmwf-projects/ibicus/graphs/commit-activity

.. |Website ibicus| image:: https://img.shields.io/website-up-down-green-red/http/monip.org.svg
   :target: https://readthedocs.org/

.. |Ask Me Anything !| image:: https://img.shields.io/badge/Ask%20me-anything-1abc9c.svg
   :target: mailto:ibicus.py@gmail.com

.. |made-with-python| image:: https://img.shields.io/badge/Made%20with-Python-1f425f.svg
   :target: https://www.python.org/

.. |made-with-sphinx-doc| image:: https://img.shields.io/badge/Made%20with-Sphinx-1f425f.svg
   :target: https://www.sphinx-doc.org/

.. |PyPI download month| image:: https://img.shields.io/pypi/dm/ibicus
   :target: https://pypi.org/project/ibicus/

.. |PyPI version shields.io| image:: https://img.shields.io/pypi/v/ibicus
   :target: https://pypi.org/project/ibicus/

.. |PyPI license| image:: https://img.shields.io/pypi/l/ibicus
   :target: https://pypi.org/project/ibicus/

.. |PyPI pyversions| image:: https://img.shields.io/pypi/pyversions/ibicus
   :target: https://pypi.org/project/ibicus/

.. |PyPI status| image:: https://img.shields.io/pypi/status/ibicus
   :target: https://pypi.org/project/ibicus/

.. |GitHub contributors| image:: https://img.shields.io/github/contributors/ecmwf-projects/ibicus
   :target: https://github.com/ecmwf-projects/ibicus

Owner

  • Name: ECMWF projects
  • Login: ecmwf-projects
  • Kind: organization
  • Location: United Kingdom

Projects of ECMWF for working with weather and climate data

GitHub Events

Total
  • Create event: 4
  • Release event: 2
  • Issues event: 12
  • Watch event: 14
  • Delete event: 1
  • Member event: 1
  • Issue comment event: 10
  • Push event: 15
  • Pull request event: 2
  • Fork event: 3
Last Year
  • Create event: 4
  • Release event: 2
  • Issues event: 12
  • Watch event: 14
  • Delete event: 1
  • Member event: 1
  • Issue comment event: 10
  • Push event: 15
  • Pull request event: 2
  • Fork event: 3

Committers

Last synced: 10 months ago

All Time
  • Total Commits: 484
  • Total Committers: 4
  • Avg Commits per committer: 121.0
  • Development Distribution Score (DDS): 0.116
Past Year
  • Commits: 41
  • Committers: 2
  • Avg Commits per committer: 20.5
  • Development Distribution Score (DDS): 0.024
Top Committers
Name Email Commits
jakobwes j****s@a****m 428
Fiona Spuler f****r@p****m 54
garciam g****m@p****s 1
Eddy Comyn-Platt 5****F 1
Committer Domains (Top 20 + Academic)
predictia.es: 1 aol.com: 1

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 30
  • Total pull requests: 6
  • Average time to close issues: 2 months
  • Average time to close pull requests: about 5 hours
  • Total issue authors: 7
  • Total pull request authors: 4
  • Average comments per issue: 0.53
  • Average comments per pull request: 1.0
  • Merged pull requests: 5
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 7
  • Pull requests: 2
  • Average time to close issues: about 1 month
  • Average time to close pull requests: about 12 hours
  • Issue authors: 5
  • Pull request authors: 2
  • Average comments per issue: 1.29
  • Average comments per pull request: 1.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • jakobwes (22)
  • howardvanmeer (2)
  • theshyyi (2)
  • snow73 (1)
  • TarekAMZ (1)
  • mo-DanCubbon (1)
  • JacquelineKies (1)
Pull Request Authors
  • jakobwes (3)
  • fiona511 (2)
  • garciampred (2)
  • aulemahal (2)
Top Labels
Issue Labels
enhancement (7) bug (2) help wanted (1) question (1)
Pull Request Labels

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 1,043 last-month
  • Total dependent packages: 1
    (may contain duplicates)
  • Total dependent repositories: 0
    (may contain duplicates)
  • Total versions: 23
  • Total maintainers: 3
proxy.golang.org: github.com/ecmwf-projects/ibicus
  • Versions: 9
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 10 months ago
pypi.org: ibicus

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

  • Versions: 14
  • Dependent Packages: 1
  • Dependent Repositories: 0
  • Downloads: 1,043 Last month
Rankings
Dependent packages count: 6.6%
Downloads: 14.7%
Average: 17.3%
Dependent repos count: 30.6%
Maintainers (3)
EddyCMWF fspuler511 jakobwes
Last synced: 10 months ago

Dependencies

docs/requirements.txt pypi
  • ipykernel *
  • nbsphinx *
  • numpydoc *
  • sphinx *
  • sphinx_rtd_theme *
.github/workflows/on-push.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • mamba-org/provision-with-micromamba v14 composite
  • pre-commit/action v3.0.0 composite
  • pypa/gh-action-pypi-publish release/v1 composite
Dockerfile docker
  • continuumio/miniconda3 latest build
environment.yml pypi
setup.py pypi