Let’s start here! If you can directly link to an image relevant to your notebook, such as canonical logos, do so here at the top of your notebook. You can do this with Markdown syntax,
![<image title>](http://link.com/to/image.png "image alt text")
or edit this cell to see raw HTML
img demonstration. This is preferred if you need to shrink your embedded image. Either way be sure to include
alt text for any embedded images to make your content more accessible.
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.
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,
This is a numbered list of the specific topics
These should map approximately to your main sections of content
Or each second-level,
##, header in your notebook
Keep the size and scope of your notebook in check
And be sure to let the reader know up front the important concepts they’ll be leaving with
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.
Label the importance of each concept explicitly as helpful/necessary.
Understanding of NetCDF
Familiarity with metadata structure
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.
Populate with any system, version, or non-Python software requirements if necessary
Otherwise use the concepts table above and the Imports section below to describe required packages as necessary
If no extra requirements, remove the System requirements point altogether
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:
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,
# as well as any and all of your code cells print("Hello world!")
Divide and conquer your objectives with Markdown subsections, which will populate the helpful navbar in Jupyter Lab and here on the Jupyter Book!
# some subsection code new = "helpful information"
Here we can move on to our second objective, and we can demonstrate
as well \(m = a * t / h\) text! Similarly, you have access to other \(\LaTeX\) equation functionality via MathJax (demo below from link),
Check out any number of helpful Markdown resources for further customizing your notebooks and the Jupyter docs for Jupyter-specific formatting information. Don’t hesitate to ask questions if you have problems getting it to look just right.
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):
Your relevant information here!
Feel free to copy this around and edit or play around with yourself. Some other
admonitions you can put in:
We got this done after all!
Scary stuff be here.
We also suggest checking out Jupyter Book’s brief demonstration on adding cell tags to your cells in Jupyter Notebook, Lab, or manually. Using these cell tags can allow you to customize how your code content is displayed and even demonstrate errors without altogether crashing our loyal army of machines!
Add one final
--- marking the end of your body of content, and then conclude with a brief single paragraph summarizing at a high level the key pieces that were learned and how they tied to your objectives. Look to reiterate what the most important takeaways were.
Finally, be rigorous in your citations and references as necessary. Give credit where credit is due. Also, feel free to link to relevant external material, further reading, documentation, etc. Then you’re done! Give yourself a quick review, a high five, and send us a Pull Request. A few final notes:
Kernel > Restart Kernel and Run All Cells...to confirm that your notebook will cleanly run from start to finish
Kernel > Restart Kernel and Clear All Outputs...before committing your notebook, our machines will do the heavy lifting
Take credit! Provide author contact information if you’d like; if so, consider adding information here at the bottom of your notebook
Give credit! Attribute appropriate authorship for referenced code, information, images, etc.
Only include what you’re legally allowed: no copyright infringement or plagiarism
Thank you for your contribution!