Set up your Jupyter Book

This guide walks you through the minimum setup to create your own Jupyter Book based from this ECMWF Jupyter Book template.

Clone the repository¶

To clone this template repository and create your own Jupyter Book project, follow these steps:

1. Open the template repository on GitHub.

2. Click Use this template (green button, top-right).

3. Choose a repository name and owner.

Update myst.yml¶

Update the project metadata to reflect your project details. In particular, update the github and thebe.binder.repo fields with your repository name:

project:
  title: <book title>  # replace <book title> with your project title
  # ...
  github: ecmwf-training/<your-repo-name>  # replace with your repository name
  # ...
  thebe:
    binder:
      repo: ecmwf-training/<your-repo-name>  # replace with your repository name (same as above)

Choose branding (optional)¶

By default, the template uses Copernicus Climate Change Service (C3S) branding. You can easily switch to ECMWF or Copernicus Atmosphere Monitoring Service (CAMS) branding instead:

1. Open the myst.yml file in the root of your Jupyter Book repository.

2. Change the extends line to select the desired branding configuration:

extends:
  - branding/ecmwf.yml

extends:
  - branding/c3s.yml

extends:
  - branding/cams.yml

That is all that is required.

Next steps¶

• Remove the example content and start adding your own pages and notebooks, following the best practices.

• Before submitting your work for ECMWF review, review your Jupyter Book yourself by following the quality assurance guidelines.

That’s it! You’re now ready to start drafting your book.