Quick Guide to Contributing a New Cookbook

This document is designed be lightweight. For more detailed, step-by-step instuctions, see the Full Guide for Cookbook Guide

Contributing a New Cookbook →

Create Repository Using Template¶

1. Navigate to projectpythia/cookbook-template

2. Click “Use This Template” → “Create a new repository”

On the next page:¶

• Check “Include all branches”

• You are the owner

• Create your repository name (should end with -cookbook)

• Select to keep it Public

• Then click “Create repository”

Update Content¶

Follow Git/GitHub best practices with your collaborators:

• Add content with your scientific insight as .ipynb files in the notebooks/ folder

• Update environment.yml to include all necessary packages

• Update your thumbnail to visually represent your work

• Update README.md to reflect:

  • Title

  • Description

  • Motivation

  • Authors

  • Content structure

• Update myst.yml with:

  • Title

  • GitHub link

  • Table of contents (toc)

  • Jupyter → Binder → Repo links

• Update CITATION.cff with:

  • Authors’ names, ORCID, website, and affiliation

  • Title

  • Abstract

• Update _gallery_info.yml with:

  • “packages” and “domains” tags

  • the correct filepath for your thumbnail

Ready to Publish?¶

1. Make sure you’re added to the ProjectPythia organization

2. From repository settings, transfer the repo to the ProjectPythia organization

3. Open a PR editing cookbook_gallery.txt with your repo name in the Cookbook Gallery Repository

4. Await review

5. Someone from the Pythia team will publish a citable release