Objective: demonstrate minimum working example for compiling analysis and diagnostics associated with a CESM case.
- Build conda environment for computations:
conda env create -f environment.yml
or
mamba env create -f environment.yml
- Edit the configuration file: Specify the case information in _config-calc.yml.
- Run the notebooks: Open and run the _run.ipynb notebook. The notebooks will be run and the computed notebooks save in the
output_dir
, which is specified in _config-calc.yml. This is the directory from which the Jupyter Book is built. - Build the book: Edit and run the build-and-publish.sh script.
- Add your notebook to the
compute_notebooks
andbook_toc
lists in _config-calc.yml. Markdown and ipynb files that are in thebook_toc
, but not thecompute_notebooks
list are automatically copied into theoutput_dir
.
This project is created using the excellent open source Jupyter Book project and the executablebooks/cookiecutter-jupyter-book template.