A Module for Calibrating Impact Functions in the Climate Risk Modeling Platform CLIMADA

A Module for Calibrating Impact Functions in the Climate Risk Modeling Platform CLIMADA - Published in JOSS (2024)

https://github.com/climada-project/climada_python

Science Score: 98.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 1 DOI reference(s) in JOSS metadata
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
    32 of 70 committers (45.7%) from academic institutions
  • Institutional organization owner
    Organization climada-project has institutional domain (www.wcr.ethz.ch)
  • JOSS paper metadata
    Published in Journal of Open Source Software

Scientific Fields

Political Science Social Sciences - 90% confidence
Mathematics Computer Science - 84% confidence
Artificial Intelligence and Machine Learning Computer Science - 83% confidence
Last synced: 4 months ago · JSON representation

Repository

CLIMADA is a free and open-source software framework for climate risk assessment and adaptation option appraisal.

Basic Info
  • Host: GitHub
  • Owner: CLIMADA-project
  • License: gpl-3.0
  • Language: Jupyter Notebook
  • Default Branch: main
  • Homepage: https://climada.ethz.ch
  • Size: 206 MB
Statistics
  • Stars: 384
  • Watchers: 21
  • Forks: 138
  • Open Issues: 86
  • Releases: 38
Created about 8 years ago · Last pushed 4 months ago
Metadata Files
Readme Changelog Contributing License Codeowners Authors Zenodo

README.md

DOI Build Status Documentation build status

CLIMADA

CLIMADA (CLIMate ADAptation) is a free and open-source software framework for climate risk assessment and adaptation option appraisal. Designed by a large scientific community, it helps reasearchers, policymakers, and businesses analyse the impacts of natural hazards and explore adaptation strategies.

As of today, CLIMADA provides global coverage of major climate-related extreme-weather hazards at high resolution (4x4km) via a data API For select hazards, historic and probabilistic events sets, for past, present and future climate exist at distinct time horizons. You will find a repository containing scientific peer-reviewed articles that explain software components implemented in CLIMADA here.

CLIMADA is divided into two parts (two repositories):

  1. the core climada_python contains all the modules necessary for the probabilistic impact, the averted damage, uncertainty and forecast calculations. Data for hazard, exposures and impact functions can be obtained from the data API. Litpop is included as demo Exposures module, and Tropical cyclones is included as a demo Hazard module.
  2. the petals climada_petals contains all the modules for generating data (e.g., TC_Surge, WildFire, OpenStreeMap, ...). Most development is done here. The petals builds-upon the core and does not work as a stand-alone.

It is recommend for new users to begin with the core (1) and the tutorials therein.

This is the Python (3.9+) version of CLIMADA - please see here for backward compatibility with the MATLAB version.

Getting started

CLIMADA runs on Windows, macOS and Linux. The released versions of CLIMADA are available from conda-forge. Use the Mamba package manager to install it:

shell mamba install -c conda-forge climada

It is highly recommended to install CLIMADA into a separate Conda environment. See the installation guide for further information.

Follow the tutorials in a Jupyter Notebook to see what can be done with CLIMADA and how.

Documentation

The online documentation is available on Read the Docs.The documentation of each release version of CLIMADA can be accessed separately through the drop-down menu at the bottom of the left sidebar. Additionally, the version 'stable' refers to the most recent release (installed via conda), and 'latest' refers to the latest unstable development version (the develop branch).

CLIMADA python:

CLIMADA petals:

The documentation can also be built locally.

Citing CLIMADA

See the Citation Guide.

Please use the following logo if you are presenting results obtained with or through CLIMADA:

https://github.com/CLIMADA-project/climada_python/blob/main/doc/guide/img/CLIMADA_logo_QR.png

Contributing

We welcome any contribution to this repository, be it bugfixes and other code changes and additions, documentation improvements, or tutorial updates.

If you would like to contribute, please refer to our Contribution Guide.

Versioning

We use SemVer for versioning. For the versions available, see the releases on this repository.

License

Copyright (C) 2017 ETH Zurich, CLIMADA contributors listed in AUTHORS.

CLIMADA is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License Version 3, 29 June 2007 as published by the Free Software Foundation, https://www.gnu.org/licenses/gpl-3.0.html

