View your Jupyter Book

Before you deliver your work for review by ECMWF staff, it’s worth doing a quick self-check. You can either build the book locally on your computer, or use GitHub to build and host it for you.

Prerequisites¶

• Set up your Jupyter Book

Option 1: View locally¶

Create a conda/mamba environment for building Jupyter Books:

conda create -y -n jupyter-build -c conda-forge python=3.12
conda activate jupyter-build
conda install jupyter-book

With your jupyter-build environment activated, run:

jupyter book clean  # confirm with "Yes" if prompted
jupyter book start

This will start a server that renders your book as a locally-served website. By default, it will be available at http://localhost:3000/. Open this URL in your web browser to inspect the rendered book.

Option 2: View via GitHub pages¶

Go to the “Settings” tab, then navigate to “Pages” on the left-hand menu pane. In the “Build and deployment” section set the source to “GitHub Actions” from the dropdown menu.

To get the link to the rendered Jupyter Book (GitHub pages), go to the “Actions” tab. You will see that the “Initial commit” action failed, this was because the pages were not enabled. You can then click the “Re-run all jobs” buttons in the top right to re-run the actions. This time it should succeed and provide a link to your GitHub pages in the flow diagram.