V-V-report

This is the repo of the FESTIM V&V report built with Jupyter-book.

Build locally

First clone the repository:

git clone https://github.com/festim-dev/V-V-report

Create the correct conda environment with the required dependencies:

conda env create -f environment.yml
conda activate vv-festim-report-env

You can then build the book with:

jupyter-book build report

To force the rebuild of all pages:

jupyter-book build report --all

Contributing

Run jupytext --sync on a case's markdown file to generate a matching Jupyter notebook. Run jupytext --sync again to sync the changes to the markdown file.

See this page for more instructions.