crabook

Climate Risk Assessment Book

Usage

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

Clone this repository

 git clone git@github.com:CLIMAAX/crabook.git

Create Python or Conda virtual environment (example for Conda)
```
 conda create -n crabook
```
Activate the environment
```
conda activate crabook
```
Install pip
```
 conda install pip
```
Go to the the crabook/ directory
```
cd crabook
```
Install the libraries
```
pip install -r requirements.txt
```
Find the markdown files and edit what you need
Go back to the crabook/ directory
Remove any existing builds by running
```
jupyter-book clean crabook/
```
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, you can push to the repo.

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

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

_build directory has been added to .gitignore, so when you build it, it will not be pushed to GitHub
If you clone the repo in this early phase and work on Jupyter notebooks, you might download some data. Please keep all data in folder named data, as that is also set up in .gitignore and not pushed to the repo
Please do not add new notebooks to this repo without them being reviewed by project partners
If you did add some markdown files or notebooks, make sure they are listed in the _toc.yml file too, otherwise they will not be added to the book

If you are unsure of what to do you can go through Jupyter Book tutorial and build an example book to practice before contributing here
Find out how to structure the book here: Structure of the book
Read about writing narrative content without the executable part in this section

We are using powerful MyST Markdown flavour of Markdown which is very convenient for technical and scientific documentation.

This book is not hosted anywhere yet and exists only when it is built locally. We will update here when it is published.

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