2 |
3 | # (Replace_with_your_title) Cookbook
4 |
5 | [](https://github.com/ProjectPythia/cookbook-template/actions/workflows/nightly-build.yaml)
6 | [](https://binder.projectpythia.org/v2/gh/ProjectPythia/cookbook-template/main?labpath=notebooks)
7 | [](https://zenodo.org/badge/latestdoi/475509405)
8 |
9 | This Project Pythia Cookbook covers ... (replace `...` with the main subject of your cookbook ... e.g., _working with radar data in Python_)
10 |
11 | ## Motivation
12 |
13 | (Add a few sentences stating why this cookbook will be useful. What skills will you, "the chef", gain once you have reached the end of the cookbook?)
14 |
15 | ## Authors
16 |
17 | [First Author](@first-author), [Second Author](@second-author), etc. _Acknowledge primary content authors here_
18 |
19 | ### Contributors
20 |
21 |
22 |
15 |  }}){kind=logo}
19 | This material is based upon work supported by the National Science
20 | Foundation under Grant Nos. 2026863 and 2026899. Any opinions, findings,
21 | and conclusions or recommendations expressed in this material are those
22 | of the author(s) and do not necessarily reflect the views of the
23 | National Science Foundation.
24 |
![\"Project](\"images/ProjectPythia_Logo_Final-01-Blue.svg\"){kind=logo}
"
14 | ]
15 | },
16 | {
17 | "cell_type": "markdown",
18 | "metadata": {},
19 | "source": [
20 | "# Project Pythia Notebook Template\n",
21 | "\n",
22 | "Next, title your notebook appropriately with a top-level Markdown header, `#`. Do not use this level header anywhere else in the notebook. Our book build process will use this title in the navbar, table of contents, etc. Keep it short, keep it descriptive. Follow this with a `---` cell to visually distinguish the transition to the prerequisites section."
23 | ]
24 | },
25 | {
26 | "cell_type": "markdown",
27 | "metadata": {},
28 | "source": [
29 | "---"
30 | ]
31 | },
32 | {
33 | "cell_type": "markdown",
34 | "metadata": {},
35 | "source": [
36 | "## Overview\n",
37 | "If you have an introductory paragraph, lead with it here! Keep it short and tied to your material, then be sure to continue into the required list of topics below,\n",
38 | "\n",
39 | "1. This is a numbered list of the specific topics\n",
40 | "1. These should map approximately to your main sections of content\n",
41 | "1. Or each second-level, `##`, header in your notebook\n",
42 | "1. Keep the size and scope of your notebook in check\n",
43 | "1. And be sure to let the reader know up front the important concepts they'll be leaving with"
44 | ]
45 | },
46 | {
47 | "cell_type": "markdown",
48 | "metadata": {},
49 | "source": [
50 | "## Prerequisites\n",
51 | "This section was inspired by [this template](https://github.com/alan-turing-institute/the-turing-way/blob/master/book/templates/chapter-template/chapter-landing-page.md) of the wonderful [The Turing Way](https://the-turing-way.netlify.app) Jupyter Book.\n",
52 | "\n",
53 | "Following your overview, tell your reader what concepts, packages, or other background information they'll **need** before learning your material. Tie this explicitly with links to other pages here in Foundations or to relevant external resources. Remove this body text, then populate the Markdown table, denoted in this cell with `|` vertical brackets, below, and fill out the information following. In this table, lay out prerequisite concepts by explicitly linking to other Foundations material or external resources, or describe generally helpful concepts.\n",
54 | "\n",
55 | "Label the importance of each concept explicitly as **helpful/necessary**.\n",
56 | "\n",
57 | "| Concepts | Importance | Notes |\n",
58 | "| --- | --- | --- |\n",
59 | "| [Intro to Cartopy](https://foundations.projectpythia.org/core/cartopy/cartopy.html) | Necessary | |\n",
60 | "| [Understanding of NetCDF](https://foundations.projectpythia.org/core/data-formats/netcdf-cf.html) | Helpful | Familiarity with metadata structure |\n",
61 | "| Project management | Helpful | |\n",
62 | "\n",
63 | "- **Time to learn**: estimate in minutes. For a rough idea, use 5 mins per subsection, 10 if longer; add these up for a total. Safer to round up and overestimate.\n",
64 | "- **System requirements**:\n",
65 | " - Populate with any system, version, or non-Python software requirements if necessary\n",
66 | " - Otherwise use the concepts table above and the Imports section below to describe required packages as necessary\n",
67 | " - If no extra requirements, remove the **System requirements** point altogether"
68 | ]
69 | },
70 | {
71 | "cell_type": "markdown",
72 | "metadata": {},
73 | "source": [
74 | "---"
75 | ]
76 | },
77 | {
78 | "cell_type": "markdown",
79 | "metadata": {},
80 | "source": [
81 | "## Imports\n",
82 | "Begin your body of content with another `---` divider before continuing into this section, then remove this body text and populate the following code cell with all necessary Python imports **up-front**:"
83 | ]
84 | },
85 | {
86 | "cell_type": "code",
87 | "execution_count": null,
88 | "metadata": {},
89 | "outputs": [],
90 | "source": [
91 | "import sys"
92 | ]
93 | },
94 | {
95 | "cell_type": "markdown",
96 | "metadata": {},
97 | "source": [
98 | "## Your first content section"
99 | ]
100 | },
101 | {
102 | "cell_type": "markdown",
103 | "metadata": {},
104 | "source": [
105 | "This is where you begin your first section of material, loosely tied to your objectives stated up front. Tie together your notebook as a narrative, with interspersed Markdown text, images, and more as necessary,"
106 | ]
107 | },
108 | {
109 | "cell_type": "code",
110 | "execution_count": null,
111 | "metadata": {},
112 | "outputs": [],
113 | "source": [
114 | "# as well as any and all of your code cells\n",
115 | "print(\"Hello world!\")"
116 | ]
117 | },
118 | {
119 | "cell_type": "markdown",
120 | "metadata": {},
121 | "source": [
122 | "### A content subsection\n",
123 | "Divide and conquer your objectives with Markdown subsections, which will populate the helpful navbar in Jupyter Lab and here on the Jupyter Book!"
124 | ]
125 | },
126 | {
127 | "cell_type": "code",
128 | "execution_count": null,
129 | "metadata": {},
130 | "outputs": [],
131 | "source": [
132 | "# some subsection code\n",
133 | "new = \"helpful information\""
134 | ]
135 | },
136 | {
137 | "cell_type": "markdown",
138 | "metadata": {},
139 | "source": [
140 | "### Another content subsection\n",
141 | "Keep up the good work! A note, *try to avoid using code comments as narrative*, and instead let them only exist as brief clarifications where necessary."
142 | ]
143 | },
144 | {
145 | "cell_type": "markdown",
146 | "metadata": {},
147 | "source": [
148 | "## Your second content section\n",
149 | "Here we can move on to our second objective, and we can demonstrate"
150 | ]
151 | },
152 | {
153 | "cell_type": "markdown",
154 | "metadata": {},
155 | "source": [
156 | "### Subsection to the second section\n",
157 | "\n",
158 | "#### a quick demonstration\n",
159 | "\n",
160 | "##### of further and further\n",
161 | "\n",
162 | "###### header levels"
163 | ]
164 | },
165 | {
166 | "cell_type": "markdown",
167 | "metadata": {},
168 | "source": [
169 | "as well $m = a * t / h$ text! Similarly, you have access to other $\\LaTeX$ equation [**functionality**](https://jupyter-notebook.readthedocs.io/en/stable/examples/Notebook/Typesetting%20Equations.html) via MathJax (demo below from link),\n",
170 | "\n",
171 | "\\begin{align}\n",
172 | "\\dot{x} & = \\sigma(y-x) \\\\\n",
173 | "\\dot{y} & = \\rho x - y - xz \\\\\n",
174 | "\\dot{z} & = -\\beta z + xy\n",
175 | "\\end{align}"
176 | ]
177 | },
178 | {
179 | "cell_type": "markdown",
180 | "metadata": {},
181 | "source": [
182 | "Check out [**any number of helpful Markdown resources**](https://www.markdownguide.org/basic-syntax/) for further customizing your notebooks and the [**Jupyter docs**](https://jupyter-notebook.readthedocs.io/en/stable/examples/Notebook/Working%20With%20Markdown%20Cells.html) for Jupyter-specific formatting information. Don't hesitate to ask questions if you have problems getting it to look *just right*."
183 | ]
184 | },
185 | {
186 | "cell_type": "markdown",
187 | "metadata": {},
188 | "source": [
189 | "## Last Section\n",
190 | "\n",
191 | "If you're comfortable, and as we briefly used for our embedded logo up top, you can embed raw html into Jupyter Markdown cells (edit to see):"
192 | ]
193 | },
194 | {
195 | "cell_type": "markdown",
196 | "metadata": {},
197 | "source": [
198 | "Info
\n", 200 | " Your relevant information here!\n", 201 | "Success
\n", 217 | " We got this done after all!\n", 218 | "Warning
\n", 227 | " Be careful!\n", 228 | "Danger
\n", 237 | " Scary stuff be here.\n", 238 | "