![\"logo\"](\"../_static/logo-wide.svg\"){kind=logo}
\n",
"```\n",
"\n",
"\n",
"\n",
"Because MyST-NB is using the MyST-markdown parser, you can include rich markdown with Sphinx in your notebook.\n",
"For example, here's a note admonition block:\n",
"\n",
":::::{note}\n",
"**Wow**, a note!\n",
"It was generated with this code ([as explained here](myst:syntax/admonitions)):\n",
"\n",
"````md\n",
":::{note}\n",
"**Wow**, a note!\n",
":::\n",
"````\n",
"\n",
":::::\n",
"\n",
"If you wish to use \"bare\" LaTeX equations, then you should add `\"amsmath\"` to the `myst_enable_extensions` list in the sphinx configuration.\n",
"This is [explained here](myst:syntax/amsmath), and works as such:\n",
"\n",
"```latex\n",
"\\begin{equation}\n",
"\\frac {\\partial u}{\\partial x} + \\frac{\\partial v}{\\partial y} = - \\, \\frac{\\partial w}{\\partial z}\n",
"\\end{equation}\n",
"\n",
"\\begin{align*}\n",
"2x - 5y &= 8 \\\\\n",
"3x + 9y &= -12\n",
"\\end{align*}\n",
"```\n",
"\n",
"\\begin{equation}\n",
"\\frac {\\partial u}{\\partial x} + \\frac{\\partial v}{\\partial y} = - \\, \\frac{\\partial w}{\\partial z}\n",
"\\end{equation}\n",
"\n",
"\\begin{align*}\n",
"2x - 5y &= 8 \\\\\n",
"3x + 9y &= -12\n",
"\\end{align*}\n",
"\n",
"Also you can use features like **equation numbering** and referencing in the notebooks:\n",
"\n",
"```md\n",
"$$e^{i\\pi} + 1 = 0$$ (euler)\n",
"```\n",
"\n",
"$$e^{i\\pi} + 1 = 0$$ (euler)\n",
"\n",
"Euler's identity, equation {math:numref}`euler`, was elected one of the\n",
"most beautiful mathematical formulas.\n",
"\n",
"You can see the syntax used for this example [here in the MyST documentation](myst:syntax/math).\n",
"\n",
"## Code cells and outputs\n",
"\n",
"You can run cells, and the cell outputs will be captured and inserted into\n",
"the resulting Sphinx site.\n",
"\n",
"### `__repr__` and HTML outputs\n",
"\n",
"For example, here's some simple Python:"
]
},
{
"cell_type": "code",
"execution_count": 1,
"id": "e34d5156",
"metadata": {},
"outputs": [
{
"data": {
"text/plain": [
"array([[26.59947279, 98.03821766, 58.23609027, 70.26947523, 59.31895406,\n",
" 21.1227099 , 83.59051317, 2.12201407, 94.44876671, 11.69044867],\n",
" [97.39468064, 19.7389163 , 88.338811 , 7.06922797, 56.30006951,\n",
" 18.09139558, 12.88842663, 64.42585041, 94.85442285, 38.4760182 ],\n",
" [ 1.74988383, 91.59758352, 49.93034764, 66.56360849, 84.35349458,\n",
" 88.72709499, 58.3334899 , 70.98011815, 28.87184062, 86.10161235]])"
]
},
"execution_count": 1,
"metadata": {},
"output_type": "execute_result"
}
],
"source": [
"import matplotlib.pyplot as plt\n",
"import numpy as np\n",
"data = np.random.rand(3, 100) * 100\n",
"data[:, :10]"
]
},
{
"cell_type": "markdown",
"id": "e5177bba",
"metadata": {},
"source": [
"This will also work with HTML outputs"
]
},
{
"cell_type": "code",
"execution_count": 2,
"id": "09b37348",
"metadata": {},
"outputs": [
{
"data": {
"text/html": [
"| \n", " | a | \n", "b | \n", "c | \n", "
|---|---|---|---|
| 0 | \n", "26.599473 | \n", "97.394681 | \n", "1.749884 | \n", "
| 1 | \n", "98.038218 | \n", "19.738916 | \n", "91.597584 | \n", "
| 2 | \n", "58.236090 | \n", "88.338811 | \n", "49.930348 | \n", "
| 3 | \n", "70.269475 | \n", "7.069228 | \n", "66.563608 | \n", "
| 4 | \n", "59.318954 | \n", "56.300070 | \n", "84.353495 | \n", "
My cat is very grumpy.
\n", "```\n", "````" ] }, { "cell_type": "raw", "id": "6b0e4698", "metadata": { "format": "text/html" }, "source": [ "My cat is very grumpy.
" ] } ], "metadata": { "file_format": "mystnb", "kernelspec": { "display_name": "python3", "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.6" }, "source_map": [ 5, 124, 129, 133, 137, 141, 144, 148, 153, 160, 163, 177 ] }, "nbformat": 4, "nbformat_minor": 5 }