-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit b0f813e
Showing
171 changed files
with
27,144 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Sphinx build info version 1 | ||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. | ||
config: 9319bb9f4d7afcdb2971fab333ddf538 | ||
tags: 645f666f9bcd5a90fca523b33c5a78b7 |
Empty file.
Binary file added
BIN
+170 KB
_images/10e4426d9a98b8b32d6c7c558b9983b6bfbf3f7b3422996bacff632594cdfad8.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# NASA Earthdata Cloud | ||
|
||
https://www.earthdata.nasa.gov/ |
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# Reproducibly Analyzing Wildfire, Drought, and Flood Risk with NASA Earthdata Cloud | ||
|
||
|
||
```{tableofcontents} | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
--- | ||
jupytext: | ||
formats: md:myst | ||
text_representation: | ||
extension: .md | ||
format_name: myst | ||
format_version: 0.13 | ||
jupytext_version: 1.11.5 | ||
kernelspec: | ||
display_name: Python 3 | ||
language: python | ||
name: python3 | ||
--- | ||
|
||
# Notebooks with MyST Markdown | ||
|
||
Jupyter Book also lets you write text-based notebooks using MyST Markdown. | ||
See [the Notebooks with MyST Markdown documentation](https://jupyterbook.org/file-types/myst-notebooks.html) for more detailed instructions. | ||
This page shows off a notebook written in MyST Markdown. | ||
|
||
## An example cell | ||
|
||
With MyST Markdown, you can define code cells with a directive like so: | ||
|
||
```{code-cell} | ||
print(2 + 2) | ||
``` | ||
|
||
When your book is built, the contents of any `{code-cell}` blocks will be | ||
executed with your default Jupyter kernel, and their outputs will be displayed | ||
in-line with the rest of your content. | ||
|
||
```{seealso} | ||
Jupyter Book uses [Jupytext](https://jupytext.readthedocs.io/en/latest/) to convert text-based files to notebooks, and can support [many other text-based notebook files](https://jupyterbook.org/file-types/jupytext.html). | ||
``` | ||
|
||
## Create a notebook with MyST Markdown | ||
|
||
MyST Markdown notebooks are defined by two things: | ||
|
||
1. YAML metadata that is needed to understand if / how it should convert text files to notebooks (including information about the kernel needed). | ||
See the YAML at the top of this page for example. | ||
2. The presence of `{code-cell}` directives, which will be executed with your book. | ||
|
||
That's all that is needed to get started! | ||
|
||
## Quickly add YAML metadata for MyST Notebooks | ||
|
||
If you have a markdown file and you'd like to quickly add YAML metadata to it, so that Jupyter Book will treat it as a MyST Markdown Notebook, run the following command: | ||
|
||
``` | ||
jupyter-book myst init path/to/markdownfile.md | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
# Markdown Files | ||
|
||
Whether you write your book's content in Jupyter Notebooks (`.ipynb`) or | ||
in regular markdown files (`.md`), you'll write in the same flavor of markdown | ||
called **MyST Markdown**. | ||
This is a simple file to help you get started and show off some syntax. | ||
|
||
## What is MyST? | ||
|
||
MyST stands for "Markedly Structured Text". It | ||
is a slight variation on a flavor of markdown called "CommonMark" markdown, | ||
with small syntax extensions to allow you to write **roles** and **directives** | ||
in the Sphinx ecosystem. | ||
|
||
For more about MyST, see [the MyST Markdown Overview](https://jupyterbook.org/content/myst.html). | ||
|
||
## Sample Roles and Directives | ||
|
||
Roles and directives are two of the most powerful tools in Jupyter Book. They | ||
are kind of like functions, but written in a markup language. They both | ||
serve a similar purpose, but **roles are written in one line**, whereas | ||
**directives span many lines**. They both accept different kinds of inputs, | ||
and what they do with those inputs depends on the specific role or directive | ||
that is being called. | ||
|
||
Here is a "note" directive: | ||
|
||
```{note} | ||
Here is a note | ||
``` | ||
|
||
It will be rendered in a special box when you build your book. | ||
|
||
Here is an inline directive to refer to a document: {doc}`markdown-notebooks`. | ||
|
||
|
||
## Citations | ||
|
||
You can also cite references that are stored in a `bibtex` file. For example, | ||
the following syntax: `` {cite}`holdgraf_evidence_2014` `` will render like | ||
this: {cite}`holdgraf_evidence_2014`. | ||
|
||
Moreover, you can insert a bibliography into your page with this syntax: | ||
The `{bibliography}` directive must be used for all the `{cite}` roles to | ||
render properly. | ||
For example, if the references for your book are stored in `references.bib`, | ||
then the bibliography is inserted with: | ||
|
||
```{bibliography} | ||
``` | ||
|
||
## Learn more | ||
|
||
This is just a simple starter to get you started. | ||
You can learn a lot more at [jupyterbook.org](https://jupyterbook.org). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,122 @@ | ||
{ | ||
"cells": [ | ||
{ | ||
"cell_type": "markdown", | ||
"metadata": {}, | ||
"source": [ | ||
"# Content with notebooks\n", | ||
"\n", | ||
"You can also create content with Jupyter Notebooks. This means that you can include\n", | ||
"code blocks and their outputs in your book.\n", | ||
"\n", | ||
"## Markdown + notebooks\n", | ||
"\n", | ||
"As it is markdown, you can embed images, HTML, etc into your posts!\n", | ||
"\n", | ||
"![](https://myst-parser.readthedocs.io/en/latest/_static/logo-wide.svg)\n", | ||
"\n", | ||
"You can also $add_{math}$ and\n", | ||
"\n", | ||
"$$\n", | ||
"math^{blocks}\n", | ||
"$$\n", | ||
"\n", | ||
"or\n", | ||
"\n", | ||
"$$\n", | ||
"\\begin{aligned}\n", | ||
"\\mbox{mean} la_{tex} \\\\ \\\\\n", | ||
"math blocks\n", | ||
"\\end{aligned}\n", | ||
"$$\n", | ||
"\n", | ||
"But make sure you \\$Escape \\$your \\$dollar signs \\$you want to keep!\n", | ||
"\n", | ||
"## MyST markdown\n", | ||
"\n", | ||
"MyST markdown works in Jupyter Notebooks as well. For more information about MyST markdown, check\n", | ||
"out [the MyST guide in Jupyter Book](https://jupyterbook.org/content/myst.html),\n", | ||
"or see [the MyST markdown documentation](https://myst-parser.readthedocs.io/en/latest/).\n", | ||
"\n", | ||
"## Code blocks and outputs\n", | ||
"\n", | ||
"Jupyter Book will also embed your code blocks and output in your book.\n", | ||
"For example, here's some sample Matplotlib code:" | ||
] | ||
}, | ||
{ | ||
"cell_type": "code", | ||
"execution_count": null, | ||
"metadata": {}, | ||
"outputs": [], | ||
"source": [ | ||
"from matplotlib import rcParams, cycler\n", | ||
"import matplotlib.pyplot as plt\n", | ||
"import numpy as np\n", | ||
"plt.ion()" | ||
] | ||
}, | ||
{ | ||
"cell_type": "code", | ||
"execution_count": null, | ||
"metadata": {}, | ||
"outputs": [], | ||
"source": [ | ||
"# Fixing random state for reproducibility\n", | ||
"np.random.seed(19680801)\n", | ||
"\n", | ||
"N = 10\n", | ||
"data = [np.logspace(0, 1, 100) + np.random.randn(100) + ii for ii in range(N)]\n", | ||
"data = np.array(data).T\n", | ||
"cmap = plt.cm.coolwarm\n", | ||
"rcParams['axes.prop_cycle'] = cycler(color=cmap(np.linspace(0, 1, N)))\n", | ||
"\n", | ||
"\n", | ||
"from matplotlib.lines import Line2D\n", | ||
"custom_lines = [Line2D([0], [0], color=cmap(0.), lw=4),\n", | ||
" Line2D([0], [0], color=cmap(.5), lw=4),\n", | ||
" Line2D([0], [0], color=cmap(1.), lw=4)]\n", | ||
"\n", | ||
"fig, ax = plt.subplots(figsize=(10, 5))\n", | ||
"lines = ax.plot(data)\n", | ||
"ax.legend(custom_lines, ['Cold', 'Medium', 'Hot']);" | ||
] | ||
}, | ||
{ | ||
"cell_type": "markdown", | ||
"metadata": {}, | ||
"source": [ | ||
"There is a lot more that you can do with outputs (such as including interactive outputs)\n", | ||
"with your book. For more information about this, see [the Jupyter Book documentation](https://jupyterbook.org)" | ||
] | ||
} | ||
], | ||
"metadata": { | ||
"kernelspec": { | ||
"display_name": "Python 3", | ||
"language": "python", | ||
"name": "python3" | ||
}, | ||
"language_info": { | ||
"codemirror_mode": { | ||
"name": "ipython", | ||
"version": 3 | ||
}, | ||
"file_extension": ".py", | ||
"mimetype": "text/x-python", | ||
"name": "python", | ||
"nbconvert_exporter": "python", | ||
"pygments_lexer": "ipython3", | ||
"version": "3.8.0" | ||
}, | ||
"widgets": { | ||
"application/vnd.jupyter.widget-state+json": { | ||
"state": {}, | ||
"version_major": 2, | ||
"version_minor": 0 | ||
} | ||
} | ||
}, | ||
"nbformat": 4, | ||
"nbformat_minor": 4 | ||
} |
Empty file.
1 change: 1 addition & 0 deletions
1
_sphinx_design_static/design-style.4045f2051d55cab465a707391d5b2007.min.css
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
var sd_labels_by_text = {}; | ||
|
||
function ready() { | ||
const li = document.getElementsByClassName("sd-tab-label"); | ||
for (const label of li) { | ||
syncId = label.getAttribute("data-sync-id"); | ||
if (syncId) { | ||
label.onclick = onLabelClick; | ||
if (!sd_labels_by_text[syncId]) { | ||
sd_labels_by_text[syncId] = []; | ||
} | ||
sd_labels_by_text[syncId].push(label); | ||
} | ||
} | ||
} | ||
|
||
function onLabelClick() { | ||
// Activate other inputs with the same sync id. | ||
syncId = this.getAttribute("data-sync-id"); | ||
for (label of sd_labels_by_text[syncId]) { | ||
if (label === this) continue; | ||
label.previousElementSibling.checked = true; | ||
} | ||
window.localStorage.setItem("sphinx-design-last-tab", syncId); | ||
} | ||
|
||
document.addEventListener("DOMContentLoaded", ready, false); |
Oops, something went wrong.