CLIMADA is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details: https://www.gnu.org/licenses/gpl-3.0.html

Owner

  • Name: Weather and Climate Risks Group
  • Login: CLIMADA-project
  • Kind: organization
  • Location: Zurich, Switzerland

Research group at ETH Zurich

JOSS Publication

A Module for Calibrating Impact Functions in the Climate Risk Modeling Platform CLIMADA
Published
July 26, 2024
Volume 9, Issue 99, Page 6755
Authors
Lukas Riedel ORCID
Institute for Environmental Decisions, ETH Zürich, Zürich, Switzerland, Federal Office of Meteorology and Climatology MeteoSwiss, Zürich-Airport, Switzerland
Chahan M. Kropf ORCID
Institute for Environmental Decisions, ETH Zürich, Zürich, Switzerland, Federal Office of Meteorology and Climatology MeteoSwiss, Zürich-Airport, Switzerland
Timo Schmid ORCID
Institute for Environmental Decisions, ETH Zürich, Zürich, Switzerland, Federal Office of Meteorology and Climatology MeteoSwiss, Zürich-Airport, Switzerland
Editor
Hauke Schulz ORCID
Tags
climate risk impact function vulnerability optimization

GitHub Events

Total
  • Create event: 51
  • Release event: 2
  • Issues event: 85
  • Watch event: 54
  • Delete event: 46
  • Member event: 3
  • Issue comment event: 378
  • Push event: 492
  • Pull request review comment event: 305
  • Pull request review event: 293
  • Pull request event: 104
  • Fork event: 23
Last Year
  • Create event: 51
  • Release event: 2
  • Issues event: 85
  • Watch event: 54
  • Delete event: 46
  • Member event: 3
  • Issue comment event: 378
  • Push event: 492
  • Pull request review comment event: 305
  • Pull request review event: 293
  • Pull request event: 104
  • Fork event: 23

Committers

Last synced: 4 months ago

All Time
  • Total Commits: 4,043
  • Total Committers: 70
  • Avg Commits per committer: 57.757
  • Development Distribution Score (DDS): 0.742
Past Year
  • Commits: 314
  • Committers: 22
  • Avg Commits per committer: 14.273
  • Development Distribution Score (DDS): 0.701
Top Committers
Name Email Commits
gabriela g****n@g****m 1,042
emanuel-schmid s****e@e****h 473
Thomas Vogt t****t@p****e 289
sameberenz s****i@p****e 270
Carmen Steinmann c****t@s****h 207
schmide e****d@i****h 198
sameberenz 173
ThomasRoosli T****i 105
Valentin Gebhart v****t@u****h 94
Yue Yu 7****y 91
Jan Hartman 2****e 90
samluethi 4****i 90
Evelyn-M e****m@s****h 89
Chahan M. Kropf c****f@u****h 82
ingajsa i****r@p****e 73
Lukas Riedel 3****n 62
Benoît Guillod b****d@c****m 53
Nicolas Colombi 1****i 47
zeliest 4****t 47
aleciu 2****u 46
Gabriela Aznar a****g@w****l 46
luseverin l****o@u****h 45
David N. Bresch d****h@g****m 44
Chris Fairless c****s@h****m 28
Chahan Kropf c****f@p****m 25
timschmi95 t****i@s****h 24
manniepmkam m****m@g****m 20
climada t****a@g****m 17
Sam Luethi s****i@g****h 17
Samuel Juhel 1****l 14
and 40 more...

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 434
  • Total pull requests: 718
  • Average time to close issues: 5 months
  • Average time to close pull requests: 23 days
  • Total issue authors: 102
  • Total pull request authors: 42
  • Average comments per issue: 3.8
  • Average comments per pull request: 2.99
  • Merged pull requests: 573
  • Bot issues: 0
  • Bot pull requests: 1
