Climate Risk Assessment Book
If you'd like to develop and/or build this Climate Risk Assesment book, you should:
git clone git@github.com:CLIMAAX/crabook.git
crabook/
directory that was created by git in the previous step
cd crabook
conda create -n crabook python=3.11 pip
conda activate crabook
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.
jupyter-book clean crabook/
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.
The Python/Conda environment is needed only for building the book, so you can activate it after editing the files.
crabook/
directory
cd crabook/crabook
conda activate crabook
jupyter-book clean crabook/
jupyter-book build crabook/
_build
directory has been added to .gitignore
, so when you build the book and add files in git, they will not end up on GitHub.data
, as that is also set up in .gitignore
and not pushed to the repo._toc.yml
file too, otherwise they will not be added to the book.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.
We are using powerful MyST Markdown flavour of Markdown which is very convenient for technical and scientific documentation.
We welcome and recognize all contributions. You can see a list of current contributors in the contributors tab.
This project is created using the excellent open source Jupyter Book project and the executablebooks/cookiecutter-jupyter-book template.