Fix README links and update structure #1101
Open
+17
−14
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
Author
|
@chahank could you please have a look? |
peanutfun
commented
Nov 7, 2025
| For new users, we recommend to begin with Core (1) and the [tutorials](https://github.com/CLIMADA-project/climada_python/tree/main/doc/user-guide) therein. | ||
|
|
||
| This is the Python version of CLIMADA - please see [here](https://github.com/davidnbresch/climada) for backward compatibility with the MATLAB version. | ||
| A [publication repository](https://github.com/CLIMADA-project/climada_papers) contains scientific, peer-reviewed articles that explain software components implemented in CLIMADA. |
Member
Author
There was a problem hiding this comment.
Based on feedback from the CLIMADA Days:
Suggested change
| A [publication repository](https://github.com/CLIMADA-project/climada_papers) contains scientific, peer-reviewed articles that explain software components implemented in CLIMADA. | |
| A [publication repository](https://github.com/CLIMADA-project/climada_papers) contains code and data used in CLIMADA case-studies for scientific, peer-reviewed articles. |
Member
There was a problem hiding this comment.
hmmm I am not sure what feedback this is referring too. Maybe the one saying that it is hard to find examples of CLIMADA applications? In this case I would formulate it differently. Maybe?
Suggested change
| A [publication repository](https://github.com/CLIMADA-project/climada_papers) contains scientific, peer-reviewed articles that explain software components implemented in CLIMADA. | |
| A [repository](https://github.com/CLIMADA-project/climada_papers) contains case-study examples most of them in the form of scientific, peer-reviewed articles that further explain software components implemented in CLIMADA. |
Otherwise I feel it is even more innaccessible to practitionners that are looking for examples, not scientific studies per se.
Member
Author
Thinking about this, it might make sense to merge into |
chahank
reviewed
Nov 7, 2025
|
|
||
| 1. the core [climada_python](https://github.com/CLIMADA-project/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](https://github.com/CLIMADA-project/climada_python/blob/main/doc/tutorial/climada_util_api_client.ipynb). [Litpop](https://github.com/CLIMADA-project/climada_python/blob/main/doc/tutorial/climada_entity_LitPop.ipynb) is included as demo Exposures module, and [Tropical cyclones](https://github.com/CLIMADA-project/climada_python/blob/main/doc/tutorial/climada_hazard_TropCyclone.ipynb) is included as a demo Hazard module. | ||
| 2. the petals [climada_petals](https://github.com/CLIMADA-project/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. | ||
| 1. [Core (`climada_python`)](https://github.com/CLIMADA-project/climada_python) contains all the modules necessary for computing probabilistic impact, averted damage, and uncertainty, sensitivity analysis and impact function calibration. Data for hazard, exposures and impact functions can be obtained from the [data API](https://github.com/CLIMADA-project/climada_python/blob/main/doc/user-guide/climada_util_api_client.ipynb). [Litpop](https://github.com/CLIMADA-project/climada_python/blob/main/doc/user-guide/climada_entity_LitPop.ipynb) is included as demo Exposures module, and [Tropical cyclones](https://github.com/CLIMADA-project/climada_python/blob/main/doc/user-guide/climada_hazard_TropCyclone.ipynb) is included as a demo Hazard module. |
Member
There was a problem hiding this comment.
Suggested change
| 1. [Core (`climada_python`)](https://github.com/CLIMADA-project/climada_python) contains all the modules necessary for computing probabilistic impact, averted damage, and uncertainty, sensitivity analysis and impact function calibration. Data for hazard, exposures and impact functions can be obtained from the [data API](https://github.com/CLIMADA-project/climada_python/blob/main/doc/user-guide/climada_util_api_client.ipynb). [Litpop](https://github.com/CLIMADA-project/climada_python/blob/main/doc/user-guide/climada_entity_LitPop.ipynb) is included as demo Exposures module, and [Tropical cyclones](https://github.com/CLIMADA-project/climada_python/blob/main/doc/user-guide/climada_hazard_TropCyclone.ipynb) is included as a demo Hazard module. | |
| 1. [Core (`climada_python`)](https://github.com/CLIMADA-project/climada_python) contains all the modules necessary for computing probabilistic impact, averted damage, and peform uncertainty, sensitivity analysis and impact function calibration. Demonstration data for hazard, exposures and impact functions can be obtained from the [data API](https://github.com/CLIMADA-project/climada_python/blob/main/doc/user-guide/climada_util_api_client.ipynb). [Litpop](https://github.com/CLIMADA-project/climada_python/blob/main/doc/user-guide/climada_entity_LitPop.ipynb) is included as demo Exposures module, and [Tropical cyclones](https://github.com/CLIMADA-project/climada_python/blob/main/doc/user-guide/climada_hazard_TropCyclone.ipynb) is included as a demo Hazard module. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes proposed in this PR:
NOTE: Merging into
developis okay. Broken links inmainare fixed by redirects on ReadTheDocs.PR Author Checklist
develop)PR Reviewer Checklist