Skip to content

Commit 3183945

Browse files
authored
Misc MyST updates (#533)
* Update How to Use section * Update Binder references * Move image and update nb template * Fix logo in template
1 parent 03fc396 commit 3183945

File tree

6 files changed

+78
-83
lines changed

6 files changed

+78
-83
lines changed

appendix/template.ipynb

Lines changed: 61 additions & 67 deletions
Large diffs are not rendered by default.

foundations/jupyterlab.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -612,7 +612,7 @@
612612
"name": "python",
613613
"nbconvert_exporter": "python",
614614
"pygments_lexer": "ipython3",
615-
"version": "3.10.8"
615+
"version": "3.10.12"
616616
}
617617
},
618618
"nbformat": 4,

foundations/quickstart.ipynb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@
2727
"\n",
2828
"Of course you can simply read through these examples, but it's more fun to ***run them yourself***:\n",
2929
"\n",
30-
"- Find the **\"Rocket Ship\"** icon, **located near the top-right of this page**. Hover over this icon to see the drop-down menu.\n",
31-
"- Click the `Binder` link from the drop-down menu.\n",
30+
"- Find the **\"Rocket Ship\"** icon, **located near the top-right of this page**. Click on it to open a text box.\n",
31+
"- Enter the Pythia Binder link `https://binder.projectpythia.org/`, and click **Launch**.\n",
3232
"- This page will open up as a [Jupyter notebook](jupyter.html) in a working Python environment in the cloud.\n",
3333
"- Press <kbd>Shift</kbd>+<kbd>Enter</kbd> to execute each code cell\n",
3434
"- Feel free to make changes and play around!"
@@ -645,7 +645,7 @@
645645
"name": "python",
646646
"nbconvert_exporter": "python",
647647
"pygments_lexer": "ipython3",
648-
"version": "3.10.4"
648+
"version": "3.10.12"
649649
}
650650
},
651651
"nbformat": 4,

images/binder-highlight.png

58.5 KB
Loading

images/foundations_diagram.png

-1.42 MB
Loading

preamble/how-to-use.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# How to Use This Book
22

3-
![Foundations Infographic](../images/ProjectPythia_Foundations_Infographic_v4.jpg)
4-
53
## Overview
64

75
Pythia Foundations is a geoscience-flavored introduction to essential tools in the Scientific Python Ecosystem (SPE) and [Pangeo](https://pangeo.io) stack. It covers the foundational knowledge that's needed to get started with Python in the computational geosciences, as well as to become an effective citizen-practitioner in key open geoscience software ecosystems. The intended audience is anyone from undergraduate students through established geoscientists who are relatively new to working in Python. The tutorials in this book also serve as references and prerequisites for the more advanced and domain-specific content in the [Pythia Cookbook Gallery](https://cookbooks.projectpythia.org).
@@ -17,7 +15,7 @@ aspiring scientists, working in any number of disciplines. Pythia
1715
Foundations makes very few assumptions about the experience level
1816
of the reader other than having a background in math or science,
1917
and being comfortable using a computer, including the command line
20-
terminal (i.e. the [Unix shell](https://en.wikipedia.org/wiki/Unix_shell)).
18+
terminal (i.e., the [Unix shell](https://en.wikipedia.org/wiki/Unix_shell)).
2119
Prior programming experience is not required.
2220

2321
Lastly, in addition to the Python language and a number of fundamental
@@ -32,7 +30,7 @@ results.
3230
## Organization of Pythia Foundations
3331

3432
Pythia Foundations is organized into two main sections as seen in
35-
the sidebar on the left: Foundational Skills, and Core Scientific
33+
the sidebar on the left and the schematic below: Foundational Skills, and Core Scientific
3634
Python Packages. The first, Foundational Skills, covers essential
3735
material that all users of Project Pythia are expected to feel
3836
comfortable with in order to make the most of the rest of the Project
@@ -42,6 +40,8 @@ in the Scientific Python Ecosystem. These packages serve as the
4240
building blocks for many of the more geoscience focused components
4341
of the Scientific Python Ecosystem.
4442

43+
![Foundations Infographic](../images/ProjectPythia_Foundations_Infographic_v4.jpg)
44+
4545
## Running Pythia Foundations examples
4646

4747
All of the content in Pythia Foundations is authored in Markdown
@@ -63,6 +63,8 @@ observe instantly how results change.
6363
There are two ways that you can execute the Pythia Foundations book
6464
chapters. Both are described below.
6565

66+
![Annotated Pythia Foundations home page](../images/foundations_diagram.png)
67+
6668
### Interacting with Jupyter Notebooks in the cloud via Binder
6769

6870
The simplest way to interact with a Jupyter Notebook is through
@@ -71,8 +73,9 @@ Jupyter Notebook in the cloud. The details of how this works are not
7173
important for now. All you need to know is how to launch a Pythia
7274
Foundations book chapter via Binder. Simply navigate your mouse to
7375
the top right corner of the book chapter you are viewing and click
74-
on the rocket ship icon, (see figure below), and be sure to select
75-
“Launch Binder”. After a moment you should be presented with a
76+
on the rocket ship icon (see the screenshot above), and a text box will appear.
77+
Type or paste the Pythia Binder link (`https://binder.projectpythia.org`) and click "Launch".
78+
After a moment you should be presented with a
7679
notebook that you can interact with. You’ll be able to execute code
7780
and even change the example programs. At first the code cells
7881
have no output, until you execute them by pressing
@@ -83,11 +86,11 @@ Jupyter](https://foundations.projectpythia.org/foundations/getting-started-jupyt
8386
### Interacting with Jupyter Books locally
8487

8588
Sometimes it may make more sense to download a book chapter and run
86-
it on your local laptop or PC. Perhaps you want to co-opt a book
89+
it on your local laptop or PC. Perhaps you want to co-opt a notebook
8790
for your own purposes, or load your own local data. Downloading an
8891
individual chapter is trivial: click on the download icon, also
8992
located in the top right corner of the book chapter you are viewing,
90-
and select “.ipynb”.
93+
and click on the filename that appears.
9194

9295
That was the easy part. Getting the notebook to execute locally may
9396
take a little more work. The book was created to run in a particular
@@ -128,11 +131,9 @@ A local Jupyter Notebook server should open in your web browser.
128131
Simply open the .ipynb file using the Notebook server’s file browser
129132
and you are good to go. If you want to work with many Pythia Foundations
130133
notebooks, you might want to “clone the site”
131-
and download all of the notebooks. First click on the Pythia
132-
Foundations GitHub icon (see figure below) and select repository.
134+
and download all of the notebooks. First, click on the GitHub icon (see the screenshot above)
135+
to open the Pythia Foundations GitHub repository.
133136
Then follow the instructions in our Getting Started with GitHub
134137
[guide](https://foundations.projectpythia.org/foundations/getting-started-github.html#)
135138
for cloning a repository. The steps used above for configuring your
136139
Conda environment should work for this method as well.
137-
138-
![Annotated Pythia Foundations home page](../images/foundations_diagram.png)

0 commit comments

Comments
 (0)