-
Notifications
You must be signed in to change notification settings - Fork 0
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 25d8287
Showing
101 changed files
with
29,072 additions
and
0 deletions.
There are no files selected for viewing
Binary file not shown.
Binary file not shown.
Binary file not shown.
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 @@ | ||
{} |
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
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: 8e33ea3f95df82b0abc398d3a2575dc9 | ||
tags: 645f666f9bcd5a90fca523b33c5a78b7 |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions
1
_build/html/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
7 changes: 7 additions & 0 deletions
7
_build/html/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css
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,7 @@ | ||
:root { | ||
--tabs-color-label-active: hsla(231, 99%, 66%, 1); | ||
--tabs-color-label-inactive: rgba(178, 206, 245, 0.62); | ||
--tabs-color-overline: rgb(207, 236, 238); | ||
--tabs-color-underline: rgb(207, 236, 238); | ||
--tabs-size-label: 1rem; | ||
} |
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 @@ | ||
# Bridge |
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,2 @@ | ||
# CRIM | ||
|
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,16 @@ | ||
# Welcome to your Jupyter Book | ||
|
||
This is a small sample book to give you a feel for how book content is | ||
structured. | ||
|
||
:::{note} | ||
Here is a note! | ||
::: | ||
|
||
And here is a code block: | ||
|
||
``` | ||
e = mc^2 | ||
``` | ||
|
||
Check out the content pages bundled with this sample book to see more. |
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,16 @@ | ||
# Welcome to your Jupyter Book | ||
|
||
This is a small sample book to give you a feel for how book content is | ||
structured. | ||
|
||
:::{note} | ||
Here is a note! | ||
::: | ||
|
||
And here is a code block: | ||
|
||
``` | ||
e = mc^2 | ||
``` | ||
|
||
Check out the content pages bundled with this sample book to see more. |
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,125 @@ | ||
# 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**. | ||
|
||
## 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. | ||
|
||
## What are 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. | ||
|
||
### Using a directive | ||
|
||
At its simplest, you can insert a directive into your book's content like so: | ||
|
||
```` | ||
```{mydirectivename} | ||
My directive content | ||
``` | ||
```` | ||
|
||
This will only work if a directive with name `mydirectivename` already exists | ||
(which it doesn't). There are many pre-defined directives associated with | ||
Jupyter Book. For example, to insert a note box into your content, you can | ||
use the following directive: | ||
|
||
```` | ||
```{note} | ||
Here is a note | ||
``` | ||
```` | ||
|
||
This results in: | ||
|
||
```{note} | ||
Here is a note | ||
``` | ||
|
||
In your built book. | ||
|
||
For more information on writing directives, see the | ||
[MyST documentation](https://myst-parser.readthedocs.io/). | ||
|
||
|
||
### Using a role | ||
|
||
Roles are very similar to directives, but they are less-complex and written | ||
entirely on one line. You can insert a role into your book's content with | ||
this pattern: | ||
|
||
``` | ||
Some content {rolename}`and here is my role's content!` | ||
``` | ||
|
||
Again, roles will only work if `rolename` is a valid role's name. For example, | ||
the `doc` role can be used to refer to another page in your book. You can | ||
refer directly to another page by its relative path. For example, the | ||
role syntax `` {doc}`intro` `` will result in: {doc}`intro`. | ||
|
||
For more information on writing roles, see the | ||
[MyST documentation](https://myst-parser.readthedocs.io/). | ||
|
||
|
||
### Adding a citation | ||
|
||
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} | ||
``` | ||
```` | ||
|
||
Resulting in a rendered bibliography that looks like: | ||
|
||
```{bibliography} | ||
``` | ||
|
||
|
||
### Executing code in your markdown files | ||
|
||
If you'd like to include computational content inside these markdown files, | ||
you can use MyST Markdown to define cells that will be executed when your | ||
book is built. Jupyter Book uses *jupytext* to do this. | ||
|
||
First, add Jupytext metadata to the file. For example, to add Jupytext metadata | ||
to this markdown page, run this command: | ||
|
||
``` | ||
jupyter-book myst init markdown.md | ||
``` | ||
|
||
Once a markdown file has Jupytext metadata in it, you can add the following | ||
directive to run the code at build time: | ||
|
||
```` | ||
```{code-cell} | ||
print("Here is some code to execute") | ||
``` | ||
```` | ||
|
||
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. | ||
|
||
For more information about executing computational content with Jupyter Book, | ||
see [The MyST-NB documentation](https://myst-nb.readthedocs.io/). |
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", | ||
"\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 | ||
} |
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 @@ | ||
# Ticha |
Empty file.
Binary file not shown.
Oops, something went wrong.