Past Year
  • Issues: 64
  • Pull requests: 125
  • Average time to close issues: 27 days
  • Average time to close pull requests: 27 days
  • Issue authors: 27
  • Pull request authors: 15
  • Average comments per issue: 1.88
  • Average comments per pull request: 2.71
  • Merged pull requests: 74
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • emanuel-schmid (78)
  • peanutfun (57)
  • chahank (22)
  • bguillod (21)
  • frqqyy (17)
  • spjuhel (14)
  • ChrisFairless (14)
  • tovogt (13)
  • aleeciu (12)
  • ThomasRoosli (11)
  • Evelyn-M (10)
  • simonameiler (8)
  • sameberenz (7)
  • ValentinGebhart (6)
  • manniepmkam (6)
Pull Request Authors
  • emanuel-schmid (127)
  • peanutfun (89)
  • chahank (75)
  • tovogt (71)
  • frqqyy (62)
  • NicolasColombi (30)
  • ChrisFairless (30)
  • ValentinGebhart (26)
  • spjuhel (21)
  • sameberenz (20)
  • zeliest (18)
  • luseverin (18)
  • ThomasRoosli (17)
  • Evelyn-M (13)
  • aleeciu (12)
Top Labels
Issue Labels
bug (99) dependencies (50) enhancement (49) help wanted (31) question (29) user-friendliness (29) warnings (23) accepting pull request (18) feature request (17) incident (13) conventions (12) documentation (11) workforce needed (10) task (10) awaiting feedback (9) blocker (8) fixed (8) performance (6) external resources (3) good first issue (3) Code update (3) storm_europe (2) Data API (2) duplicate (1) working group (1) bugfix (1) wontfix (1) installation (1)
Pull Request Labels
enhancement (22) dependencies (7) conventions (7) documentation (6) bug (6) new module (6) Code update (6) awaiting feedback (4) user-friendliness (4) good first issue (4) bugfix (3) fixed (2) performance (2) warnings (2) incident (1) invalid (1) feature request (1) help wanted (1)

Packages

  • Total packages: 4
  • Total downloads:
    • pypi 742 last-month
  • Total dependent packages: 1
    (may contain duplicates)
  • Total dependent repositories: 1
    (may contain duplicates)
  • Total versions: 105
  • Total maintainers: 1
proxy.golang.org: github.com/CLIMADA-project/climada_python
  • Versions: 39
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 7.0%
Average: 8.2%
Dependent repos count: 9.3%
Last synced: 4 months ago
proxy.golang.org: github.com/climada-project/climada_python
  • Versions: 39
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 7.0%
Average: 8.2%
Dependent repos count: 9.3%
Last synced: 4 months ago
pypi.org: climada

CLIMADA in Python

  • Versions: 17
  • Dependent Packages: 1
  • Dependent Repositories: 1
  • Downloads: 587 Last month
Rankings
Forks count: 4.2%
Stargazers count: 4.2%
Dependent packages count: 7.3%
Downloads: 8.9%
Average: 9.3%
Dependent repos count: 22.1%
Maintainers (1)
Last synced: 4 months ago
pypi.org: climada-petals

CLIMADA Extensions in Python

  • Versions: 10
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 155 Last month
Rankings
Stargazers count: 4.3%
Forks count: 4.5%
Dependent packages count: 7.5%
Downloads: 15.7%
Average: 20.3%
Dependent repos count: 69.8%
Maintainers (1)
Last synced: 4 months ago

Dependencies

setup.py pypi
  • bottleneck *
  • cartopy *
  • cfgrib *
  • contextily *
  • dask *
  • deprecation *
  • geopandas *
  • h5py *
  • haversine *
  • matplotlib *
  • netcdf4 *
  • numba *
  • overpy *
  • pandas *
  • pandas-datareader *
  • pathos *
  • peewee *
  • pillow *
  • pint *
  • pybufrkit *
  • pycountry *
  • rasterio *
  • salib *
  • scikit-learn *
  • statsmodels *
  • tables *
  • tabulate *
  • tqdm *
  • xarray *
  • xlrd *
  • xlsxwriter *
  • xmlrunner *
.github/workflows/make-release.yml actions
  • actions/checkout master composite
.github/workflows/postrelease-setup-devbranch.yml actions
  • actions/checkout master composite
.github/workflows/python-publish.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
  • pypa/gh-action-pypi-publish 27b31702a0e7fc50959f5ad993c78deac1bdfc29 composite