From a995da6cf68bcf463ce983f00e0d7c23e862a46a Mon Sep 17 00:00:00 2001 From: Brian Rose Date: Mon, 4 Aug 2025 09:26:06 -0400 Subject: [PATCH 1/3] Update Binder instructions --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 9e6f746d1..1b75d5f61 100644 --- a/README.md +++ b/README.md @@ -38,24 +38,24 @@ This Project Pythia Cookbook covers ... (replace `...` with the main subject of ## Running the Notebooks -You can either run the notebook using [Binder](https://binder.projectpythia.org/) or on your local machine. +You can either run the notebooks in the Cookbook using [Binder](https://binder.projectpythia.org/) or on your local machine. ### Running on Binder The simplest way to interact with a Jupyter Notebook is through -[Binder](https://binder.projectpythia.org/), which enables the execution of a -[Jupyter Book](https://jupyterbook.org) in the cloud. The details of how this works are not -important for now. All you need to know is how to launch a Pythia -Cookbooks chapter via Binder. Simply navigate your mouse to +[Binder](https://binder.projectpythia.org/), which enables "one click" +execution in the cloud. Simply navigate your mouse to the top right corner of the book chapter you are viewing and click -on the rocket ship icon, (see figure below), and be sure to select -“launch Binder”. After a moment you should be presented with a -notebook that you can interact with. I.e. you’ll be able to execute -and even change the example programs. You’ll see that the code cells -have no output at first, until you execute them by pressing +on the rocket ship icon (see screenshots [here](https://foundations.projectpythia.org/preamble/how-to-use/#running-pythia-foundations-examples)), +and a text box will appear. Type or paste the Pythia Binder link +(`https://binder.projectpythia.org`) and click "Launch". +After a few moments you should be presented with a +notebook that you can interact with. You’ll be able to execute code +and even change the example programs. At first the code cells +have no output, until you execute them by pressing {kbd}`Shift`\+{kbd}`Enter`. Complete details on how to interact with -a live Jupyter notebook are described in [Getting Started with -Jupyter](https://foundations.projectpythia.org/foundations/getting-started-jupyter.html). +a live Jupyter notebook are described in the Pythia Foundations chapter [Getting Started with +Jupyter](https://foundations.projectpythia.org/foundations/getting-started-jupyter). Note, not all Cookbook chapters are executable. If you do not see the rocket ship icon, such as on this page, you are not viewing an From 2340f00fc19f6c68b976668bd12f5047b46ddf51 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Mon, 4 Aug 2025 13:27:07 +0000 Subject: [PATCH 2/3] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1b75d5f61..90357455a 100644 --- a/README.md +++ b/README.md @@ -43,11 +43,11 @@ You can either run the notebooks in the Cookbook using [Binder](https://binder.p ### Running on Binder The simplest way to interact with a Jupyter Notebook is through -[Binder](https://binder.projectpythia.org/), which enables "one click" +[Binder](https://binder.projectpythia.org/), which enables "one click" execution in the cloud. Simply navigate your mouse to the top right corner of the book chapter you are viewing and click -on the rocket ship icon (see screenshots [here](https://foundations.projectpythia.org/preamble/how-to-use/#running-pythia-foundations-examples)), -and a text box will appear. Type or paste the Pythia Binder link +on the rocket ship icon (see screenshots [here](https://foundations.projectpythia.org/preamble/how-to-use/#running-pythia-foundations-examples)), +and a text box will appear. Type or paste the Pythia Binder link (`https://binder.projectpythia.org`) and click "Launch". After a few moments you should be presented with a notebook that you can interact with. You’ll be able to execute code From d4824e28e09cf6d1bf989260e401aa5d85b44de0 Mon Sep 17 00:00:00 2001 From: Brian Rose Date: Mon, 4 Aug 2025 09:36:23 -0400 Subject: [PATCH 3/3] Add url field for Pythia binder --- myst.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/myst.yml b/myst.yml index 372ef34a9..f3dfc70b0 100644 --- a/myst.yml +++ b/myst.yml @@ -18,4 +18,5 @@ project: - file: notebooks/notebook-template.ipynb jupyter: binder: + url: https://binder.projectpythia.org repo: projectpythia/cookbook-template