Climate Risk Assessment Book

Guides you through your regional Climate Risk Assessments and provides you with tools and datasets for the assessment.
https://github.com/climaax/crabook

Category: Sustainable Development
Sub Category: Education

Keywords from Contributors

measurements sanitation control training featured feature-flag feature-toggle

Last synced: about 2 hours ago
JSON representation

Repository metadata

Repository for Climate Risk Assessment Book

README.md

Climate Risk Assessment Handbook

The Handbook is published at https://handbook.climaax.eu

Development

Building the book

For the first time

If you'd like to develop and/or build this Climate Risk Assesment book, you should:

  1. Clone this repository
     git clone [email protected]:CLIMAAX/crabook.git
    
  2. Go to the the crabook/ directory that was created by git in the previous step
    cd crabook
    
  3. Create a Python or Conda virtual environment (example for Conda)
     conda create -n crabook python=3.11 pip
    
  4. Activate the environment
    conda activate crabook
    
  5. Install the libraries, choose:
    pip install -r requirements.txt
    
    installs only the packages required to build the book, while
    pip install -r requirements-dev.txt
    
    additionally installs packages for the development of some components of the book, but which are not required during building.
  6. Find the markdown files and edit what you need.
  7. Remove any existing builds by running
    jupyter-book clean crabook/
    
  8. Finally build the book
    jupyter-book build crabook/
    

A fully-rendered HTML version of the book will be built in crabook/_build/html/.

Open the file crabook/_build/html/intro.html and navigate to the material you changed to check if everything is as expected.

Once you're happy with the changes, create a new branch, commit your changes and send us a pull request if you'd like to contribute.

Every next time

The Python/Conda environment is needed only for building the book, so you can activate it after editing the files.

  1. Edit the book's source files located in the crabook/ directory
    cd crabook/crabook
    
  2. Activate the environment
     conda activate crabook
    
  3. Remove any existing builds by running
    jupyter-book clean crabook/
    
  4. Finally build the book
    jupyter-book build crabook/
    

Table of contents switching

TLDR: To have a page show up in our production version of the CRA book, it has to be added to crabook/_toc_prod.yml.

The build process on GitHub in .github/workflows/build-deploy-book.yml contains a step to detect the repository it is started from. If this repository is CLIMAAX/crabook, the default table of contents crabook/_toc.yml is replaced by the file crabook/_toc_prod.yml. This enables us to hide pages in the production repository that are still under development in our test repository without having to edit the table of contents file back-and-forth every time changes are pushed to production.

Contributors

We welcome and recognize all contributions. You can see a list of current contributors in the contributors tab.

Credits

This project is created using the excellent open source Jupyter Book project and the executablebooks/cookiecutter-jupyter-book template.

License

Apache-2.0 OR CC-BY-4.0

The CLIMAAX CRA Handbook is available under both the Apache License 2.0 or the Creative Commons Attribution 4.0 International license.


Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 11 days ago

Total Commits: 581
Total Committers: 13
Avg Commits per committer: 44.692
Development Distribution Score (DDS): 0.441

Commits in past year: 398
Committers in past year: 13
Avg Commits per committer in past year: 30.615
Development Distribution Score (DDS) in past year: 0.183

Name Email Commits
Christopher Polster c****r@e****t 325
Milana Vuckovic m****c@e****t 125
bachmannatiiasa 1****a 72
svranic s****c@g****r 23
Lena Reimann 8****n 13
TedBuskop b****p@h****m 7
n-aleksandrova n****a@d****l 5
MaurizioMazzoleni 4****i 3
Fredrik Wetterhall n****w@a****x 3
Erika R. Melendez 2
spolade 3****e 1
MartinKAJO 1****O 1
Dr. Cesar Guzman c****n@t****e 1

Committer domains:


Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 6
Total pull requests: 9
Average time to close issues: 17 days
Average time to close pull requests: 10 days
Total issue authors: 5
Total pull request authors: 6
Average comments per issue: 1.5
Average comments per pull request: 0.44
Merged pull request: 6
Bot issues: 0
Bot pull requests: 0

Past year issues: 3
Past year pull requests: 7
Past year average time to close issues: 4 days
Past year average time to close pull requests: 12 days
Past year issue authors: 2
Past year pull request authors: 4
Past year average comments per issue: 1.67
Past year average comments per pull request: 0.57
Past year merged pull request: 5
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/climaax/crabook

Top Issue Authors

  • Clemens-XXX (2)
  • nefw (1)
  • Ankur7292 (1)
  • carls31 (1)
  • cguz (1)

Top Pull Request Authors

  • chpolste (3)
  • MaurizioMazzoleni (2)
  • milanavuckovic (1)
  • lena-reimann (1)
  • n-aleksandrova (1)
  • cguz (1)

Top Issue Labels

Top Pull Request Labels


Package metadata

proxy.golang.org: github.com/climaax/crabook

  • Homepage:
  • Documentation: https://pkg.go.dev/github.com/climaax/crabook#section-documentation
  • Licenses: apache-2.0
  • Latest release: v2024.12.0+incompatible (published 6 months ago)
  • Last Synced: 2025-06-06T10:37:31.060Z (1 day ago)
  • Versions: 6
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Rankings:
    • Dependent packages count: 5.401%
    • Average: 5.583%
    • Dependent repos count: 5.764%
proxy.golang.org: github.com/CLIMAAX/crabook

  • Homepage:
  • Documentation: https://pkg.go.dev/github.com/CLIMAAX/crabook#section-documentation
  • Licenses: apache-2.0
  • Latest release: v2024.12.0+incompatible (published 6 months ago)
  • Last Synced: 2025-06-06T10:37:31.063Z (1 day ago)
  • Versions: 6
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Rankings:
    • Dependent packages count: 5.401%
    • Average: 5.583%
    • Dependent repos count: 5.764%

Score: -Infinity