Welcome to this tutorial (in development)
- If you have maintainer privileges, you can skip this step, otherwise make a fork of this repository.
- Clone the repository (or fork) and create a new branch with
git checkout -b github-username/feature-description - Create a compatible working environment, for instance by building the project docker-image.
docker build -t local_docker_file -f docker/Dockerfile .
docker run -ti -v $(pwd):/root/shared -w /root/shared --name=tutorialmpi local_docker_fileYou can also use conda to build your environment
conda env update --file environment.yml --name name-of-your-env- Create an
.ipynbin the notebooks folder, or modify the existing notebooks. If a new notebook has been created, add it to the appropriate section of _toc.yml. - Make sure the webpage builds correctly by calling
jupyter book build -W .from the root of the repository. You can inspect the webpage locally by opening _build/html/index.html with the web-browser of your choice. - Make a pull-request to the main branch of this repo.
- Make sure that the workflow Build documentation passes.