Pythia Foundations Contributor’s Guide

General information on how to contribute to any Project Pythia repository may be found here.

This page will eventually contain a full guide to contributing to Project Pythia. As GitHub Pull Requests are an important part of contributing to Pythia, this guide will cross-reference tutorials on GitHub and Pull Requests.

If you need to comment on anything in Pythia Foundations you feel needs work, you can use the “open issue” or “suggest edit” buttons at the top of any Pythia Foundations page. These buttons appear when you hover over the GitHub Octocat logo. Clicking on these buttons will take you to the relevant page on GitHub, where the entirety of the Pythia Foundations material is hosted. In order to actually suggest changes, you must have a free GitHub account, as listed in the GitHub section of Pythia Foundations. This contributor’s guide is strictly for Pythia Foundations; for general Project Pythia contribution guidelines, see the main Project Pythia Contributor’s Guide.

To quickly provide feedback about minor issues without the use of GitHub, you can also use this Google Form.

Contributing a new Jupyter Notebook¶

If you’d like to contribute a Jupyter Notebook to these materials, please reference our Project Pythia Notebook Template viewable on the next page. This template is available to you in appendix/template.ipynb if you’ve cloned the source repository, or available as a download directly from GitHub.

Building the site¶

Create a conda environment¶

The first time you check out this repository, run:

conda env update -f environment.yml

This will create or update the dev environment (pythia-book-dev).

Install pre-commit hooks¶

This repository includes pre-commit hooks (defined in .pre-commit-config.yaml). To activate/install these pre-commit hooks, run:

conda activate pythia-book-dev
pre-commit install

This is also a one-time step.

NOTE: The pre-commit package is already installed via the pythia-book-dev conda environment.

Building the book locally¶

To build the book locally, run the following:

conda activate pythia-book-dev
jupyter-book build .

Finally, you can view the book by opening the file _build/html/index.html with your favorite web browser. On most platforms you can simply run:

open _build/html/index.html

Keeping your dev environment up to date¶

It’s good practice to update the packages in your pythia-book-dev conda environment frequently to their latest versions, especially if it’s been a while since you used it. If the jupyter-book build . command above generates error messages, that is a good indication that your conda environment may be out of date.

To update all packages in the currently activated environment to their latest versions, do this:

conda update --all