You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _preview/435/_sources/cookbook-guide.md
+6-2Lines changed: 6 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -16,6 +16,8 @@ These instructions assume that your goal is to contribute a new Cookbook to the
16
16
Using the Pythia Cookbook template to create reproducible documents housed elsewhere is definitely possible! But we don't focus on that use case in this guide.
17
17
```
18
18
19
+
If you're not looking to create a _new_ Cookbook, but rather looking for guidance on contributing to _existing_ Cookbooks, first make sure you're comfortable with the [GitHub forking workflow](https://foundations.projectpythia.org/foundations/github/github-workflows.html#forking-workflow), then take a look at the section below on "Pull Requests and previews".
20
+
19
21
## Data access
20
22
21
23
Before developing your cookbook, you should consider how it will access the data you plan to use. In loose order of preference, we recommend the following:
@@ -167,7 +169,7 @@ The link to your published book will then be displayed on the home page of the r
167
169
```{Note}
168
170
If you have transfered your repository to the ProjectPythia organization and also made a personal fork, the publishing pipeline automation will _only run on the upstream fork on the ProjectPythia organization_ so there's only one copy of the "published" book.
169
171
170
-
It's possible to enable the workflows on your personal fork, but usually unneccesary if you preview your work via Pull Requests (see below).
172
+
It's possible to enable the workflows on your personal fork, but usually unneccesary if you preview your work via Pull Requests (see next section)!
171
173
```
172
174
173
175
### Pull Requests and previews
@@ -176,9 +178,11 @@ Collaboration on Cookbooks is best done via [Pull Requests](https://foundations.
176
178
177
179
The only difference between the "preview" pipeline and the regular publishing pipeline is the URL to which the rendered website is deployed. A temporary preview location is used, leaving the main book untouched until the PR is merged.
178
180
181
+
To propose changes to a Cookbook, or even just to test something out temporarily, follow the [forking workflow](https://foundations.projectpythia.org/foundations/github/github-workflows.html#forking-workflow): make changes on a feature branch of your personal fork, and open a Pull Request from that branch to the main branch of the upstream fork. This will trigger the preview.
182
+
179
183
A link to the preview will appear as a comment on the Pull Request once the publishing actions are complete. _If the link shows up but you get a 404 error when you click on it the first time, just wait a few minutes! There are some lags before the preview is fully deployed._
180
184
181
-
Every new push to the PR branch will trigger another rebuild, and an updated preview. The preview will be deleted if and when the PR is closed or merged.
185
+
Not satisfied? Keep making changes! Every new push to the feature branch on your personal fork will trigger another rebuild, and an updated preview. The preview will be deleted if and when the PR is closed or merged.
<ahref="https://youtu.be/kstc-6uz7AQ"class="text-decoration-none"><h4class="display-4 p-0">Python Tutorial Seminar Series - Numpy</h4></a>
1752
-
<pclass="card-subtitle"><strong>Author:</strong> Project Pythia, A Kootz<br/><strong>Affiliation:</strong> <ahref="https://ncar.ucar.edu/">NCAR</a></p>
1752
+
<pclass="card-subtitle"><strong>Author:</strong> A Kootz, Project Pythia<br/><strong>Affiliation:</strong> <ahref="https://ncar.ucar.edu/">NCAR</a></p>
1753
1753
<pclass="my-2">Recording from the Python Tutorial Seminar Series introducing the Python Package `numpy`. The content to follow along with this video is hosted on this <Ahref="https://colab.research.google.com/drive/1zcjaGXofLzUXkQzJKnANE9Z3yFUt0q7E?">Numpy Google Collab</A>.
1754
1754
</p>
1755
1755
</div>
@@ -1774,7 +1774,7 @@ Xarray is inspired by and borrows heavily from pandas, the popular data analysis
<pclass="my-2">Recording from the Python Tutorial Seminar Series introducing the Python Package `matplotlib`. The content to follow along with this video is hosted on this <Ahref="https://github.com/anissa111/matplotlib-tutorial">Matplotlib Tutorial GitHub Repository</A>.
1779
1779
</p>
1780
1780
</div>
@@ -1800,7 +1800,7 @@ Xarray is inspired by and borrows heavily from pandas, the popular data analysis
<ahref="https://youtu.be/GEFnL8C62u8"class="text-decoration-none"><h4class="display-4 p-0">Python Tutorial Seminar Series - Object Oriented Programming</h4></a>
1803
-
<pclass="card-subtitle"><strong>Author:</strong> Project Pythia, A Kootz<br/><strong>Affiliation:</strong> <ahref="https://ncar.ucar.edu/">NCAR</a></p>
1803
+
<pclass="card-subtitle"><strong>Author:</strong> A Kootz, Project Pythia<br/><strong>Affiliation:</strong> <ahref="https://ncar.ucar.edu/">NCAR</a></p>
1804
1804
<pclass="my-2">Recording from the Python Tutorial Seminar Series introducing Object Oriented Programming. The content to follow along with this video is hosted in this <Ahref="https://github.com/pilotchute/oop_hrrr_tutorial">Object Oriented Programming Tutorial GitHub Repository</A>.
1805
1805
</p>
1806
1806
</div>
@@ -1851,7 +1851,7 @@ Xarray is inspired by and borrows heavily from pandas, the popular data analysis
<ahref="https://youtu.be/fYkPn0Nttlg"class="text-decoration-none"><h4class="display-4 p-0">Python Tutorial Seminar Series - Git and GitHub</h4></a>
1854
-
<pclass="card-subtitle"><strong>Author:</strong> Project Pythia, Kevin Paul<br/><strong>Affiliation:</strong> <ahref="https://ncar.ucar.edu/">NCAR</a></p>
1854
+
<pclass="card-subtitle"><strong>Author:</strong> Kevin Paul, Project Pythia<br/><strong>Affiliation:</strong> <ahref="https://ncar.ucar.edu/">NCAR</a></p>
1855
1855
<pclass="my-2">Recording from the Python Tutorial Seminar Series introducing the tools Git and GitHub. The content to follow along with this tutorial is hosted in this <Ahref="https://github.com/NCAR/git-github-demo">Git and GitHub Demo GitHub Repository</A>.
1856
1856
</p>
1857
1857
</div>
@@ -1876,7 +1876,7 @@ Xarray is inspired by and borrows heavily from pandas, the popular data analysis
<ahref="https://youtu.be/BsV3ek7qsiM"class="text-decoration-none"><h4class="display-4 p-0">Python Tutorial Seminar Series - Pandas</h4></a>
1879
-
<pclass="card-subtitle"><strong>Author:</strong> Project Pythia, Max Grover, Drew Camron<br/><strong>Affiliation:</strong> <ahref="https://ncar.ucar.edu/">NCAR</a></p>
1879
+
<pclass="card-subtitle"><strong>Author:</strong> Drew Camron, Project Pythia, Max Grover<br/><strong>Affiliation:</strong> <ahref="https://ncar.ucar.edu/">NCAR</a></p>
1880
1880
<pclass="my-2">Recording from the Python Tutorial Seminar Series introducing the Python Package `pandas`. The content to follow along with this video is hosted in this <Ahref="https://github.com/mgrover1/ncar_pandas_tutorial">Pandas Tutorial GitHub Repository</A>.
1881
1881
</p>
1882
1882
</div>
@@ -2001,7 +2001,7 @@ Xarray is inspired by and borrows heavily from pandas, the popular data analysis
<ahref="https://youtu.be/It231le1fAU"class="text-decoration-none"><h4class="display-4 p-0">Python Tutorial Seminar Series - Plotting with GeoCAT</h4></a>
<pclass="my-2">Recording from the Python Tutorial Seminar Series introducing advanced plotting techniques and highlighting tools developed by GeoCAT. The content to follow along with this video is hosted in this <Ahref="https://github.com/anissa111/plotting-with-geocat-tutorial">Plotting with GeoCat GitHub Repository</A>.
2006
2006
</p>
2007
2007
</div>
@@ -2027,7 +2027,7 @@ Xarray is inspired by and borrows heavily from pandas, the popular data analysis
<ahref="https://www.youtube.com/watch?v=uiWDQKI8YTQ&t=6s"class="text-decoration-none"><h4class="display-4 p-0">Python Tutorial Seminar Series - GeoCAT-Comp</h4></a>
2030
-
<pclass="card-subtitle"><strong>Author:</strong> Project Pythia, A Kootz<br/><strong>Affiliation:</strong> <ahref="https://ncar.ucar.edu/">NCAR</a></p>
2030
+
<pclass="card-subtitle"><strong>Author:</strong> A Kootz, Project Pythia<br/><strong>Affiliation:</strong> <ahref="https://ncar.ucar.edu/">NCAR</a></p>
2031
2031
<pclass="my-2">Recording from the Python Tutorial Seminar Series introducing `geocat-comp`. The content to follow along with this video is hosted in this <Ahref="https://github.com/pilotchute/geocat_comp_tutorial">GeoCat-Comp GitHub Repository</A>.
<p>These instructions assume that your goal is to contribute a new Cookbook to the community-maintained collection housed on the <aclass="reference external" href="https://cookbooks.projectpythia.org">Pythia Cookbook Gallery</a>.</p>
406
406
<p>Using the Pythia Cookbook template to create reproducible documents housed elsewhere is definitely possible! But we don’t focus on that use case in this guide.</p>
407
407
</div>
408
+
<p>If you’re not looking to create a <em>new</em> Cookbook, but rather looking for guidance on contributing to <em>existing</em> Cookbooks, first make sure you’re comfortable with the <aclass="reference external" href="https://foundations.projectpythia.org/foundations/github/github-workflows.html#forking-workflow">GitHub forking workflow</a>, then take a look at the section below on “Pull Requests and previews”.</p>
408
409
<sectionid="data-access">
409
410
<h2>Data access<aclass="headerlink" href="#data-access" title="Link to this heading"><iclass="fas fa-link"></i></a></h2>
410
411
<p>Before developing your cookbook, you should consider how it will access the data you plan to use. In loose order of preference, we recommend the following:</p>
@@ -560,15 +561,16 @@ <h3>Where is my book?<a class="headerlink" href="#where-is-my-book" title="Link
560
561
<divclass="admonition note">
561
562
<pclass="admonition-title">Note</p>
562
563
<p>If you have transfered your repository to the ProjectPythia organization and also made a personal fork, the publishing pipeline automation will <em>only run on the upstream fork on the ProjectPythia organization</em> so there’s only one copy of the “published” book.</p>
563
-
<p>It’s possible to enable the workflows on your personal fork, but usually unneccesary if you preview your work via Pull Requests (see below).</p>
564
+
<p>It’s possible to enable the workflows on your personal fork, but usually unneccesary if you preview your work via Pull Requests (see next section)!</p>
564
565
</div>
565
566
</section>
566
567
<sectionid="pull-requests-and-previews">
567
568
<h3>Pull Requests and previews<aclass="headerlink" href="#pull-requests-and-previews" title="Link to this heading"><iclass="fas fa-link"></i></a></h3>
568
569
<p>Collaboration on Cookbooks is best done via <aclass="reference external" href="https://foundations.projectpythia.org/foundations/github/github-pull-request.html">Pull Requests</a>. Every PR on a Cookbook repository will trigger a “Preview” version of our publishing pipeline. The entire book is re-built from the updated source and the preview site is hosted at a temporary online location. This way, the team can safely see what the end product will look like after the PR is merged.</p>
569
570
<p>The only difference between the “preview” pipeline and the regular publishing pipeline is the URL to which the rendered website is deployed. A temporary preview location is used, leaving the main book untouched until the PR is merged.</p>
571
+
<p>To propose changes to a Cookbook, or even just to test something out temporarily, follow the <aclass="reference external" href="https://foundations.projectpythia.org/foundations/github/github-workflows.html#forking-workflow">forking workflow</a>: make changes on a feature branch of your personal fork, and open a Pull Request from that branch to the main branch of the upstream fork. This will trigger the preview.</p>
570
572
<p>A link to the preview will appear as a comment on the Pull Request once the publishing actions are complete. <em>If the link shows up but you get a 404 error when you click on it the first time, just wait a few minutes! There are some lags before the preview is fully deployed.</em></p>
571
-
<p>Every new push to the PR branch will trigger another rebuild, and an updated preview. The preview will be deleted if and when the PR is closed or merged.</p>
573
+
<p>Not satisfied? Keep making changes! Every new push to the feature branch on your personal fork will trigger another rebuild, and an updated preview. The preview will be deleted if and when the PR is closed or merged.</p>
572
574
</section>
573
575
<sectionid="building-on-the-pythia-binder">
574
576
<h3>Building on the Pythia Binder<aclass="headerlink" href="#building-on-the-pythia-binder" title="Link to this heading"><iclass="fas fa-link"></i></a></h3>
0 commit comments