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: portal/cookbook-guide.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,7 @@ These instructions assume that your goal is to contribute a new Cookbook to the
22
22
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.
23
23
```
24
24
25
-
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".
25
+
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#forking-workflow), then take a look at the section below on "Pull Requests and previews".
26
26
27
27
## A. Data access and storage considerations for Cookbooks
28
28
@@ -50,7 +50,7 @@ For many concepts, we encourage writing self-contained functions to generate sim
50
50
51
51
## B. Create a Repository From the Cookbook Template
52
52
53
-
1. If you don't already have a GitHub account, create one by following the [Getting Started with GitHub guide](https://foundations.projectpythia.org/foundations/getting-started-github.html).
53
+
1. If you don't already have a GitHub account, create one by following the [Getting Started with GitHub guide](https://foundations.projectpythia.org/foundations/getting-started-github).
54
54
1. On the [Cookbook Template repository](https://github.com/ProjectPythia/cookbook-template), click "Use this template → Create a new repository".
55
55
1. Choose "Include all branches".
56
56
1. Give your repository a descriptive name followed by `-cookbook` (e.g., `hydrology-cookbook`, `hpc-cookbook`, `cesm-cookbook`) and a description.
@@ -61,20 +61,20 @@ For many concepts, we encourage writing self-contained functions to generate sim
61
61
<imgwidth="901"alt="Screenshot 2023-01-13 at 3 12 47 PM"src="https://user-images.githubusercontent.com/26660300/212428991-cd0ae2f0-73ca-40d8-b983-f122359463aa.png">
62
62
63
63
```{note}
64
-
In the rest of this guide, we assume that you are familiar with the basics of using git and GitHub. If not, we strongly recommend reading through our [GitHub tutorials in Foundations](https://foundations.projectpythia.org/foundations/getting-started-github.html).
64
+
In the rest of this guide, we assume that you are familiar with the basics of using git and GitHub. If not, we strongly recommend reading through our [GitHub tutorials in Foundations](https://foundations.projectpythia.org/foundations/getting-started-github.
65
65
```
66
66
67
67
Your cookbook is now ready to have content added!
68
68
69
69
70
70
## C. Set up the Computational Environment
71
71
72
-
You'll most likely want to do your edits in a [local clone of the repository](https://foundations.projectpythia.org/foundations/github/github-cloning-forking.html) on your laptop or wherever your are running your notebooks.
72
+
You'll most likely want to do your edits in a [local clone of the repository](https://foundations.projectpythia.org/foundations/github/github-cloning-forking) on your laptop or wherever your are running your notebooks.
73
73
74
74
### Customizing Your Conda Environment
75
75
76
76
1. Within `environment.yml` (in the root of the repository), change `name` from `cookbook-dev` to `<your-cookbook-name>-dev` (e.g. `cesm-cookbook-dev`) and add all required libraries and other dependencies under `dependencies:`. Commit the changes.
77
-
1. Create the [conda environment](https://foundations.projectpythia.org/foundations/conda.html) with `conda env create -f environment.yml`. If it crashes, try running `conda config --set channel_priority strict`
77
+
1. Create the [conda environment](https://foundations.projectpythia.org/foundations/conda) with `conda env create -f environment.yml`. If it crashes, try running `conda config --set channel_priority strict`
78
78
1. Activate your environment with `conda activate <env-name>`
79
79
80
80
You're now ready to create and run awesome notebooks.
@@ -188,7 +188,7 @@ Also, _don't worry about breaking anything!_ Your repo will not affect any other
188
188
1. Select or type "ProjectPythia", confirm, and transfer.
189
189
1. When prompted about which teams to give access to, select "core". _This will enable the Pythia maintenance team to have full access to your repository._
190
190
191
-
Once you have successfully transferred the repository, you'll most likely want to make a [personal fork and a local clone of the repository](https://foundations.projectpythia.org/foundations/github/github-cloning-forking.html) so that you can continue to develop and collaborate on the Cookbook via the [forking workflow](https://foundations.projectpythia.org/foundations/github/github-workflows.html#forking-workflow).
191
+
Once you have successfully transferred the repository, you'll most likely want to make a [personal fork and a local clone of the repository](https://foundations.projectpythia.org/foundations/github/github-cloning-forking) so that you can continue to develop and collaborate on the Cookbook via the [forking workflow](https://foundations.projectpythia.org/foundations/github/github-workflows#forking-workflow).
192
192
193
193
194
194
## G. Deploying your Cookbook
@@ -226,11 +226,11 @@ It's possible to enable the workflows on your personal fork, but usually unneces
226
226
227
227
### Pull Requests and previews
228
228
229
-
Collaboration on Cookbooks is best done via [Pull Requests](https://foundations.projectpythia.org/foundations/github/github-pull-request.html). 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.
229
+
Collaboration on Cookbooks is best done via [Pull Requests](https://foundations.projectpythia.org/foundations/github/github-pull-request). 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.
230
230
231
231
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.
232
232
233
-
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.
233
+
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#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.
234
234
235
235
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._
Copy file name to clipboardExpand all lines: portal/cookbook-tasklist.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,8 +8,8 @@ Once we've marked this entire checklist, [click here to open an issue on Project
8
8
9
9
---
10
10
11
-
- [ ] **Confirm you’ve followed the entire Project Pythia [Cookbook Guide](https://projectpythia.org/cookbook-guide.html)**.
12
-
Take note especially of the [Develop your cookbook](https://projectpythia.org/cookbook-guide.html#develop-your-cookbook), [Authorship and the CITATION.cff file](https://projectpythia.org/cookbook-guide.html#authorship-and-the-citation-cff-file), and [Gallery tags](https://projectpythia.org/cookbook-guide.html#gallery-tags) sections. **Save the [Generate a DOI](https://projectpythia.org/cookbook-guide.html#generate-a-doi) step as the last step of this checklist.**
11
+
- [ ] **Confirm you’ve followed the entire Project Pythia [Cookbook Guide](https://projectpythia.org/cookbook-guide)**.
12
+
Take note especially of the [Develop your cookbook](https://projectpythia.org/cookbook-guide/#d-develop-your-cookbook), [Authorship and the CITATION.cff file](https://projectpythia.org/cookbook-guide/#e-making-your-cookbook-findable-and-citable), and [Gallery tags](https://projectpythia.org/cookbook-guide/#id-2-tag-your-cookbook) sections. **Save the [Generate a DOI](https://projectpythia.org/cookbook-guide#generate-a-doi) step as the last step of this checklist.**
13
13
- [ ] **Confirm that the individual notebooks within your Cookbook adhere to the [notebook template](https://github.com/ProjectPythia/cookbook-template/blob/main/notebooks/notebook-template.ipynb)**.
14
14
If the template does not fit your Cookbook’s needs, that’s fine too! Simply let us know here in this issue.
15
15
- [ ] **Finalize your Cookbook repository name.**
@@ -42,7 +42,7 @@ This can be seen in individual Pull Requests as green checkmarks ✅ for importa
42
42
- [ ] **Identify a Maintainer team via GitHub handle(s) in this thread.**
43
43
This can be one or more people with availability to check in on this Cookbook, issue fixes to broken content, or with a vision for the future development of the Cookbook. This is typically (but not necessarily) one of the primary authors of the Cookbook.
44
44
- [ ] **Link your Cookbook repo to Zenodo for DOI generation**
45
-
Follow steps 1-4 under [Generate a DOI](https://projectpythia.org/cookbook-guide.html#generate-a-doi) in the Cookbook Guide. Return here for instructions on step 5, and your final step:
45
+
Follow steps 1-4 under [Generate a DOI](https://projectpythia.org/cookbook-guide/#id-1-credit-yourself) in the Cookbook Guide. Return here for instructions on step 5, and your final step:
46
46
- [ ] **Release your Cookbook!**
47
47
- On the right-hand sidebar for your Cookbook repository, click “Create a new release”. If you don’t see this button, you may need to click on the “Releases” header first and “Create” or “Draft” a new release.
Copy file name to clipboardExpand all lines: portal/posts/2025/new-cookbooks.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -204,4 +204,4 @@ This Cookbook covers how to work with wavelets in Python. Wavelets are a powerfu
204
204
205
205
Do you have some feedback or ideaa for a new Cookbook project? Unsure how to get started? We'd love to hear from you at any of our [open meetings](https://projectpythia.org/#monthly-pythia-meetings), through the [Pangeo Discourse](https://discourse.pangeo.io/c/education/project-pythia/), or via any of our social media. Join us at our next Cook-off 2025!
206
206
207
-
Take a look at our [guide for Cookbook contributors](https://projectpythia.org/cookbook-guide.html).
207
+
Take a look at our [guide for Cookbook contributors](https://projectpythia.org/cookbook-guide).
0 commit comments