Merge pull request #6843 from minrk/nbformat4-examples
update example notebooks to v4
Thomas Kluyver
11 years ago
commit
edc0adb797
File diff suppressed because one or more lines are too long
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because one or more lines are too long
@ -1,141 +1,139 @@
|
||||
{
|
||||
"metadata": {
|
||||
"name": "",
|
||||
"signature": "sha256:5f38c57d9570e4b6f6edf98c38a7bff81cd16365baa11fd40265f1504bfc008c"
|
||||
},
|
||||
"nbformat": 3,
|
||||
"nbformat_minor": 0,
|
||||
"worksheets": [
|
||||
"cells": [
|
||||
{
|
||||
"cells": [
|
||||
{
|
||||
"cell_type": "heading",
|
||||
"level": 1,
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Factoring Polynomials with SymPy"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Here is an example that uses [SymPy](http://sympy.org/en/index.html) to factor polynomials."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"collapsed": false,
|
||||
"input": [
|
||||
"from IPython.html.widgets import interact\n",
|
||||
"from IPython.display import display"
|
||||
],
|
||||
"language": "python",
|
||||
"metadata": {},
|
||||
"outputs": [],
|
||||
"prompt_number": 1
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"collapsed": false,
|
||||
"input": [
|
||||
"from sympy import Symbol, Eq, factor, init_printing\n",
|
||||
"init_printing(use_latex='mathjax')"
|
||||
],
|
||||
"language": "python",
|
||||
"metadata": {},
|
||||
"outputs": [],
|
||||
"prompt_number": 2
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"collapsed": false,
|
||||
"input": [
|
||||
"x = Symbol('x')"
|
||||
],
|
||||
"language": "python",
|
||||
"metadata": {},
|
||||
"outputs": [],
|
||||
"prompt_number": 3
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"collapsed": false,
|
||||
"input": [
|
||||
"def factorit(n):\n",
|
||||
" display(Eq(x**n-1, factor(x**n-1)))"
|
||||
],
|
||||
"language": "python",
|
||||
"metadata": {},
|
||||
"outputs": [],
|
||||
"prompt_number": 4
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Notice how the output of the `factorit` function is properly formatted LaTeX."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"collapsed": false,
|
||||
"input": [
|
||||
"factorit(12)"
|
||||
],
|
||||
"language": "python",
|
||||
"metadata": {},
|
||||
"outputs": [
|
||||
{
|
||||
"latex": [
|
||||
"$$x^{12} - 1 = \\left(x - 1\\right) \\left(x + 1\\right) \\left(x^{2} + 1\\right) \\left(x^{2} - x + 1\\right) \\left(x^{2} + x + 1\\right) \\left(x^{4} - x^{2} + 1\\right)$$"
|
||||
],
|
||||
"metadata": {},
|
||||
"output_type": "display_data",
|
||||
"text": [
|
||||
" 12 \u239b 2 \u239e \u239b 2 \u239e \u239b 2 \u239e \u239b 4 2 \u239e\n",
|
||||
"x - 1 = (x - 1)\u22c5(x + 1)\u22c5\u239dx + 1\u23a0\u22c5\u239dx - x + 1\u23a0\u22c5\u239dx + x + 1\u23a0\u22c5\u239dx - x + 1\u23a0"
|
||||
]
|
||||
}
|
||||
],
|
||||
"prompt_number": 5
|
||||
},
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"# Factoring Polynomials with SymPy"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Here is an example that uses [SymPy](http://sympy.org/en/index.html) to factor polynomials."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": 1,
|
||||
"metadata": {
|
||||
"collapsed": false
|
||||
},
|
||||
"outputs": [],
|
||||
"source": [
|
||||
"from IPython.html.widgets import interact\n",
|
||||
"from IPython.display import display"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": 2,
|
||||
"metadata": {
|
||||
"collapsed": false
|
||||
},
|
||||
"outputs": [],
|
||||
"source": [
|
||||
"from sympy import Symbol, Eq, factor, init_printing\n",
|
||||
"init_printing(use_latex='mathjax')"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": 3,
|
||||
"metadata": {
|
||||
"collapsed": false
|
||||
},
|
||||
"outputs": [],
|
||||
"source": [
|
||||
"x = Symbol('x')"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": 4,
|
||||
"metadata": {
|
||||
"collapsed": false
|
||||
},
|
||||
"outputs": [],
|
||||
"source": [
|
||||
"def factorit(n):\n",
|
||||
" display(Eq(x**n-1, factor(x**n-1)))"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Notice how the output of the `factorit` function is properly formatted LaTeX."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": 5,
|
||||
"metadata": {
|
||||
"collapsed": false
|
||||
},
|
||||
"outputs": [
|
||||
{
|
||||
"cell_type": "code",
|
||||
"collapsed": false,
|
||||
"input": [
|
||||
"interact(factorit, n=(2,40));"
|
||||
],
|
||||
"language": "python",
|
||||
"data": {
|
||||
"text/latex": [
|
||||
"$$x^{12} - 1 = \\left(x - 1\\right) \\left(x + 1\\right) \\left(x^{2} + 1\\right) \\left(x^{2} - x + 1\\right) \\left(x^{2} + x + 1\\right) \\left(x^{4} - x^{2} + 1\\right)$$"
|
||||
],
|
||||
"text/plain": [
|
||||
" 12 \u239b 2 \u239e \u239b 2 \u239e \u239b 2 \u239e \u239b 4 2 \u239e\n",
|
||||
"x - 1 = (x - 1)\u22c5(x + 1)\u22c5\u239dx + 1\u23a0\u22c5\u239dx - x + 1\u23a0\u22c5\u239dx + x + 1\u23a0\u22c5\u239dx - x + 1\u23a0"
|
||||
]
|
||||
},
|
||||
"metadata": {},
|
||||
"outputs": [
|
||||
{
|
||||
"latex": [
|
||||
"$$x^{21} - 1 = \\left(x - 1\\right) \\left(x^{2} + x + 1\\right) \\left(x^{6} + x^{5} + x^{4} + x^{3} + x^{2} + x + 1\\right) \\left(x^{12} - x^{11} + x^{9} - x^{8} + x^{6} - x^{4} + x^{3} - x + 1\\right)$$"
|
||||
],
|
||||
"metadata": {},
|
||||
"output_type": "display_data",
|
||||
"text": [
|
||||
" 21 \u239b 2 \u239e \u239b 6 5 4 3 2 \u239e \u239b 12 11 \n",
|
||||
"x - 1 = (x - 1)\u22c5\u239dx + x + 1\u23a0\u22c5\u239dx + x + x + x + x + x + 1\u23a0\u22c5\u239dx - x + x\n",
|
||||
"\n",
|
||||
"9 8 6 4 3 \u239e\n",
|
||||
" - x + x - x + x - x + 1\u23a0"
|
||||
]
|
||||
}
|
||||
],
|
||||
"prompt_number": 6
|
||||
},
|
||||
"output_type": "display_data"
|
||||
}
|
||||
],
|
||||
"source": [
|
||||
"factorit(12)"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": 6,
|
||||
"metadata": {
|
||||
"collapsed": false
|
||||
},
|
||||
"outputs": [
|
||||
{
|
||||
"cell_type": "code",
|
||||
"collapsed": false,
|
||||
"input": [],
|
||||
"language": "python",
|
||||
"data": {
|
||||
"text/latex": [
|
||||
"$$x^{21} - 1 = \\left(x - 1\\right) \\left(x^{2} + x + 1\\right) \\left(x^{6} + x^{5} + x^{4} + x^{3} + x^{2} + x + 1\\right) \\left(x^{12} - x^{11} + x^{9} - x^{8} + x^{6} - x^{4} + x^{3} - x + 1\\right)$$"
|
||||
],
|
||||
"text/plain": [
|
||||
" 21 \u239b 2 \u239e \u239b 6 5 4 3 2 \u239e \u239b 12 11 \n",
|
||||
"x - 1 = (x - 1)\u22c5\u239dx + x + 1\u23a0\u22c5\u239dx + x + x + x + x + x + 1\u23a0\u22c5\u239dx - x + x\n",
|
||||
"\n",
|
||||
"9 8 6 4 3 \u239e\n",
|
||||
" - x + x - x + x - x + 1\u23a0"
|
||||
]
|
||||
},
|
||||
"metadata": {},
|
||||
"outputs": []
|
||||
"output_type": "display_data"
|
||||
}
|
||||
],
|
||||
"metadata": {}
|
||||
"source": [
|
||||
"interact(factorit, n=(2,40));"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": null,
|
||||
"metadata": {
|
||||
"collapsed": false
|
||||
},
|
||||
"outputs": [],
|
||||
"source": []
|
||||
}
|
||||
]
|
||||
],
|
||||
"metadata": {
|
||||
"signature": "sha256:5f38c57d9570e4b6f6edf98c38a7bff81cd16365baa11fd40265f1504bfc008c"
|
||||
},
|
||||
"nbformat": 4,
|
||||
"nbformat_minor": 0
|
||||
}
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -1,149 +1,139 @@
|
||||
{
|
||||
"metadata": {
|
||||
"name": "",
|
||||
"signature": "sha256:9a1dd30de04270174c09ef33ca214e5b15ca3721547420087c1563ad557d78e3"
|
||||
},
|
||||
"nbformat": 3,
|
||||
"nbformat_minor": 0,
|
||||
"worksheets": [
|
||||
"cells": [
|
||||
{
|
||||
"cells": [
|
||||
{
|
||||
"cell_type": "heading",
|
||||
"level": 1,
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Connecting to an existing IPython kernel using the Qt Console"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "heading",
|
||||
"level": 2,
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"The Frontend/Kernel Model"
|
||||
]
|
||||
},
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"# Connecting to an existing IPython kernel using the Qt Console"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"## The Frontend/Kernel Model"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"The traditional IPython (`ipython`) consists of a single process that combines a terminal based UI with the process that runs the users code.\n",
|
||||
"\n",
|
||||
"While this traditional application still exists, the modern IPython consists of two processes:\n",
|
||||
"\n",
|
||||
"* Kernel: this is the process that runs the users code.\n",
|
||||
"* Frontend: this is the process that provides the user interface where the user types code and sees results.\n",
|
||||
"\n",
|
||||
"IPython currently has 3 frontends:\n",
|
||||
"\n",
|
||||
"* Terminal Console (`ipython console`)\n",
|
||||
"* Qt Console (`ipython qtconsole`)\n",
|
||||
"* Notebook (`ipython notebook`)\n",
|
||||
"\n",
|
||||
"The Kernel and Frontend communicate over a ZeroMQ/JSON based messaging protocol, which allows multiple Frontends (even of different types) to communicate with a single Kernel. This opens the door for all sorts of interesting things, such as connecting a Console or Qt Console to a Notebook's Kernel. For example, you may want to connect a Qt console to your Notebook's Kernel and use it as a help\n",
|
||||
"browser, calling `??` on objects in the Qt console (whose pager is more flexible than the\n",
|
||||
"one in the notebook). \n",
|
||||
"\n",
|
||||
"This Notebook describes how you would connect another Frontend to a Kernel that is associated with a Notebook."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"## Manual connection"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"To connect another Frontend to a Kernel manually, you first need to find out the connection information for the Kernel using the `%connect_info` magic:"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": 6,
|
||||
"metadata": {
|
||||
"collapsed": false
|
||||
},
|
||||
"outputs": [
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"The traditional IPython (`ipython`) consists of a single process that combines a terminal based UI with the process that runs the users code.\n",
|
||||
"\n",
|
||||
"While this traditional application still exists, the modern IPython consists of two processes:\n",
|
||||
"\n",
|
||||
"* Kernel: this is the process that runs the users code.\n",
|
||||
"* Frontend: this is the process that provides the user interface where the user types code and sees results.\n",
|
||||
"\n",
|
||||
"IPython currently has 3 frontends:\n",
|
||||
"name": "stdout",
|
||||
"output_type": "stream",
|
||||
"text": [
|
||||
"{\n",
|
||||
" \"stdin_port\": 52858, \n",
|
||||
" \"ip\": \"127.0.0.1\", \n",
|
||||
" \"hb_port\": 52859, \n",
|
||||
" \"key\": \"7efd45ca-d8a2-41b0-9cea-d9116d0fb883\", \n",
|
||||
" \"shell_port\": 52856, \n",
|
||||
" \"iopub_port\": 52857\n",
|
||||
"}\n",
|
||||
"\n",
|
||||
"* Terminal Console (`ipython console`)\n",
|
||||
"* Qt Console (`ipython qtconsole`)\n",
|
||||
"* Notebook (`ipython notebook`)\n",
|
||||
"\n",
|
||||
"The Kernel and Frontend communicate over a ZeroMQ/JSON based messaging protocol, which allows multiple Frontends (even of different types) to communicate with a single Kernel. This opens the door for all sorts of interesting things, such as connecting a Console or Qt Console to a Notebook's Kernel. For example, you may want to connect a Qt console to your Notebook's Kernel and use it as a help\n",
|
||||
"browser, calling `??` on objects in the Qt console (whose pager is more flexible than the\n",
|
||||
"one in the notebook). \n",
|
||||
"\n",
|
||||
"This Notebook describes how you would connect another Frontend to a Kernel that is associated with a Notebook."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "heading",
|
||||
"level": 2,
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Manual connection"
|
||||
"Paste the above JSON into a file, and connect with:\n",
|
||||
" $> ipython <app> --existing <file>\n",
|
||||
"or, if you are local, you can connect with just:\n",
|
||||
" $> ipython <app> --existing kernel-b3bac7c1-8b2c-4536-8082-8d1df24f99ac.json \n",
|
||||
"or even just:\n",
|
||||
" $> ipython <app> --existing \n",
|
||||
"if this is the most recent IPython session you have started.\n"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"To connect another Frontend to a Kernel manually, you first need to find out the connection information for the Kernel using the `%connect_info` magic:"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"collapsed": false,
|
||||
"input": [
|
||||
"%connect_info"
|
||||
],
|
||||
"language": "python",
|
||||
"metadata": {},
|
||||
"outputs": [
|
||||
{
|
||||
"output_type": "stream",
|
||||
"stream": "stdout",
|
||||
"text": [
|
||||
"{\n",
|
||||
" \"stdin_port\": 52858, \n",
|
||||
" \"ip\": \"127.0.0.1\", \n",
|
||||
" \"hb_port\": 52859, \n",
|
||||
" \"key\": \"7efd45ca-d8a2-41b0-9cea-d9116d0fb883\", \n",
|
||||
" \"shell_port\": 52856, \n",
|
||||
" \"iopub_port\": 52857\n",
|
||||
"}\n",
|
||||
"\n",
|
||||
"Paste the above JSON into a file, and connect with:\n",
|
||||
" $> ipython <app> --existing <file>\n",
|
||||
"or, if you are local, you can connect with just:\n",
|
||||
" $> ipython <app> --existing kernel-b3bac7c1-8b2c-4536-8082-8d1df24f99ac.json \n",
|
||||
"or even just:\n",
|
||||
" $> ipython <app> --existing \n",
|
||||
"if this is the most recent IPython session you have started.\n"
|
||||
]
|
||||
}
|
||||
],
|
||||
"prompt_number": 6
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"You can see that this magic displays everything you need to connect to this Notebook's Kernel."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "heading",
|
||||
"level": 2,
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Automatic connection using a new Qt Console"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"You can also start a new Qt Console connected to your current Kernel by using the `%qtconsole` magic. This will detect the necessary connection\n",
|
||||
"information and start the Qt Console for you automatically."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"collapsed": false,
|
||||
"input": [
|
||||
"a = 10"
|
||||
],
|
||||
"language": "python",
|
||||
"metadata": {},
|
||||
"outputs": [],
|
||||
"prompt_number": 1
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"collapsed": false,
|
||||
"input": [
|
||||
"%qtconsole"
|
||||
],
|
||||
"language": "python",
|
||||
"metadata": {},
|
||||
"outputs": [],
|
||||
"prompt_number": 2
|
||||
}
|
||||
],
|
||||
"metadata": {}
|
||||
"source": [
|
||||
"%connect_info"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"You can see that this magic displays everything you need to connect to this Notebook's Kernel."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"## Automatic connection using a new Qt Console"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"You can also start a new Qt Console connected to your current Kernel by using the `%qtconsole` magic. This will detect the necessary connection\n",
|
||||
"information and start the Qt Console for you automatically."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": 1,
|
||||
"metadata": {
|
||||
"collapsed": false
|
||||
},
|
||||
"outputs": [],
|
||||
"source": [
|
||||
"a = 10"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": 2,
|
||||
"metadata": {
|
||||
"collapsed": false
|
||||
},
|
||||
"outputs": [],
|
||||
"source": [
|
||||
"%qtconsole"
|
||||
]
|
||||
}
|
||||
]
|
||||
],
|
||||
"metadata": {
|
||||
"signature": "sha256:9a1dd30de04270174c09ef33ca214e5b15ca3721547420087c1563ad557d78e3"
|
||||
},
|
||||
"nbformat": 4,
|
||||
"nbformat_minor": 0
|
||||
}
|
||||
@ -1,496 +1,485 @@
|
||||
{
|
||||
"metadata": {
|
||||
"name": ""
|
||||
},
|
||||
"nbformat": 3,
|
||||
"nbformat_minor": 0,
|
||||
"worksheets": [
|
||||
"cells": [
|
||||
{
|
||||
"cells": [
|
||||
{
|
||||
"cell_type": "heading",
|
||||
"level": 1,
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"NbConvert"
|
||||
]
|
||||
},
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"# NbConvert"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"## Command line usage"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"`NbConvert` is the library, and the command line tool that allow to convert from notebook to other formats.\n",
|
||||
"It is a technological preview in 1.0 but is already usable and highly configurable.\n",
|
||||
"It ships already with many default available formats : `html`, `latex`, `markdown`, `python`, `rst` and `slides`\n",
|
||||
"which are fully base on Jinja templating engine, so writing a converter for your custom format or tweeking the existing \n",
|
||||
"one should be extra simple."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"You can invoke nbconvert by doing\n",
|
||||
"\n",
|
||||
"```bash\n",
|
||||
"$ ipython nbconvert <options and arguments>\n",
|
||||
"```\n",
|
||||
"\n",
|
||||
"Call `ipython nbconvert` with the `--help` flag or no aruments to get basic help on how to use it.\n",
|
||||
"For more information about configuration use the `--help-all` flag"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"### Basic export"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"We will be converting `Custom Display Logic.ipynb`. \n",
|
||||
"Be sure to have runed some of the cells in it to have output otherwise you will only see input in nbconvert.\n",
|
||||
"Nbconvert **do not execute the code** in the notebook files, it only converts what is inside."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": 1,
|
||||
"metadata": {
|
||||
"collapsed": false
|
||||
},
|
||||
"outputs": [
|
||||
{
|
||||
"cell_type": "heading",
|
||||
"level": 2,
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Command line usage"
|
||||
"name": "stderr",
|
||||
"output_type": "stream",
|
||||
"text": [
|
||||
"[NbConvertApp] Using existing profile dir: u'/Users/bussonniermatthias/.ipython/profile_default'\n",
|
||||
"[NbConvertApp] Converting notebook 04 - Custom Display Logic.ipynb to html\n",
|
||||
"[NbConvertApp] Support files will be in 04 - Custom Display Logic_files/\n",
|
||||
"[NbConvertApp] Loaded template html_full.tpl\n",
|
||||
"[NbConvertApp] Writing 221081 bytes to 04 - Custom Display Logic.html\n"
|
||||
]
|
||||
},
|
||||
}
|
||||
],
|
||||
"source": [
|
||||
"%%bash\n",
|
||||
"ipython nbconvert '04 - Custom Display Logic.ipynb'"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Html is the default value (that can be configured) , so the verbose form would be "
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": 2,
|
||||
"metadata": {
|
||||
"collapsed": false
|
||||
},
|
||||
"outputs": [
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"`NbConvert` is the library, and the command line tool that allow to convert from notebook to other formats.\n",
|
||||
"It is a technological preview in 1.0 but is already usable and highly configurable.\n",
|
||||
"It ships already with many default available formats : `html`, `latex`, `markdown`, `python`, `rst` and `slides`\n",
|
||||
"which are fully base on Jinja templating engine, so writing a converter for your custom format or tweeking the existing \n",
|
||||
"one should be extra simple."
|
||||
"name": "stderr",
|
||||
"output_type": "stream",
|
||||
"text": [
|
||||
"[NbConvertApp] Using existing profile dir: u'/Users/bussonniermatthias/.ipython/profile_default'\n",
|
||||
"[NbConvertApp] Converting notebook 04 - Custom Display Logic.ipynb to html\n",
|
||||
"[NbConvertApp] Support files will be in 04 - Custom Display Logic_files/\n",
|
||||
"[NbConvertApp] Loaded template html_full.tpl\n",
|
||||
"[NbConvertApp] Writing 221081 bytes to 04 - Custom Display Logic.html\n"
|
||||
]
|
||||
},
|
||||
}
|
||||
],
|
||||
"source": [
|
||||
"%%bash\n",
|
||||
"ipython nbconvert --to=html '04 - Custom Display Logic.ipynb'"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"You can also convert to latex, which will take care of extractin the embeded base64 encoded png, or the svg and call inkscape to convert those svg to pdf if necessary :"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": 3,
|
||||
"metadata": {
|
||||
"collapsed": false
|
||||
},
|
||||
"outputs": [
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"You can invoke nbconvert by doing\n",
|
||||
"name": "stderr",
|
||||
"output_type": "stream",
|
||||
"text": [
|
||||
"[NbConvertApp] Using existing profile dir: u'/Users/bussonniermatthias/.ipython/profile_default'\n",
|
||||
"[NbConvertApp] Converting notebook 04 - Custom Display Logic.ipynb to latex\n",
|
||||
"[NbConvertApp] Support files will be in 04 - Custom Display Logic_files/\n",
|
||||
"Setting Language: .UTF-8\n",
|
||||
"\n",
|
||||
"```bash\n",
|
||||
"$ ipython nbconvert <options and arguments>\n",
|
||||
"```\n",
|
||||
"(process:26432): Gtk-WARNING **: Locale not supported by C library.\n",
|
||||
"\tUsing the fallback 'C' locale.\n",
|
||||
"Setting Language: .UTF-8\n",
|
||||
"\n",
|
||||
"Call `ipython nbconvert` with the `--help` flag or no aruments to get basic help on how to use it.\n",
|
||||
"For more information about configuration use the `--help-all` flag"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "heading",
|
||||
"level": 3,
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Basic export"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"We will be converting `Custom Display Logic.ipynb`. \n",
|
||||
"Be sure to have runed some of the cells in it to have output otherwise you will only see input in nbconvert.\n",
|
||||
"Nbconvert **do not execute the code** in the notebook files, it only converts what is inside."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"collapsed": false,
|
||||
"input": [
|
||||
"%%bash\n",
|
||||
"ipython nbconvert '04 - Custom Display Logic.ipynb'"
|
||||
],
|
||||
"language": "python",
|
||||
"metadata": {},
|
||||
"outputs": [
|
||||
{
|
||||
"output_type": "stream",
|
||||
"stream": "stderr",
|
||||
"text": [
|
||||
"[NbConvertApp] Using existing profile dir: u'/Users/bussonniermatthias/.ipython/profile_default'\n",
|
||||
"[NbConvertApp] Converting notebook 04 - Custom Display Logic.ipynb to html\n",
|
||||
"[NbConvertApp] Support files will be in 04 - Custom Display Logic_files/\n",
|
||||
"[NbConvertApp] Loaded template html_full.tpl\n",
|
||||
"[NbConvertApp] Writing 221081 bytes to 04 - Custom Display Logic.html\n"
|
||||
]
|
||||
}
|
||||
],
|
||||
"prompt_number": 1
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Html is the default value (that can be configured) , so the verbose form would be "
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"collapsed": false,
|
||||
"input": [
|
||||
"%%bash\n",
|
||||
"ipython nbconvert --to=html '04 - Custom Display Logic.ipynb'"
|
||||
],
|
||||
"language": "python",
|
||||
"metadata": {},
|
||||
"outputs": [
|
||||
{
|
||||
"output_type": "stream",
|
||||
"stream": "stderr",
|
||||
"text": [
|
||||
"[NbConvertApp] Using existing profile dir: u'/Users/bussonniermatthias/.ipython/profile_default'\n",
|
||||
"[NbConvertApp] Converting notebook 04 - Custom Display Logic.ipynb to html\n",
|
||||
"[NbConvertApp] Support files will be in 04 - Custom Display Logic_files/\n",
|
||||
"[NbConvertApp] Loaded template html_full.tpl\n",
|
||||
"[NbConvertApp] Writing 221081 bytes to 04 - Custom Display Logic.html\n"
|
||||
]
|
||||
}
|
||||
],
|
||||
"prompt_number": 2
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"You can also convert to latex, which will take care of extractin the embeded base64 encoded png, or the svg and call inkscape to convert those svg to pdf if necessary :"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"collapsed": false,
|
||||
"input": [
|
||||
"%%bash\n",
|
||||
"ipython nbconvert --to=latex '04 - Custom Display Logic.ipynb'"
|
||||
],
|
||||
"language": "python",
|
||||
"metadata": {},
|
||||
"outputs": [
|
||||
{
|
||||
"output_type": "stream",
|
||||
"stream": "stderr",
|
||||
"text": [
|
||||
"[NbConvertApp] Using existing profile dir: u'/Users/bussonniermatthias/.ipython/profile_default'\n",
|
||||
"[NbConvertApp] Converting notebook 04 - Custom Display Logic.ipynb to latex\n",
|
||||
"[NbConvertApp] Support files will be in 04 - Custom Display Logic_files/\n",
|
||||
"Setting Language: .UTF-8\n",
|
||||
"\n",
|
||||
"(process:26432): Gtk-WARNING **: Locale not supported by C library.\n",
|
||||
"\tUsing the fallback 'C' locale.\n",
|
||||
"Setting Language: .UTF-8\n",
|
||||
"\n",
|
||||
"(process:26472): Gtk-WARNING **: Locale not supported by C library.\n",
|
||||
"\tUsing the fallback 'C' locale.\n",
|
||||
"Setting Language: .UTF-8\n",
|
||||
"\n",
|
||||
"(process:26512): Gtk-WARNING **: Locale not supported by C library.\n",
|
||||
"\tUsing the fallback 'C' locale.\n",
|
||||
"Setting Language: .UTF-8\n",
|
||||
"\n",
|
||||
"(process:26552): Gtk-WARNING **: Locale not supported by C library.\n",
|
||||
"\tUsing the fallback 'C' locale.\n",
|
||||
"Setting Language: .UTF-8\n",
|
||||
"\n",
|
||||
"(process:26592): Gtk-WARNING **: Locale not supported by C library.\n",
|
||||
"\tUsing the fallback 'C' locale.\n",
|
||||
"[NbConvertApp] Loaded template latex_article.tplx\n",
|
||||
"[NbConvertApp] Writing 41196 bytes to 04 - Custom Display Logic.tex\n"
|
||||
]
|
||||
}
|
||||
],
|
||||
"prompt_number": 3
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"You should just have to compile the generated `.tex` file. If you get the required packages installed, if should compile out of the box.\n",
|
||||
"(process:26472): Gtk-WARNING **: Locale not supported by C library.\n",
|
||||
"\tUsing the fallback 'C' locale.\n",
|
||||
"Setting Language: .UTF-8\n",
|
||||
"\n",
|
||||
"For convenience we allow to run extra action after the conversion has been done, in particular for `latex` we have a `pdf` post-processor. \n",
|
||||
"You can define the postprocessor tu run with the `--post` flag."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"collapsed": false,
|
||||
"input": [
|
||||
"%%bash\n",
|
||||
"ipython nbconvert --to=latex '04 - Custom Display Logic.ipynb' --post=pdf"
|
||||
],
|
||||
"language": "python",
|
||||
"metadata": {},
|
||||
"outputs": [
|
||||
{
|
||||
"output_type": "stream",
|
||||
"stream": "stderr",
|
||||
"text": [
|
||||
"[NbConvertApp] Using existing profile dir: u'/Users/bussonniermatthias/.ipython/profile_default'\n",
|
||||
"[NbConvertApp] Converting notebook 04 - Custom Display Logic.ipynb to latex\n",
|
||||
"[NbConvertApp] Support files will be in 04 - Custom Display Logic_files/\n",
|
||||
"Setting Language: .UTF-8\n",
|
||||
"\n",
|
||||
"(process:26658): Gtk-WARNING **: Locale not supported by C library.\n",
|
||||
"\tUsing the fallback 'C' locale.\n",
|
||||
"Setting Language: .UTF-8\n",
|
||||
"\n",
|
||||
"(process:26698): Gtk-WARNING **: Locale not supported by C library.\n",
|
||||
"\tUsing the fallback 'C' locale.\n",
|
||||
"Setting Language: .UTF-8\n",
|
||||
"\n",
|
||||
"(process:26738): Gtk-WARNING **: Locale not supported by C library.\n",
|
||||
"\tUsing the fallback 'C' locale.\n",
|
||||
"Setting Language: .UTF-8\n",
|
||||
"\n",
|
||||
"(process:26778): Gtk-WARNING **: Locale not supported by C library.\n",
|
||||
"\tUsing the fallback 'C' locale.\n",
|
||||
"Setting Language: .UTF-8\n",
|
||||
"\n",
|
||||
"(process:26818): Gtk-WARNING **: Locale not supported by C library.\n",
|
||||
"\tUsing the fallback 'C' locale.\n",
|
||||
"[NbConvertApp] Loaded template latex_article.tplx\n",
|
||||
"[NbConvertApp] Writing 41196 bytes to 04 - Custom Display Logic.tex\n",
|
||||
"[NbConvertApp] Building PDF: ['pdflatex', '04 - Custom Display Logic.tex']\n"
|
||||
]
|
||||
}
|
||||
],
|
||||
"prompt_number": 4
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Have a look at `04 - Custom Display Logic.pdf`, toward the end, where we compared `display()` vs `display_html()` and returning the object.\n",
|
||||
"See how the cell where we use `display_html` was not able to display the circle, whereas the two other ones were able to select one of the oher representation they know how to display."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "heading",
|
||||
"level": 3,
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Customizing template"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"let's look at the first 20 lines of the `python` exporter"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"collapsed": false,
|
||||
"input": [
|
||||
"pyfile = !ipython nbconvert --to python '04 - Custom Display Logic.ipynb' --stdout\n",
|
||||
"for l in pyfile[20:40]:\n",
|
||||
" print l"
|
||||
],
|
||||
"language": "python",
|
||||
"metadata": {},
|
||||
"outputs": [
|
||||
{
|
||||
"output_type": "stream",
|
||||
"stream": "stdout",
|
||||
"text": [
|
||||
"# 1. Implementing special display methods such as `_repr_html_`.\n",
|
||||
"# 2. Registering a display function for a particular type.\n",
|
||||
"# \n",
|
||||
"# In this Notebook we show how both approaches work.\n",
|
||||
"\n",
|
||||
"# Before we get started, we will import the various display functions for displaying the different formats we will create.\n",
|
||||
"\n",
|
||||
"# In[54]:\n",
|
||||
"\n",
|
||||
"from IPython.display import display\n",
|
||||
"from IPython.display import (\n",
|
||||
" display_html, display_jpeg, display_png,\n",
|
||||
" display_javascript, display_svg, display_latex\n",
|
||||
")\n",
|
||||
"\n",
|
||||
"\n",
|
||||
"### Implementing special display methods\n",
|
||||
"\n",
|
||||
"# The main idea of the first approach is that you have to implement special display methods, one for each representation you want to use. Here is a list of the names of the special methods and the values they must return:\n",
|
||||
"# \n"
|
||||
]
|
||||
}
|
||||
],
|
||||
"prompt_number": 5
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"We see that the non-code cell are exported to the file. To have a cleaner script, we will export only the code contained in the code cells.\n",
|
||||
"(process:26512): Gtk-WARNING **: Locale not supported by C library.\n",
|
||||
"\tUsing the fallback 'C' locale.\n",
|
||||
"Setting Language: .UTF-8\n",
|
||||
"\n",
|
||||
"(process:26552): Gtk-WARNING **: Locale not supported by C library.\n",
|
||||
"\tUsing the fallback 'C' locale.\n",
|
||||
"Setting Language: .UTF-8\n",
|
||||
"\n",
|
||||
"To do so, we will inherit the python template, and overwrite the markdown blocks to be empty."
|
||||
"(process:26592): Gtk-WARNING **: Locale not supported by C library.\n",
|
||||
"\tUsing the fallback 'C' locale.\n",
|
||||
"[NbConvertApp] Loaded template latex_article.tplx\n",
|
||||
"[NbConvertApp] Writing 41196 bytes to 04 - Custom Display Logic.tex\n"
|
||||
]
|
||||
},
|
||||
}
|
||||
],
|
||||
"source": [
|
||||
"%%bash\n",
|
||||
"ipython nbconvert --to=latex '04 - Custom Display Logic.ipynb'"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"You should just have to compile the generated `.tex` file. If you get the required packages installed, if should compile out of the box.\n",
|
||||
"\n",
|
||||
"For convenience we allow to run extra action after the conversion has been done, in particular for `latex` we have a `pdf` post-processor. \n",
|
||||
"You can define the postprocessor tu run with the `--post` flag."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": 4,
|
||||
"metadata": {
|
||||
"collapsed": false
|
||||
},
|
||||
"outputs": [
|
||||
{
|
||||
"cell_type": "code",
|
||||
"collapsed": false,
|
||||
"input": [
|
||||
"%%writefile simplepython.tpl\n",
|
||||
"{% extends 'python.tpl'%}\n",
|
||||
"name": "stderr",
|
||||
"output_type": "stream",
|
||||
"text": [
|
||||
"[NbConvertApp] Using existing profile dir: u'/Users/bussonniermatthias/.ipython/profile_default'\n",
|
||||
"[NbConvertApp] Converting notebook 04 - Custom Display Logic.ipynb to latex\n",
|
||||
"[NbConvertApp] Support files will be in 04 - Custom Display Logic_files/\n",
|
||||
"Setting Language: .UTF-8\n",
|
||||
"\n",
|
||||
"{% block markdowncell -%}\n",
|
||||
"{% endblock markdowncell %}\n",
|
||||
"(process:26658): Gtk-WARNING **: Locale not supported by C library.\n",
|
||||
"\tUsing the fallback 'C' locale.\n",
|
||||
"Setting Language: .UTF-8\n",
|
||||
"\n",
|
||||
"## we also want to get rig of header cell\n",
|
||||
"{% block headingcell -%}\n",
|
||||
"{% endblock headingcell %}\n",
|
||||
"(process:26698): Gtk-WARNING **: Locale not supported by C library.\n",
|
||||
"\tUsing the fallback 'C' locale.\n",
|
||||
"Setting Language: .UTF-8\n",
|
||||
"\n",
|
||||
"## and let's change the appearance of input prompt\n",
|
||||
"{% block in_prompt %}\n",
|
||||
"# This was input cell with prompt number : {{ cell.prompt_number if cell.prompt_number else ' ' }}\n",
|
||||
"{%- endblock in_prompt %}"
|
||||
],
|
||||
"language": "python",
|
||||
"metadata": {},
|
||||
"outputs": [
|
||||
{
|
||||
"output_type": "stream",
|
||||
"stream": "stdout",
|
||||
"text": [
|
||||
"Overwriting simplepython.tpl\n"
|
||||
]
|
||||
}
|
||||
],
|
||||
"prompt_number": 6
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"collapsed": false,
|
||||
"input": [
|
||||
"pyfile = !ipython nbconvert --to python '04 - Custom Display Logic.ipynb' --stdout --template=simplepython.tpl\n",
|
||||
"(process:26738): Gtk-WARNING **: Locale not supported by C library.\n",
|
||||
"\tUsing the fallback 'C' locale.\n",
|
||||
"Setting Language: .UTF-8\n",
|
||||
"\n",
|
||||
"for l in pyfile[4:40]:\n",
|
||||
" print l\n",
|
||||
"print '...'"
|
||||
],
|
||||
"language": "python",
|
||||
"metadata": {},
|
||||
"outputs": [
|
||||
{
|
||||
"output_type": "stream",
|
||||
"stream": "stdout",
|
||||
"text": [
|
||||
"\n",
|
||||
"# This was input cell with prompt number : 54\n",
|
||||
"from IPython.display import display\n",
|
||||
"from IPython.display import (\n",
|
||||
" display_html, display_jpeg, display_png,\n",
|
||||
" display_javascript, display_svg, display_latex\n",
|
||||
")\n",
|
||||
"\n",
|
||||
"\n",
|
||||
"# This was input cell with prompt number : 55\n",
|
||||
"get_ipython().magic(u'load soln/mycircle.py')\n",
|
||||
"\n",
|
||||
"\n",
|
||||
"# This was input cell with prompt number : 56\n",
|
||||
"class MyCircle(object):\n",
|
||||
" \n",
|
||||
" def _repr_html_(self):\n",
|
||||
" return \"○ (<b>html</b>)\"\n",
|
||||
"\n",
|
||||
" def _repr_svg_(self):\n",
|
||||
" return \"\"\"<svg width='100px' height='100px'>\n",
|
||||
" <circle cx=\"50\" cy=\"50\" r=\"20\" stroke=\"black\" stroke-width=\"1\" fill=\"blue\"/>\n",
|
||||
" </svg>\"\"\"\n",
|
||||
" \n",
|
||||
" def _repr_latex_(self):\n",
|
||||
" return r\"$\\bigcirc \\LaTeX$\"\n",
|
||||
"\n",
|
||||
" def _repr_javascript_(self):\n",
|
||||
" return \"alert('I am a circle!');\"\n",
|
||||
"\n",
|
||||
"\n",
|
||||
"# This was input cell with prompt number : 57\n",
|
||||
"c = MyCircle()\n",
|
||||
"\n",
|
||||
"\n",
|
||||
"# This was input cell with prompt number : 58\n",
|
||||
"...\n"
|
||||
]
|
||||
}
|
||||
],
|
||||
"prompt_number": 7
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"I'll let you read Jinja manual for the exact syntax of the template."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "heading",
|
||||
"level": 2,
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Template that use cells metadata"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Notebook fileformat support attaching arbitrary JSON metadata to each cell of a notebook. In this part we will use those metadata."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"First you need to choose another notebook you want to convert to html, and tag some of the cell with metadata.\n",
|
||||
"You can see the file `soln/celldiff.js` for a solution on how to tag, or follow the javascript tutorial to see how to do that. Use what we have written there to tag cells of some notebooks to `Easy`|`Medium`|`Hard`|`<None>`, and convert this notebook using your template."
|
||||
"(process:26778): Gtk-WARNING **: Locale not supported by C library.\n",
|
||||
"\tUsing the fallback 'C' locale.\n",
|
||||
"Setting Language: .UTF-8\n",
|
||||
"\n",
|
||||
"(process:26818): Gtk-WARNING **: Locale not supported by C library.\n",
|
||||
"\tUsing the fallback 'C' locale.\n",
|
||||
"[NbConvertApp] Loaded template latex_article.tplx\n",
|
||||
"[NbConvertApp] Writing 41196 bytes to 04 - Custom Display Logic.tex\n",
|
||||
"[NbConvertApp] Building PDF: ['pdflatex', '04 - Custom Display Logic.tex']\n"
|
||||
]
|
||||
},
|
||||
}
|
||||
],
|
||||
"source": [
|
||||
"%%bash\n",
|
||||
"ipython nbconvert --to=latex '04 - Custom Display Logic.ipynb' --post=pdf"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Have a look at `04 - Custom Display Logic.pdf`, toward the end, where we compared `display()` vs `display_html()` and returning the object.\n",
|
||||
"See how the cell where we use `display_html` was not able to display the circle, whereas the two other ones were able to select one of the oher representation they know how to display."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"### Customizing template"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"let's look at the first 20 lines of the `python` exporter"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": 5,
|
||||
"metadata": {
|
||||
"collapsed": false
|
||||
},
|
||||
"outputs": [
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"you might need the following : \n",
|
||||
"```\n",
|
||||
"{% extends 'html_full.tpl'%}\n",
|
||||
"{% block any_cell %}\n",
|
||||
"{{ super() }}\n",
|
||||
"<div style=\"background-color:red\">\n",
|
||||
"<div style='background-color:orange'>\n",
|
||||
"```\n",
|
||||
"name": "stdout",
|
||||
"output_type": "stream",
|
||||
"text": [
|
||||
"# 1. Implementing special display methods such as `_repr_html_`.\n",
|
||||
"# 2. Registering a display function for a particular type.\n",
|
||||
"# \n",
|
||||
"# In this Notebook we show how both approaches work.\n",
|
||||
"\n",
|
||||
"# Before we get started, we will import the various display functions for displaying the different formats we will create.\n",
|
||||
"\n",
|
||||
"# In[54]:\n",
|
||||
"\n",
|
||||
"`metadata` might not exist, be sure to :\n",
|
||||
"from IPython.display import display\n",
|
||||
"from IPython.display import (\n",
|
||||
" display_html, display_jpeg, display_png,\n",
|
||||
" display_javascript, display_svg, display_latex\n",
|
||||
")\n",
|
||||
"\n",
|
||||
"`cell['metadata'].get('example',{}).get('difficulty','')`\n",
|
||||
"\n",
|
||||
"tip: use `%%writefile` to edit the template in the notebook :-)"
|
||||
"### Implementing special display methods\n",
|
||||
"\n",
|
||||
"# The main idea of the first approach is that you have to implement special display methods, one for each representation you want to use. Here is a list of the names of the special methods and the values they must return:\n",
|
||||
"# \n"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"collapsed": false,
|
||||
"input": [
|
||||
"%%bash\n",
|
||||
"# ipython nbconvert --to html <your chosen notebook.ipynb> --template=<your template file>"
|
||||
],
|
||||
"language": "python",
|
||||
"metadata": {},
|
||||
"outputs": [],
|
||||
"prompt_number": 8
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"collapsed": false,
|
||||
"input": [
|
||||
"%loadpy soln/coloreddiff.tpl"
|
||||
],
|
||||
"language": "python",
|
||||
"metadata": {},
|
||||
"outputs": []
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"collapsed": false,
|
||||
"input": [
|
||||
"# ipython nbconvert --to html '04 - Custom Display Logic.ipynb' --template=soln/coloreddiff.tpl"
|
||||
],
|
||||
"language": "python",
|
||||
"metadata": {},
|
||||
"outputs": []
|
||||
},
|
||||
}
|
||||
],
|
||||
"source": [
|
||||
"pyfile = !ipython nbconvert --to python '04 - Custom Display Logic.ipynb' --stdout\n",
|
||||
"for l in pyfile[20:40]:\n",
|
||||
" print l"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"We see that the non-code cell are exported to the file. To have a cleaner script, we will export only the code contained in the code cells.\n",
|
||||
"\n",
|
||||
"To do so, we will inherit the python template, and overwrite the markdown blocks to be empty."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": 6,
|
||||
"metadata": {
|
||||
"collapsed": false
|
||||
},
|
||||
"outputs": [
|
||||
{
|
||||
"cell_type": "heading",
|
||||
"level": 3,
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Get rid of all command line flags."
|
||||
"name": "stdout",
|
||||
"output_type": "stream",
|
||||
"text": [
|
||||
"Overwriting simplepython.tpl\n"
|
||||
]
|
||||
},
|
||||
}
|
||||
],
|
||||
"source": [
|
||||
"%%writefile simplepython.tpl\n",
|
||||
"{% extends 'python.tpl'%}\n",
|
||||
"\n",
|
||||
"{% block markdowncell -%}\n",
|
||||
"{% endblock markdowncell %}\n",
|
||||
"\n",
|
||||
"## we also want to get rig of header cell\n",
|
||||
"{% block headingcell -%}\n",
|
||||
"{% endblock headingcell %}\n",
|
||||
"\n",
|
||||
"## and let's change the appearance of input prompt\n",
|
||||
"{% block in_prompt %}\n",
|
||||
"# This was input cell with prompt number : {{ cell.prompt_number if cell.prompt_number else ' ' }}\n",
|
||||
"{%- endblock in_prompt %}"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": 7,
|
||||
"metadata": {
|
||||
"collapsed": false
|
||||
},
|
||||
"outputs": [
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"As of all of IPython nbconvert can be configured using profiles and passing the `--profile` flag. \n",
|
||||
"Moreover if a `config.py` file exist in current working directory nbconvert will use that, or read the config file you give to it with the `--config=<file>` flag. \n",
|
||||
"name": "stdout",
|
||||
"output_type": "stream",
|
||||
"text": [
|
||||
"\n",
|
||||
"# This was input cell with prompt number : 54\n",
|
||||
"from IPython.display import display\n",
|
||||
"from IPython.display import (\n",
|
||||
" display_html, display_jpeg, display_png,\n",
|
||||
" display_javascript, display_svg, display_latex\n",
|
||||
")\n",
|
||||
"\n",
|
||||
"\n",
|
||||
"# This was input cell with prompt number : 55\n",
|
||||
"get_ipython().magic(u'load soln/mycircle.py')\n",
|
||||
"\n",
|
||||
"\n",
|
||||
"# This was input cell with prompt number : 56\n",
|
||||
"class MyCircle(object):\n",
|
||||
" \n",
|
||||
" def _repr_html_(self):\n",
|
||||
" return \"○ (<b>html</b>)\"\n",
|
||||
"\n",
|
||||
" def _repr_svg_(self):\n",
|
||||
" return \"\"\"<svg width='100px' height='100px'>\n",
|
||||
" <circle cx=\"50\" cy=\"50\" r=\"20\" stroke=\"black\" stroke-width=\"1\" fill=\"blue\"/>\n",
|
||||
" </svg>\"\"\"\n",
|
||||
" \n",
|
||||
" def _repr_latex_(self):\n",
|
||||
" return r\"$\\bigcirc \\LaTeX$\"\n",
|
||||
"\n",
|
||||
" def _repr_javascript_(self):\n",
|
||||
" return \"alert('I am a circle!');\"\n",
|
||||
"\n",
|
||||
"\n",
|
||||
"# This was input cell with prompt number : 57\n",
|
||||
"c = MyCircle()\n",
|
||||
"\n",
|
||||
"In the end, if you are often running nbconvert on the sam project, `$ ipython nbconvert` should be enough to get you up and ready."
|
||||
"\n",
|
||||
"# This was input cell with prompt number : 58\n",
|
||||
"...\n"
|
||||
]
|
||||
}
|
||||
],
|
||||
"metadata": {}
|
||||
"source": [
|
||||
"pyfile = !ipython nbconvert --to python '04 - Custom Display Logic.ipynb' --stdout --template=simplepython.tpl\n",
|
||||
"\n",
|
||||
"for l in pyfile[4:40]:\n",
|
||||
" print l\n",
|
||||
"print '...'"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"I'll let you read Jinja manual for the exact syntax of the template."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"## Template that use cells metadata"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Notebook fileformat support attaching arbitrary JSON metadata to each cell of a notebook. In this part we will use those metadata."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"First you need to choose another notebook you want to convert to html, and tag some of the cell with metadata.\n",
|
||||
"You can see the file `soln/celldiff.js` for a solution on how to tag, or follow the javascript tutorial to see how to do that. Use what we have written there to tag cells of some notebooks to `Easy`|`Medium`|`Hard`|`<None>`, and convert this notebook using your template."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"you might need the following : \n",
|
||||
"```\n",
|
||||
"{% extends 'html_full.tpl'%}\n",
|
||||
"{% block any_cell %}\n",
|
||||
"{{ super() }}\n",
|
||||
"<div style=\"background-color:red\">\n",
|
||||
"<div style='background-color:orange'>\n",
|
||||
"```\n",
|
||||
"\n",
|
||||
"`metadata` might not exist, be sure to :\n",
|
||||
"\n",
|
||||
"`cell['metadata'].get('example',{}).get('difficulty','')`\n",
|
||||
"\n",
|
||||
"tip: use `%%writefile` to edit the template in the notebook :-)"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": 8,
|
||||
"metadata": {
|
||||
"collapsed": false
|
||||
},
|
||||
"outputs": [],
|
||||
"source": [
|
||||
"%%bash\n",
|
||||
"# ipython nbconvert --to html <your chosen notebook.ipynb> --template=<your template file>"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": null,
|
||||
"metadata": {
|
||||
"collapsed": false
|
||||
},
|
||||
"outputs": [],
|
||||
"source": [
|
||||
"%loadpy soln/coloreddiff.tpl"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": null,
|
||||
"metadata": {
|
||||
"collapsed": false
|
||||
},
|
||||
"outputs": [],
|
||||
"source": [
|
||||
"# ipython nbconvert --to html '04 - Custom Display Logic.ipynb' --template=soln/coloreddiff.tpl"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"### Get rid of all command line flags."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"As of all of IPython nbconvert can be configured using profiles and passing the `--profile` flag. \n",
|
||||
"Moreover if a `config.py` file exist in current working directory nbconvert will use that, or read the config file you give to it with the `--config=<file>` flag. \n",
|
||||
"\n",
|
||||
"In the end, if you are often running nbconvert on the sam project, `$ ipython nbconvert` should be enough to get you up and ready."
|
||||
]
|
||||
}
|
||||
]
|
||||
],
|
||||
"metadata": {},
|
||||
"nbformat": 4,
|
||||
"nbformat_minor": 0
|
||||
}
|
||||
@ -1,149 +1,147 @@
|
||||
{
|
||||
"metadata": {
|
||||
"name": ""
|
||||
},
|
||||
"nbformat": 3,
|
||||
"nbformat_minor": 0,
|
||||
"worksheets": [
|
||||
"cells": [
|
||||
{
|
||||
"cells": [
|
||||
{
|
||||
"cell_type": "heading",
|
||||
"level": 1,
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Keyboard Shortcut Customization"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Starting with IPython 2.0 keyboard shortcuts in command and edit mode are fully customizable. These customizations are made using the IPython JavaScript API. Here is an example that makes the `r` key available for running a cell:"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"collapsed": false,
|
||||
"input": [
|
||||
"%%javascript\n",
|
||||
"\n",
|
||||
"IPython.keyboard_manager.command_shortcuts.add_shortcut('r', {\n",
|
||||
" help : 'run cell',\n",
|
||||
" help_index : 'zz',\n",
|
||||
" handler : function (event) {\n",
|
||||
" IPython.notebook.execute_cell();\n",
|
||||
" return false;\n",
|
||||
" }}\n",
|
||||
");"
|
||||
],
|
||||
"language": "python",
|
||||
"metadata": {},
|
||||
"outputs": [
|
||||
{
|
||||
"javascript": [
|
||||
"\n",
|
||||
"IPython.keyboard_manager.command_shortcuts.add_shortcut('r', {\n",
|
||||
" help : 'run cell',\n",
|
||||
" help_index : 'zz',\n",
|
||||
" handler : function (event) {\n",
|
||||
" IPython.notebook.execute_cell();\n",
|
||||
" return false;\n",
|
||||
" }}\n",
|
||||
");"
|
||||
],
|
||||
"metadata": {},
|
||||
"output_type": "display_data",
|
||||
"text": [
|
||||
"<IPython.core.display.Javascript at 0x10e8d1890>"
|
||||
]
|
||||
}
|
||||
],
|
||||
"prompt_number": 7
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"There are a couple of points to mention about this API:\n",
|
||||
"\n",
|
||||
"* The `help_index` field is used to sort the shortcuts in the Keyboard Shortcuts help dialog. It defaults to `zz`.\n",
|
||||
"* When a handler returns `false` it indicates that the event should stop propagating and the default action should not be performed. For further details about the `event` object or event handling, see the jQuery docs.\n",
|
||||
"* If you don't need a `help` or `help_index` field, you can simply pass a function as the second argument to `add_shortcut`."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"collapsed": false,
|
||||
"input": [
|
||||
"%%javascript\n",
|
||||
"\n",
|
||||
"IPython.keyboard_manager.command_shortcuts.add_shortcut('r', function (event) {\n",
|
||||
" IPython.notebook.execute_cell();\n",
|
||||
" return false;\n",
|
||||
"});"
|
||||
],
|
||||
"language": "python",
|
||||
"metadata": {},
|
||||
"outputs": [
|
||||
{
|
||||
"javascript": [
|
||||
"\n",
|
||||
"IPython.keyboard_manager.command_shortcuts.add_shortcut('r', function (event) {\n",
|
||||
" IPython.notebook.execute_cell();\n",
|
||||
" return false;\n",
|
||||
"});"
|
||||
],
|
||||
"metadata": {},
|
||||
"output_type": "display_data",
|
||||
"text": [
|
||||
"<IPython.core.display.Javascript at 0x1019baf90>"
|
||||
]
|
||||
}
|
||||
],
|
||||
"prompt_number": 11
|
||||
},
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"# Keyboard Shortcut Customization"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Starting with IPython 2.0 keyboard shortcuts in command and edit mode are fully customizable. These customizations are made using the IPython JavaScript API. Here is an example that makes the `r` key available for running a cell:"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": 7,
|
||||
"metadata": {
|
||||
"collapsed": false
|
||||
},
|
||||
"outputs": [
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"data": {
|
||||
"application/javascript": [
|
||||
"\n",
|
||||
"IPython.keyboard_manager.command_shortcuts.add_shortcut('r', {\n",
|
||||
" help : 'run cell',\n",
|
||||
" help_index : 'zz',\n",
|
||||
" handler : function (event) {\n",
|
||||
" IPython.notebook.execute_cell();\n",
|
||||
" return false;\n",
|
||||
" }}\n",
|
||||
");"
|
||||
],
|
||||
"text/plain": [
|
||||
"<IPython.core.display.Javascript at 0x10e8d1890>"
|
||||
]
|
||||
},
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Likewise, to remove a shortcut, use `remove_shortcut`:"
|
||||
]
|
||||
},
|
||||
"output_type": "display_data"
|
||||
}
|
||||
],
|
||||
"source": [
|
||||
"%%javascript\n",
|
||||
"\n",
|
||||
"IPython.keyboard_manager.command_shortcuts.add_shortcut('r', {\n",
|
||||
" help : 'run cell',\n",
|
||||
" help_index : 'zz',\n",
|
||||
" handler : function (event) {\n",
|
||||
" IPython.notebook.execute_cell();\n",
|
||||
" return false;\n",
|
||||
" }}\n",
|
||||
");"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"There are a couple of points to mention about this API:\n",
|
||||
"\n",
|
||||
"* The `help_index` field is used to sort the shortcuts in the Keyboard Shortcuts help dialog. It defaults to `zz`.\n",
|
||||
"* When a handler returns `false` it indicates that the event should stop propagating and the default action should not be performed. For further details about the `event` object or event handling, see the jQuery docs.\n",
|
||||
"* If you don't need a `help` or `help_index` field, you can simply pass a function as the second argument to `add_shortcut`."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": 11,
|
||||
"metadata": {
|
||||
"collapsed": false
|
||||
},
|
||||
"outputs": [
|
||||
{
|
||||
"cell_type": "code",
|
||||
"collapsed": false,
|
||||
"input": [
|
||||
"%%javascript\n",
|
||||
"\n",
|
||||
"IPython.keyboard_manager.command_shortcuts.remove_shortcut('r');"
|
||||
],
|
||||
"language": "python",
|
||||
"data": {
|
||||
"application/javascript": [
|
||||
"\n",
|
||||
"IPython.keyboard_manager.command_shortcuts.add_shortcut('r', function (event) {\n",
|
||||
" IPython.notebook.execute_cell();\n",
|
||||
" return false;\n",
|
||||
"});"
|
||||
],
|
||||
"text/plain": [
|
||||
"<IPython.core.display.Javascript at 0x1019baf90>"
|
||||
]
|
||||
},
|
||||
"metadata": {},
|
||||
"outputs": [
|
||||
{
|
||||
"javascript": [
|
||||
"\n",
|
||||
"IPython.keyboard_manager.command_shortcuts.remove_shortcut('r');"
|
||||
],
|
||||
"metadata": {},
|
||||
"output_type": "display_data",
|
||||
"text": [
|
||||
"<IPython.core.display.Javascript at 0x10e8d1950>"
|
||||
]
|
||||
}
|
||||
],
|
||||
"prompt_number": 8
|
||||
},
|
||||
"output_type": "display_data"
|
||||
}
|
||||
],
|
||||
"source": [
|
||||
"%%javascript\n",
|
||||
"\n",
|
||||
"IPython.keyboard_manager.command_shortcuts.add_shortcut('r', function (event) {\n",
|
||||
" IPython.notebook.execute_cell();\n",
|
||||
" return false;\n",
|
||||
"});"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Likewise, to remove a shortcut, use `remove_shortcut`:"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": 8,
|
||||
"metadata": {
|
||||
"collapsed": false
|
||||
},
|
||||
"outputs": [
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"data": {
|
||||
"application/javascript": [
|
||||
"\n",
|
||||
"IPython.keyboard_manager.command_shortcuts.remove_shortcut('r');"
|
||||
],
|
||||
"text/plain": [
|
||||
"<IPython.core.display.Javascript at 0x10e8d1950>"
|
||||
]
|
||||
},
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"If you want your keyboard shortcuts to be active for all of your notebooks, put the above API calls into your `<profile>/static/custom/custom.js` file."
|
||||
]
|
||||
"output_type": "display_data"
|
||||
}
|
||||
],
|
||||
"metadata": {}
|
||||
"source": [
|
||||
"%%javascript\n",
|
||||
"\n",
|
||||
"IPython.keyboard_manager.command_shortcuts.remove_shortcut('r');"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"If you want your keyboard shortcuts to be active for all of your notebooks, put the above API calls into your `<profile>/static/custom/custom.js` file."
|
||||
]
|
||||
}
|
||||
]
|
||||
],
|
||||
"metadata": {},
|
||||
"nbformat": 4,
|
||||
"nbformat_minor": 0
|
||||
}
|
||||
File diff suppressed because it is too large
Load Diff
@ -1,85 +1,76 @@
|
||||
{
|
||||
"cells": [
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"<img src=\"../images/ipython_logo.png\">"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Back to the main [Index](../Index.ipynb)"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"# Notebook"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"The IPython Notebook is a web-based interactive computing system that enables users to author documents that include live code, narrative text, LaTeX equations, HTML, images and video. These documents contain a full record of a computation and its results and can be shared on email, [Dropbox](http://dropbox.com), version control systems (like git/[GitHub](http://github.com)) or [nbviewer.ipython.org](http://nbviewer.ipython.org)."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"## Tutorials"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"* [What is the IPython Notebook](What is the IPython Notebook.ipynb)\n",
|
||||
"* [Running the Notebook Server](Running the Notebook Server.ipynb)\n",
|
||||
"* [Notebook Basics](Notebook Basics.ipynb)\n",
|
||||
"* [Running Code](Running Code.ipynb)\n",
|
||||
"* [Working With Markdown Cells](Working With Markdown Cells.ipynb)\n",
|
||||
"* [Custom Keyboard Shortcuts](Custom Keyboard Shortcuts.ipynb)\n",
|
||||
"* [JavaScript Notebook Extensions](JavaScript Notebook Extensions.ipynb)\n",
|
||||
"* [Notebook Security](Notebook Security.ipynb)\n",
|
||||
"* [Converting Notebooks With nbconvert](Converting Notebooks With nbconvert.ipynb)\n",
|
||||
"* [Using nbconvert as a Library](Using nbconvert as a Library.ipynb)"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"## Examples"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"* [Importing Notebooks](Importing Notebooks.ipynb)\n",
|
||||
"* [Connecting with the Qt Console](Connecting with the Qt Console.ipynb)\n",
|
||||
"* [Typesetting Equations](Typesetting Equations.ipynb)"
|
||||
]
|
||||
}
|
||||
],
|
||||
"metadata": {
|
||||
"name": "",
|
||||
"signature": "sha256:5a3c5ebae9154e13957e7c9d28bd3b7697c4b14f965482feb288d2cdf078983e"
|
||||
},
|
||||
"nbformat": 3,
|
||||
"nbformat_minor": 0,
|
||||
"worksheets": [
|
||||
{
|
||||
"cells": [
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"<img src=\"../images/ipython_logo.png\">"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Back to the main [Index](../Index.ipynb)"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "heading",
|
||||
"level": 1,
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Notebook"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"The IPython Notebook is a web-based interactive computing system that enables users to author documents that include live code, narrative text, LaTeX equations, HTML, images and video. These documents contain a full record of a computation and its results and can be shared on email, [Dropbox](http://dropbox.com), version control systems (like git/[GitHub](http://github.com)) or [nbviewer.ipython.org](http://nbviewer.ipython.org)."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "heading",
|
||||
"level": 2,
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Tutorials"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"* [What is the IPython Notebook](What is the IPython Notebook.ipynb)\n",
|
||||
"* [Running the Notebook Server](Running the Notebook Server.ipynb)\n",
|
||||
"* [Notebook Basics](Notebook Basics.ipynb)\n",
|
||||
"* [Running Code](Running Code.ipynb)\n",
|
||||
"* [Working With Markdown Cells](Working With Markdown Cells.ipynb)\n",
|
||||
"* [Custom Keyboard Shortcuts](Custom Keyboard Shortcuts.ipynb)\n",
|
||||
"* [JavaScript Notebook Extensions](JavaScript Notebook Extensions.ipynb)\n",
|
||||
"* [Notebook Security](Notebook Security.ipynb)\n",
|
||||
"* [Converting Notebooks With nbconvert](Converting Notebooks With nbconvert.ipynb)\n",
|
||||
"* [Using nbconvert as a Library](Using nbconvert as a Library.ipynb)"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "heading",
|
||||
"level": 2,
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Examples"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"* [Importing Notebooks](Importing Notebooks.ipynb)\n",
|
||||
"* [Connecting with the Qt Console](Connecting with the Qt Console.ipynb)\n",
|
||||
"* [Typesetting Equations](Typesetting Equations.ipynb)"
|
||||
]
|
||||
}
|
||||
],
|
||||
"metadata": {}
|
||||
}
|
||||
]
|
||||
"nbformat": 4,
|
||||
"nbformat_minor": 0
|
||||
}
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -1,389 +1,363 @@
|
||||
{
|
||||
"metadata": {
|
||||
"name": "",
|
||||
"signature": "sha256:ee4b22b4c949fe21b3e5cda24f0916ba59d8c09443f4a897d98b96d4a73ac335"
|
||||
},
|
||||
"nbformat": 3,
|
||||
"nbformat_minor": 0,
|
||||
"worksheets": [
|
||||
"cells": [
|
||||
{
|
||||
"cells": [
|
||||
{
|
||||
"cell_type": "heading",
|
||||
"level": 1,
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Running the Notebook Server"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"The IPython notebook server is a custom web server that runs the notebook web application. Most of the time, users run the notebook server on their local computer using IPython's command line interface."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "heading",
|
||||
"level": 2,
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Starting the notebook server using the command line"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"You can start the notebook server from the command line (Terminal on Mac/Linux, CMD prompt on Windows) by running the following command: \n",
|
||||
"\n",
|
||||
" ipython notebook\n",
|
||||
"\n",
|
||||
"This will print some information about the notebook server in your terminal, including the URL of the web application (by default, `http://127.0.0.1:8888`). It will then open your default web browser to this URL.\n",
|
||||
"\n",
|
||||
"When the notebook opens, you will see the **notebook dashboard**, which will show a list of the notebooks and subdirectories in the directory where the notebook server was started. As of IPython 2.0, the dashboard allows you to navigate to different subdirectories. Because of this, it is no longer necessary to start a separate notebook server for each subdirectory. Most of the time, you will want to start a notebook server in the highest directory in your filesystem where notebooks can be found. Often this will be your home directory.\n",
|
||||
"\n",
|
||||
"You can start more than one notebook server at the same time. By default, the first notebook server starts on port 8888 and later notebook servers search for open ports near that one.\n",
|
||||
"\n",
|
||||
"You can also specify the port manually:\n",
|
||||
"\n",
|
||||
" ipython notebook --port 9999\n",
|
||||
"\n",
|
||||
"Or start notebook server without opening a web browser.\n",
|
||||
"\n",
|
||||
" ipython notebook --no-browser\n",
|
||||
"\n",
|
||||
"The notebook server has a number of other command line arguments that can be displayed with the `--help` flag: \n",
|
||||
"\n",
|
||||
" ipython notebook --help\n",
|
||||
"\n",
|
||||
"<div class=\"alert alert-failure\">\n",
|
||||
"It used to be possible to specify kernel options, such as <code>--pylab inline</code> from the command line. This is deprecated in IPython 2.0 and will be removed in IPython 3.0. To enable matplotlib based plotting for the Python kernel use the <code>%matplotlib</code> magic command.\n",
|
||||
"</div>\n",
|
||||
"\n"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "heading",
|
||||
"level": 2,
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Configuring the IPython Notebook"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"The notebook web server can also be configured using IPython profiles and configuration files. The Notebook web server configuration options are set in a file named `ipython_notebook_config.py` in your IPython *profile directory*. The profile directory is a subfolder of your IPython directory, which itself is usually `.ipython` in your home directory.\n",
|
||||
"\n",
|
||||
"You can display the location of your default profile directory by running the command:"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"collapsed": false,
|
||||
"input": [
|
||||
"!ipython profile locate default"
|
||||
],
|
||||
"language": "python",
|
||||
"metadata": {},
|
||||
"outputs": [
|
||||
{
|
||||
"output_type": "stream",
|
||||
"stream": "stdout",
|
||||
"text": [
|
||||
"/Users/bgranger/.ipython/profile_default\r\n"
|
||||
]
|
||||
}
|
||||
],
|
||||
"prompt_number": 7
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"The default version of `ipython_notebook_config.py` lists all of the options available along with documentation for each. Changes made to that file will affect all notebook servers run under that profile. Command line options always override those set in configuration files.\n",
|
||||
"\n",
|
||||
"You can create a new profile:"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"collapsed": false,
|
||||
"input": [
|
||||
"!ipython profile create my_profile"
|
||||
],
|
||||
"language": "python",
|
||||
"metadata": {},
|
||||
"outputs": [
|
||||
{
|
||||
"output_type": "stream",
|
||||
"stream": "stdout",
|
||||
"text": [
|
||||
"[ProfileCreate] Generating default config file: u'/Users/bgranger/.ipython/profile_my_profile/ipython_config.py'\r\n"
|
||||
]
|
||||
},
|
||||
{
|
||||
"output_type": "stream",
|
||||
"stream": "stdout",
|
||||
"text": [
|
||||
"[ProfileCreate] Generating default config file: u'/Users/bgranger/.ipython/profile_my_profile/ipython_qtconsole_config.py'\r\n"
|
||||
]
|
||||
},
|
||||
{
|
||||
"output_type": "stream",
|
||||
"stream": "stdout",
|
||||
"text": [
|
||||
"[ProfileCreate] Generating default config file: u'/Users/bgranger/.ipython/profile_my_profile/ipython_notebook_config.py'\r\n",
|
||||
"[ProfileCreate] Generating default config file: u'/Users/bgranger/.ipython/profile_my_profile/ipython_nbconvert_config.py'\r\n"
|
||||
]
|
||||
}
|
||||
],
|
||||
"prompt_number": 3
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"And then view its location:"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"collapsed": false,
|
||||
"input": [
|
||||
"!ipython profile locate my_profile"
|
||||
],
|
||||
"language": "python",
|
||||
"metadata": {},
|
||||
"outputs": [
|
||||
{
|
||||
"output_type": "stream",
|
||||
"stream": "stdout",
|
||||
"text": [
|
||||
"/Users/bgranger/.ipython/profile_my_profile\r\n"
|
||||
]
|
||||
}
|
||||
],
|
||||
"prompt_number": 5
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"To start the notebook server using a given profile, run the following:\n",
|
||||
"\n",
|
||||
" ipython notebook --profile=my_profile"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"More details about IPython configuration files and profiles can be found [here](http://ipython.org/ipython-doc/dev/config/intro.html)."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "heading",
|
||||
"level": 2,
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Securing the notebook server"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"The IPython Notebook allows arbitrary code execution on the computer running it. Thus, the notebook web server should never be run on the open internet without first securing it. By default, the notebook server only listens on local network interface (`127.0.0.1`) There are two steps required to secure the notebook server:\n",
|
||||
"\n",
|
||||
"1. Setting a password\n",
|
||||
"2. Encrypt network traffic using SSL"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "heading",
|
||||
"level": 3,
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Setting a password"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"You can protect your notebook server with a simple single password by setting the `NotebookApp.password` configurable. You can prepare a hashed password using the function `IPython.lib.passwd`:"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"collapsed": false,
|
||||
"input": [
|
||||
"from IPython.lib import passwd\n",
|
||||
"password = passwd(\"secret\")\n",
|
||||
"password"
|
||||
],
|
||||
"language": "python",
|
||||
"metadata": {},
|
||||
"outputs": [
|
||||
{
|
||||
"metadata": {},
|
||||
"output_type": "pyout",
|
||||
"prompt_number": 1,
|
||||
"text": [
|
||||
"'sha1:6c2164fc2b22:ed55ecf07fc0f985ab46561483c0e888e8964ae6'"
|
||||
]
|
||||
}
|
||||
],
|
||||
"prompt_number": 1
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"You can then add this to your `ipython_notebook_config.py`:\n",
|
||||
"\n",
|
||||
"```python\n",
|
||||
"# Password to use for web authentication\n",
|
||||
"c = get_config()\n",
|
||||
"c.NotebookApp.password = \n",
|
||||
"u'sha1:6c2164fc2b22:ed55ecf07fc0f985ab46561483c0e888e8964ae6'\n",
|
||||
"```"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "heading",
|
||||
"level": 3,
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Using SSL/HTTPS"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"When using a password, it is a good idea to also use SSL, so that your \n",
|
||||
"password is not sent unencrypted by your browser to the web server. When running the notebook on the public internet this is absolutely required.\n",
|
||||
"\n",
|
||||
"The first step is to generate an SSL certificate. A self-signed certificate can be generated with ``openssl``. For example, the following command will create a certificate valid for 365 days with both the key and certificate data written to the same file:\n",
|
||||
"\n",
|
||||
" openssl req -x509 -nodes -days 365 -newkey rsa:1024 -keyout mycert.pem -out mycert.pem\n",
|
||||
"\n",
|
||||
"In most cases, you should run this command in your profile directory, which will make it easy to use the generated key and certificate.\n",
|
||||
"\n",
|
||||
"When you connect to a notebook server over HTTPS using a self-signed certificate, your browser will warn you of a dangerous certificate because it is self-signed. If you want to have a fully compliant certificate that will not raise warnings, it is possible (but rather involved) to obtain one,\n",
|
||||
"as explained in detail in [this tutorial](http://arstechnica.com/security/news/2009/12/how-to-get-set-with-a-secure-sertificate-for-free.ars)\n",
|
||||
"\t\n",
|
||||
"When you enable SSL support, you will need to access the notebook server over ``https://``, rather than plain ``http://``. The startup message from the notebook server prints the correct URL, but it is easy to overlook and think the server is for some reason non-responsive.\n",
|
||||
"\n",
|
||||
"Once you have generated the key and certificate, you can configure the notebook server to use them, by adding the following to `ipython_notebook_config.py`:\n",
|
||||
"\n",
|
||||
"```python\n",
|
||||
"# The full path to an SSL/TLS certificate file.\n",
|
||||
"c.NotebookApp.certfile = u'/Users/bgranger/.ipython/profile_my_profile/mycert.crt'\n",
|
||||
"\n",
|
||||
"# The full path to a private key file for usage with SSL/TLS.\n",
|
||||
"c.NotebookApp.keyfile = u'/Users/bgranger/.ipython/profile_my_profile/mycert.key'\n",
|
||||
"```"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "heading",
|
||||
"level": 2,
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Running a public notebook server"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"<div class=\"alert alert-error\">\n",
|
||||
"Don't run a public notebook server unless you first secure it with a password and SSL/HTTPS as described above\n",
|
||||
"</div>\n",
|
||||
"\n",
|
||||
"By default the notebook server only listens on the `localhost/127.0.0.1` network interface. If you want to connect to the notebook from another computers, or over the internet, you need to configure the notebook server to listen on all network interfaces and not open the browser. You will often also want to disable the automatic launching of the web browser.\n",
|
||||
"\n",
|
||||
"This can be accomplished by passing a command line options.\n",
|
||||
"\n",
|
||||
" ipython notebook --ip=* --no-browser\n",
|
||||
"\n",
|
||||
"You can also add the following to your`ipython_notebook_config.py` file:\n",
|
||||
"\n",
|
||||
"```python\n",
|
||||
"c.NotebookApp.ip = '*'\n",
|
||||
"c.NotebookApp.open_browser = False\n",
|
||||
"```"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "heading",
|
||||
"level": 2,
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Running with a different URL prefix"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"The notebook dashboard typically lives at the URL `http://localhost:8888/tree`. If you prefer that it lives, together with the \n",
|
||||
"rest of the notebook web application, under a base URL prefix, such as `http://localhost:8888/ipython/tree`, you can do so by adding the following lines to your `ipython_notebook_config.py` file.\n",
|
||||
"\n",
|
||||
"```python\n",
|
||||
"c.NotebookApp.base_url = '/ipython/'\n",
|
||||
"c.NotebookApp.webapp_settings = {'static_url_prefix':'/ipython/static/'}\n",
|
||||
"```"
|
||||
]
|
||||
},
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"# Running the Notebook Server"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"The IPython notebook server is a custom web server that runs the notebook web application. Most of the time, users run the notebook server on their local computer using IPython's command line interface."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"## Starting the notebook server using the command line"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"You can start the notebook server from the command line (Terminal on Mac/Linux, CMD prompt on Windows) by running the following command: \n",
|
||||
"\n",
|
||||
" ipython notebook\n",
|
||||
"\n",
|
||||
"This will print some information about the notebook server in your terminal, including the URL of the web application (by default, `http://127.0.0.1:8888`). It will then open your default web browser to this URL.\n",
|
||||
"\n",
|
||||
"When the notebook opens, you will see the **notebook dashboard**, which will show a list of the notebooks and subdirectories in the directory where the notebook server was started. As of IPython 2.0, the dashboard allows you to navigate to different subdirectories. Because of this, it is no longer necessary to start a separate notebook server for each subdirectory. Most of the time, you will want to start a notebook server in the highest directory in your filesystem where notebooks can be found. Often this will be your home directory.\n",
|
||||
"\n",
|
||||
"You can start more than one notebook server at the same time. By default, the first notebook server starts on port 8888 and later notebook servers search for open ports near that one.\n",
|
||||
"\n",
|
||||
"You can also specify the port manually:\n",
|
||||
"\n",
|
||||
" ipython notebook --port 9999\n",
|
||||
"\n",
|
||||
"Or start notebook server without opening a web browser.\n",
|
||||
"\n",
|
||||
" ipython notebook --no-browser\n",
|
||||
"\n",
|
||||
"The notebook server has a number of other command line arguments that can be displayed with the `--help` flag: \n",
|
||||
"\n",
|
||||
" ipython notebook --help\n",
|
||||
"\n",
|
||||
"<div class=\"alert alert-failure\">\n",
|
||||
"It used to be possible to specify kernel options, such as <code>--pylab inline</code> from the command line. This is deprecated in IPython 2.0 and will be removed in IPython 3.0. To enable matplotlib based plotting for the Python kernel use the <code>%matplotlib</code> magic command.\n",
|
||||
"</div>\n",
|
||||
"\n"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"## Configuring the IPython Notebook"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"The notebook web server can also be configured using IPython profiles and configuration files. The Notebook web server configuration options are set in a file named `ipython_notebook_config.py` in your IPython *profile directory*. The profile directory is a subfolder of your IPython directory, which itself is usually `.ipython` in your home directory.\n",
|
||||
"\n",
|
||||
"You can display the location of your default profile directory by running the command:"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": 7,
|
||||
"metadata": {
|
||||
"collapsed": false
|
||||
},
|
||||
"outputs": [
|
||||
{
|
||||
"cell_type": "heading",
|
||||
"level": 2,
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Using a different notebook store"
|
||||
"name": "stdout",
|
||||
"output_type": "stream",
|
||||
"text": [
|
||||
"/Users/bgranger/.ipython/profile_default\r\n"
|
||||
]
|
||||
},
|
||||
}
|
||||
],
|
||||
"source": [
|
||||
"!ipython profile locate default"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"The default version of `ipython_notebook_config.py` lists all of the options available along with documentation for each. Changes made to that file will affect all notebook servers run under that profile. Command line options always override those set in configuration files.\n",
|
||||
"\n",
|
||||
"You can create a new profile:"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": 3,
|
||||
"metadata": {
|
||||
"collapsed": false
|
||||
},
|
||||
"outputs": [
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"By default, the notebook server stores the notebook documents that it saves as files in the working directory of the notebook server, also known as the\n",
|
||||
"`notebook_dir`. This logic is implemented in the `FileNotebookManager` class. However, the server can be configured to use a different notebook manager class, which can store the notebooks in a different format. \n",
|
||||
"\n",
|
||||
"The [bookstore](https://github.com/rgbkrk/bookstore) package currently allows users to store notebooks on Rackspace CloudFiles or OpenStack Swift based object stores.\n",
|
||||
"\n",
|
||||
"Writing a notebook manager is as simple as extending the base class `NotebookManager`. The [simple_notebook_manager](https://github.com/khinsen/simple_notebook_manager) provides a great example\n",
|
||||
"of an in memory notebook manager, created solely for the purpose of\n",
|
||||
"illustrating the notebook manager API."
|
||||
"name": "stdout",
|
||||
"output_type": "stream",
|
||||
"text": [
|
||||
"[ProfileCreate] Generating default config file: u'/Users/bgranger/.ipython/profile_my_profile/ipython_config.py'\r\n",
|
||||
"[ProfileCreate] Generating default config file: u'/Users/bgranger/.ipython/profile_my_profile/ipython_qtconsole_config.py'\r\n",
|
||||
"[ProfileCreate] Generating default config file: u'/Users/bgranger/.ipython/profile_my_profile/ipython_notebook_config.py'\r\n",
|
||||
"[ProfileCreate] Generating default config file: u'/Users/bgranger/.ipython/profile_my_profile/ipython_nbconvert_config.py'\r\n"
|
||||
]
|
||||
},
|
||||
}
|
||||
],
|
||||
"source": [
|
||||
"!ipython profile create my_profile"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"And then view its location:"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": 5,
|
||||
"metadata": {
|
||||
"collapsed": false
|
||||
},
|
||||
"outputs": [
|
||||
{
|
||||
"cell_type": "heading",
|
||||
"level": 2,
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Known issues"
|
||||
"name": "stdout",
|
||||
"output_type": "stream",
|
||||
"text": [
|
||||
"/Users/bgranger/.ipython/profile_my_profile\r\n"
|
||||
]
|
||||
},
|
||||
}
|
||||
],
|
||||
"source": [
|
||||
"!ipython profile locate my_profile"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"To start the notebook server using a given profile, run the following:\n",
|
||||
"\n",
|
||||
" ipython notebook --profile=my_profile"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"More details about IPython configuration files and profiles can be found [here](http://ipython.org/ipython-doc/dev/config/intro.html)."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"## Securing the notebook server"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"The IPython Notebook allows arbitrary code execution on the computer running it. Thus, the notebook web server should never be run on the open internet without first securing it. By default, the notebook server only listens on local network interface (`127.0.0.1`) There are two steps required to secure the notebook server:\n",
|
||||
"\n",
|
||||
"1. Setting a password\n",
|
||||
"2. Encrypt network traffic using SSL"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"### Setting a password"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"You can protect your notebook server with a simple single password by setting the `NotebookApp.password` configurable. You can prepare a hashed password using the function `IPython.lib.passwd`:"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": 1,
|
||||
"metadata": {
|
||||
"collapsed": false
|
||||
},
|
||||
"outputs": [
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"data": {
|
||||
"text/plain": [
|
||||
"'sha1:6c2164fc2b22:ed55ecf07fc0f985ab46561483c0e888e8964ae6'"
|
||||
]
|
||||
},
|
||||
"execution_count": 1,
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"When behind a proxy, especially if your system or browser is set to autodetect the proxy, the notebook web application might fail to connect to the server's websockets, and present you with a warning at startup. In this case, you need to configure your system not to use the proxy for the server's address.\n",
|
||||
"\n",
|
||||
"For example, in Firefox, go to the Preferences panel, Advanced section,\n",
|
||||
"Network tab, click 'Settings...', and add the address of the notebook server\n",
|
||||
"to the 'No proxy for' field."
|
||||
]
|
||||
"output_type": "execute_result"
|
||||
}
|
||||
],
|
||||
"metadata": {}
|
||||
"source": [
|
||||
"from IPython.lib import passwd\n",
|
||||
"password = passwd(\"secret\")\n",
|
||||
"password"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"You can then add this to your `ipython_notebook_config.py`:\n",
|
||||
"\n",
|
||||
"```python\n",
|
||||
"# Password to use for web authentication\n",
|
||||
"c = get_config()\n",
|
||||
"c.NotebookApp.password = \n",
|
||||
"u'sha1:6c2164fc2b22:ed55ecf07fc0f985ab46561483c0e888e8964ae6'\n",
|
||||
"```"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"### Using SSL/HTTPS"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"When using a password, it is a good idea to also use SSL, so that your \n",
|
||||
"password is not sent unencrypted by your browser to the web server. When running the notebook on the public internet this is absolutely required.\n",
|
||||
"\n",
|
||||
"The first step is to generate an SSL certificate. A self-signed certificate can be generated with ``openssl``. For example, the following command will create a certificate valid for 365 days with both the key and certificate data written to the same file:\n",
|
||||
"\n",
|
||||
" openssl req -x509 -nodes -days 365 -newkey rsa:1024 -keyout mycert.pem -out mycert.pem\n",
|
||||
"\n",
|
||||
"In most cases, you should run this command in your profile directory, which will make it easy to use the generated key and certificate.\n",
|
||||
"\n",
|
||||
"When you connect to a notebook server over HTTPS using a self-signed certificate, your browser will warn you of a dangerous certificate because it is self-signed. If you want to have a fully compliant certificate that will not raise warnings, it is possible (but rather involved) to obtain one,\n",
|
||||
"as explained in detail in [this tutorial](http://arstechnica.com/security/news/2009/12/how-to-get-set-with-a-secure-sertificate-for-free.ars)\n",
|
||||
"\t\n",
|
||||
"When you enable SSL support, you will need to access the notebook server over ``https://``, rather than plain ``http://``. The startup message from the notebook server prints the correct URL, but it is easy to overlook and think the server is for some reason non-responsive.\n",
|
||||
"\n",
|
||||
"Once you have generated the key and certificate, you can configure the notebook server to use them, by adding the following to `ipython_notebook_config.py`:\n",
|
||||
"\n",
|
||||
"```python\n",
|
||||
"# The full path to an SSL/TLS certificate file.\n",
|
||||
"c.NotebookApp.certfile = u'/Users/bgranger/.ipython/profile_my_profile/mycert.crt'\n",
|
||||
"\n",
|
||||
"# The full path to a private key file for usage with SSL/TLS.\n",
|
||||
"c.NotebookApp.keyfile = u'/Users/bgranger/.ipython/profile_my_profile/mycert.key'\n",
|
||||
"```"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"## Running a public notebook server"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"<div class=\"alert alert-error\">\n",
|
||||
"Don't run a public notebook server unless you first secure it with a password and SSL/HTTPS as described above\n",
|
||||
"</div>\n",
|
||||
"\n",
|
||||
"By default the notebook server only listens on the `localhost/127.0.0.1` network interface. If you want to connect to the notebook from another computers, or over the internet, you need to configure the notebook server to listen on all network interfaces and not open the browser. You will often also want to disable the automatic launching of the web browser.\n",
|
||||
"\n",
|
||||
"This can be accomplished by passing a command line options.\n",
|
||||
"\n",
|
||||
" ipython notebook --ip=* --no-browser\n",
|
||||
"\n",
|
||||
"You can also add the following to your`ipython_notebook_config.py` file:\n",
|
||||
"\n",
|
||||
"```python\n",
|
||||
"c.NotebookApp.ip = '*'\n",
|
||||
"c.NotebookApp.open_browser = False\n",
|
||||
"```"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"## Running with a different URL prefix"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"The notebook dashboard typically lives at the URL `http://localhost:8888/tree`. If you prefer that it lives, together with the \n",
|
||||
"rest of the notebook web application, under a base URL prefix, such as `http://localhost:8888/ipython/tree`, you can do so by adding the following lines to your `ipython_notebook_config.py` file.\n",
|
||||
"\n",
|
||||
"```python\n",
|
||||
"c.NotebookApp.base_url = '/ipython/'\n",
|
||||
"c.NotebookApp.webapp_settings = {'static_url_prefix':'/ipython/static/'}\n",
|
||||
"```"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"## Using a different notebook store"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"By default, the notebook server stores the notebook documents that it saves as files in the working directory of the notebook server, also known as the\n",
|
||||
"`notebook_dir`. This logic is implemented in the `FileNotebookManager` class. However, the server can be configured to use a different notebook manager class, which can store the notebooks in a different format. \n",
|
||||
"\n",
|
||||
"The [bookstore](https://github.com/rgbkrk/bookstore) package currently allows users to store notebooks on Rackspace CloudFiles or OpenStack Swift based object stores.\n",
|
||||
"\n",
|
||||
"Writing a notebook manager is as simple as extending the base class `NotebookManager`. The [simple_notebook_manager](https://github.com/khinsen/simple_notebook_manager) provides a great example\n",
|
||||
"of an in memory notebook manager, created solely for the purpose of\n",
|
||||
"illustrating the notebook manager API."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"## Known issues"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"When behind a proxy, especially if your system or browser is set to autodetect the proxy, the notebook web application might fail to connect to the server's websockets, and present you with a warning at startup. In this case, you need to configure your system not to use the proxy for the server's address.\n",
|
||||
"\n",
|
||||
"For example, in Firefox, go to the Preferences panel, Advanced section,\n",
|
||||
"Network tab, click 'Settings...', and add the address of the notebook server\n",
|
||||
"to the 'No proxy for' field."
|
||||
]
|
||||
}
|
||||
]
|
||||
],
|
||||
"metadata": {
|
||||
"signature": "sha256:ee4b22b4c949fe21b3e5cda24f0916ba59d8c09443f4a897d98b96d4a73ac335"
|
||||
},
|
||||
"nbformat": 4,
|
||||
"nbformat_minor": 0
|
||||
}
|
||||
@ -1,260 +1,253 @@
|
||||
{
|
||||
"metadata": {
|
||||
"name": ""
|
||||
},
|
||||
"nbformat": 3,
|
||||
"nbformat_minor": 0,
|
||||
"worksheets": [
|
||||
"cells": [
|
||||
{
|
||||
"cells": [
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"The Markdown parser included in IPython is MathJax-aware. This means that you can freely mix in mathematical expressions using the [MathJax subset of Tex and LaTeX](http://docs.mathjax.org/en/latest/tex.html#tex-support). [Some examples from the MathJax site](http://www.mathjax.org/demos/tex-samples/) are reproduced below, as well as the Markdown+TeX source."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"# Motivating Examples\n",
|
||||
"\n",
|
||||
"---\n",
|
||||
"\n",
|
||||
"## The Lorenz Equations\n",
|
||||
"### Source\n",
|
||||
"```\\begin{align}\n",
|
||||
"\\dot{x} & = \\sigma(y-x) \\\\\n",
|
||||
"\\dot{y} & = \\rho x - y - xz \\\\\n",
|
||||
"\\dot{z} & = -\\beta z + xy\n",
|
||||
"\\end{align}\n",
|
||||
"```\n",
|
||||
"### Display\n",
|
||||
"\\begin{align}\n",
|
||||
"\\dot{x} & = \\sigma(y-x) \\\\\n",
|
||||
"\\dot{y} & = \\rho x - y - xz \\\\\n",
|
||||
"\\dot{z} & = -\\beta z + xy\n",
|
||||
"\\end{align}"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"## The Cauchy-Schwarz Inequality\n",
|
||||
"### Source\n",
|
||||
"```\\begin{equation*}\n",
|
||||
"\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)\n",
|
||||
"\\end{equation*}\n",
|
||||
"```\n",
|
||||
"### Display\n",
|
||||
"\\begin{equation*}\n",
|
||||
"\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)\n",
|
||||
"\\end{equation*}"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"## A Cross Product Formula\n",
|
||||
"### Source\n",
|
||||
"```\\begin{equation*}\n",
|
||||
"\\mathbf{V}_1 \\times \\mathbf{V}_2 = \\begin{vmatrix}\n",
|
||||
"\\mathbf{i} & \\mathbf{j} & \\mathbf{k} \\\\\n",
|
||||
"\\frac{\\partial X}{\\partial u} & \\frac{\\partial Y}{\\partial u} & 0 \\\\\n",
|
||||
"\\frac{\\partial X}{\\partial v} & \\frac{\\partial Y}{\\partial v} & 0\n",
|
||||
"\\end{vmatrix} \n",
|
||||
"\\end{equation*}\n",
|
||||
"```\n",
|
||||
"### Display\n",
|
||||
"\\begin{equation*}\n",
|
||||
"\\mathbf{V}_1 \\times \\mathbf{V}_2 = \\begin{vmatrix}\n",
|
||||
"\\mathbf{i} & \\mathbf{j} & \\mathbf{k} \\\\\n",
|
||||
"\\frac{\\partial X}{\\partial u} & \\frac{\\partial Y}{\\partial u} & 0 \\\\\n",
|
||||
"\\frac{\\partial X}{\\partial v} & \\frac{\\partial Y}{\\partial v} & 0\n",
|
||||
"\\end{vmatrix} \n",
|
||||
"\\end{equation*}"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"## The probability of getting \\(k\\) heads when flipping \\(n\\) coins is\n",
|
||||
"### Source\n",
|
||||
"```\\begin{equation*}\n",
|
||||
"P(E) = {n \\choose k} p^k (1-p)^{ n-k} \n",
|
||||
"\\end{equation*}\n",
|
||||
"```\n",
|
||||
"### Display\n",
|
||||
"\\begin{equation*}\n",
|
||||
"P(E) = {n \\choose k} p^k (1-p)^{ n-k} \n",
|
||||
"\\end{equation*}"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"## An Identity of Ramanujan\n",
|
||||
"### Source\n",
|
||||
"```\\begin{equation*}\n",
|
||||
"\\frac{1}{\\Bigl(\\sqrt{\\phi \\sqrt{5}}-\\phi\\Bigr) e^{\\frac25 \\pi}} =\n",
|
||||
"1+\\frac{e^{-2\\pi}} {1+\\frac{e^{-4\\pi}} {1+\\frac{e^{-6\\pi}}\n",
|
||||
"{1+\\frac{e^{-8\\pi}} {1+\\ldots} } } } \n",
|
||||
"\\end{equation*}\n",
|
||||
"```\n",
|
||||
"### Display\n",
|
||||
"\\begin{equation*}\n",
|
||||
"\\frac{1}{\\Bigl(\\sqrt{\\phi \\sqrt{5}}-\\phi\\Bigr) e^{\\frac25 \\pi}} =\n",
|
||||
"1+\\frac{e^{-2\\pi}} {1+\\frac{e^{-4\\pi}} {1+\\frac{e^{-6\\pi}}\n",
|
||||
"{1+\\frac{e^{-8\\pi}} {1+\\ldots} } } } \n",
|
||||
"\\end{equation*}"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"## A Rogers-Ramanujan Identity\n",
|
||||
"### Source\n",
|
||||
"```\\begin{equation*}\n",
|
||||
"1 + \\frac{q^2}{(1-q)}+\\frac{q^6}{(1-q)(1-q^2)}+\\cdots =\n",
|
||||
"\\prod_{j=0}^{\\infty}\\frac{1}{(1-q^{5j+2})(1-q^{5j+3})},\n",
|
||||
"\\quad\\quad \\text{for $|q|<1$}. \n",
|
||||
"\\end{equation*}\n",
|
||||
"```\n",
|
||||
"### Display\n",
|
||||
"\\begin{equation*}\n",
|
||||
"1 + \\frac{q^2}{(1-q)}+\\frac{q^6}{(1-q)(1-q^2)}+\\cdots =\n",
|
||||
"\\prod_{j=0}^{\\infty}\\frac{1}{(1-q^{5j+2})(1-q^{5j+3})},\n",
|
||||
"\\quad\\quad \\text{for $|q|<1$}. \n",
|
||||
"\\end{equation*}"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"## Maxwell's Equations\n",
|
||||
"### Source\n",
|
||||
"```\\begin{align}\n",
|
||||
"\\nabla \\times \\vec{\\mathbf{B}} -\\, \\frac1c\\, \\frac{\\partial\\vec{\\mathbf{E}}}{\\partial t} & = \\frac{4\\pi}{c}\\vec{\\mathbf{j}} \\\\ \\nabla \\cdot \\vec{\\mathbf{E}} & = 4 \\pi \\rho \\\\\n",
|
||||
"\\nabla \\times \\vec{\\mathbf{E}}\\, +\\, \\frac1c\\, \\frac{\\partial\\vec{\\mathbf{B}}}{\\partial t} & = \\vec{\\mathbf{0}} \\\\\n",
|
||||
"\\nabla \\cdot \\vec{\\mathbf{B}} & = 0 \n",
|
||||
"\\end{align}\n",
|
||||
"```\n",
|
||||
"### Display\n",
|
||||
"\\begin{align}\n",
|
||||
"\\nabla \\times \\vec{\\mathbf{B}} -\\, \\frac1c\\, \\frac{\\partial\\vec{\\mathbf{E}}}{\\partial t} & = \\frac{4\\pi}{c}\\vec{\\mathbf{j}} \\\\ \\nabla \\cdot \\vec{\\mathbf{E}} & = 4 \\pi \\rho \\\\\n",
|
||||
"\\nabla \\times \\vec{\\mathbf{E}}\\, +\\, \\frac1c\\, \\frac{\\partial\\vec{\\mathbf{B}}}{\\partial t} & = \\vec{\\mathbf{0}} \\\\\n",
|
||||
"\\nabla \\cdot \\vec{\\mathbf{B}} & = 0 \n",
|
||||
"\\end{align}"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"# Equation Numbering and References\n",
|
||||
"\n",
|
||||
"---\n",
|
||||
"\n",
|
||||
"Equation numbering and referencing will be available in a future version of IPython."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"# Inline Typesetting (Mixing Markdown and TeX)\n",
|
||||
"\n",
|
||||
"---\n",
|
||||
"\n",
|
||||
"While display equations look good for a page of samples, the ability to mix math and *formatted* **text** in a paragraph is also important.\n",
|
||||
"\n",
|
||||
"## Source\n",
|
||||
"``` This expression $\\sqrt{3x-1}+(1+x)^2$ is an example of a TeX inline equation in a **[Markdown-formatted](http://daringfireball.net/projects/markdown/)** sentence. \n",
|
||||
"```\n",
|
||||
"## Display\n",
|
||||
"This expression $\\sqrt{3x-1}+(1+x)^2$ is an example of a TeX inline equation in a **[Markdown-formatted](http://daringfireball.net/projects/markdown/)** sentence. "
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"# Other Syntax\n",
|
||||
"\n",
|
||||
"---\n",
|
||||
"\n",
|
||||
"You will notice in other places on the web that `$$` are needed explicitly to begin and end MathJax typesetting. This is **not** required if you will be using TeX environments, but the IPython notebook will accept this syntax on legacy notebooks. \n",
|
||||
"\n",
|
||||
"### Source\n",
|
||||
"```\n",
|
||||
"$$\n",
|
||||
"\\begin{array}{c}\n",
|
||||
"y_1 \\\\\\\n",
|
||||
"y_2 \\mathtt{t}_i \\\\\\\n",
|
||||
"z_{3,4}\n",
|
||||
"\\end{array}\n",
|
||||
"$$\n",
|
||||
"```\n",
|
||||
"\n",
|
||||
"```\n",
|
||||
"$$\n",
|
||||
"\\begin{array}{c}\n",
|
||||
"y_1 \\cr\n",
|
||||
"y_2 \\mathtt{t}_i \\cr\n",
|
||||
"y_{3}\n",
|
||||
"\\end{array}\n",
|
||||
"$$\n",
|
||||
"```\n",
|
||||
"\n",
|
||||
"```\n",
|
||||
"$$\\begin{eqnarray} \n",
|
||||
"x' &=& &x \\sin\\phi &+& z \\cos\\phi \\\\\n",
|
||||
"z' &=& - &x \\cos\\phi &+& z \\sin\\phi \\\\\n",
|
||||
"\\end{eqnarray}$$\n",
|
||||
"```\n",
|
||||
"\n",
|
||||
"```\n",
|
||||
"$$\n",
|
||||
"x=4\n",
|
||||
"$$\n",
|
||||
"```\n",
|
||||
"\n",
|
||||
"### Display\n",
|
||||
"$$\n",
|
||||
"\\begin{array}{c}\n",
|
||||
"y_1 \\\\\\\n",
|
||||
"y_2 \\mathtt{t}_i \\\\\\\n",
|
||||
"z_{3,4}\n",
|
||||
"\\end{array}\n",
|
||||
"$$\n",
|
||||
"\n",
|
||||
"$$\n",
|
||||
"\\begin{array}{c}\n",
|
||||
"y_1 \\cr\n",
|
||||
"y_2 \\mathtt{t}_i \\cr\n",
|
||||
"y_{3}\n",
|
||||
"\\end{array}\n",
|
||||
"$$\n",
|
||||
"\n",
|
||||
"$$\\begin{eqnarray} \n",
|
||||
"x' &=& &x \\sin\\phi &+& z \\cos\\phi \\\\\n",
|
||||
"z' &=& - &x \\cos\\phi &+& z \\sin\\phi \\\\\n",
|
||||
"\\end{eqnarray}$$\n",
|
||||
"\n",
|
||||
"$$\n",
|
||||
"x=4\n",
|
||||
"$$"
|
||||
]
|
||||
}
|
||||
],
|
||||
"metadata": {}
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"The Markdown parser included in IPython is MathJax-aware. This means that you can freely mix in mathematical expressions using the [MathJax subset of Tex and LaTeX](http://docs.mathjax.org/en/latest/tex.html#tex-support). [Some examples from the MathJax site](http://www.mathjax.org/demos/tex-samples/) are reproduced below, as well as the Markdown+TeX source."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"# Motivating Examples\n",
|
||||
"\n",
|
||||
"---\n",
|
||||
"\n",
|
||||
"## The Lorenz Equations\n",
|
||||
"### Source\n",
|
||||
"```\\begin{align}\n",
|
||||
"\\dot{x} & = \\sigma(y-x) \\\\\n",
|
||||
"\\dot{y} & = \\rho x - y - xz \\\\\n",
|
||||
"\\dot{z} & = -\\beta z + xy\n",
|
||||
"\\end{align}\n",
|
||||
"```\n",
|
||||
"### Display\n",
|
||||
"\\begin{align}\n",
|
||||
"\\dot{x} & = \\sigma(y-x) \\\\\n",
|
||||
"\\dot{y} & = \\rho x - y - xz \\\\\n",
|
||||
"\\dot{z} & = -\\beta z + xy\n",
|
||||
"\\end{align}"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"## The Cauchy-Schwarz Inequality\n",
|
||||
"### Source\n",
|
||||
"```\\begin{equation*}\n",
|
||||
"\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)\n",
|
||||
"\\end{equation*}\n",
|
||||
"```\n",
|
||||
"### Display\n",
|
||||
"\\begin{equation*}\n",
|
||||
"\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)\n",
|
||||
"\\end{equation*}"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"## A Cross Product Formula\n",
|
||||
"### Source\n",
|
||||
"```\\begin{equation*}\n",
|
||||
"\\mathbf{V}_1 \\times \\mathbf{V}_2 = \\begin{vmatrix}\n",
|
||||
"\\mathbf{i} & \\mathbf{j} & \\mathbf{k} \\\\\n",
|
||||
"\\frac{\\partial X}{\\partial u} & \\frac{\\partial Y}{\\partial u} & 0 \\\\\n",
|
||||
"\\frac{\\partial X}{\\partial v} & \\frac{\\partial Y}{\\partial v} & 0\n",
|
||||
"\\end{vmatrix} \n",
|
||||
"\\end{equation*}\n",
|
||||
"```\n",
|
||||
"### Display\n",
|
||||
"\\begin{equation*}\n",
|
||||
"\\mathbf{V}_1 \\times \\mathbf{V}_2 = \\begin{vmatrix}\n",
|
||||
"\\mathbf{i} & \\mathbf{j} & \\mathbf{k} \\\\\n",
|
||||
"\\frac{\\partial X}{\\partial u} & \\frac{\\partial Y}{\\partial u} & 0 \\\\\n",
|
||||
"\\frac{\\partial X}{\\partial v} & \\frac{\\partial Y}{\\partial v} & 0\n",
|
||||
"\\end{vmatrix} \n",
|
||||
"\\end{equation*}"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"## The probability of getting \\(k\\) heads when flipping \\(n\\) coins is\n",
|
||||
"### Source\n",
|
||||
"```\\begin{equation*}\n",
|
||||
"P(E) = {n \\choose k} p^k (1-p)^{ n-k} \n",
|
||||
"\\end{equation*}\n",
|
||||
"```\n",
|
||||
"### Display\n",
|
||||
"\\begin{equation*}\n",
|
||||
"P(E) = {n \\choose k} p^k (1-p)^{ n-k} \n",
|
||||
"\\end{equation*}"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"## An Identity of Ramanujan\n",
|
||||
"### Source\n",
|
||||
"```\\begin{equation*}\n",
|
||||
"\\frac{1}{\\Bigl(\\sqrt{\\phi \\sqrt{5}}-\\phi\\Bigr) e^{\\frac25 \\pi}} =\n",
|
||||
"1+\\frac{e^{-2\\pi}} {1+\\frac{e^{-4\\pi}} {1+\\frac{e^{-6\\pi}}\n",
|
||||
"{1+\\frac{e^{-8\\pi}} {1+\\ldots} } } } \n",
|
||||
"\\end{equation*}\n",
|
||||
"```\n",
|
||||
"### Display\n",
|
||||
"\\begin{equation*}\n",
|
||||
"\\frac{1}{\\Bigl(\\sqrt{\\phi \\sqrt{5}}-\\phi\\Bigr) e^{\\frac25 \\pi}} =\n",
|
||||
"1+\\frac{e^{-2\\pi}} {1+\\frac{e^{-4\\pi}} {1+\\frac{e^{-6\\pi}}\n",
|
||||
"{1+\\frac{e^{-8\\pi}} {1+\\ldots} } } } \n",
|
||||
"\\end{equation*}"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"## A Rogers-Ramanujan Identity\n",
|
||||
"### Source\n",
|
||||
"```\\begin{equation*}\n",
|
||||
"1 + \\frac{q^2}{(1-q)}+\\frac{q^6}{(1-q)(1-q^2)}+\\cdots =\n",
|
||||
"\\prod_{j=0}^{\\infty}\\frac{1}{(1-q^{5j+2})(1-q^{5j+3})},\n",
|
||||
"\\quad\\quad \\text{for $|q|<1$}. \n",
|
||||
"\\end{equation*}\n",
|
||||
"```\n",
|
||||
"### Display\n",
|
||||
"\\begin{equation*}\n",
|
||||
"1 + \\frac{q^2}{(1-q)}+\\frac{q^6}{(1-q)(1-q^2)}+\\cdots =\n",
|
||||
"\\prod_{j=0}^{\\infty}\\frac{1}{(1-q^{5j+2})(1-q^{5j+3})},\n",
|
||||
"\\quad\\quad \\text{for $|q|<1$}. \n",
|
||||
"\\end{equation*}"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"## Maxwell's Equations\n",
|
||||
"### Source\n",
|
||||
"```\\begin{align}\n",
|
||||
"\\nabla \\times \\vec{\\mathbf{B}} -\\, \\frac1c\\, \\frac{\\partial\\vec{\\mathbf{E}}}{\\partial t} & = \\frac{4\\pi}{c}\\vec{\\mathbf{j}} \\\\ \\nabla \\cdot \\vec{\\mathbf{E}} & = 4 \\pi \\rho \\\\\n",
|
||||
"\\nabla \\times \\vec{\\mathbf{E}}\\, +\\, \\frac1c\\, \\frac{\\partial\\vec{\\mathbf{B}}}{\\partial t} & = \\vec{\\mathbf{0}} \\\\\n",
|
||||
"\\nabla \\cdot \\vec{\\mathbf{B}} & = 0 \n",
|
||||
"\\end{align}\n",
|
||||
"```\n",
|
||||
"### Display\n",
|
||||
"\\begin{align}\n",
|
||||
"\\nabla \\times \\vec{\\mathbf{B}} -\\, \\frac1c\\, \\frac{\\partial\\vec{\\mathbf{E}}}{\\partial t} & = \\frac{4\\pi}{c}\\vec{\\mathbf{j}} \\\\ \\nabla \\cdot \\vec{\\mathbf{E}} & = 4 \\pi \\rho \\\\\n",
|
||||
"\\nabla \\times \\vec{\\mathbf{E}}\\, +\\, \\frac1c\\, \\frac{\\partial\\vec{\\mathbf{B}}}{\\partial t} & = \\vec{\\mathbf{0}} \\\\\n",
|
||||
"\\nabla \\cdot \\vec{\\mathbf{B}} & = 0 \n",
|
||||
"\\end{align}"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"# Equation Numbering and References\n",
|
||||
"\n",
|
||||
"---\n",
|
||||
"\n",
|
||||
"Equation numbering and referencing will be available in a future version of IPython."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"# Inline Typesetting (Mixing Markdown and TeX)\n",
|
||||
"\n",
|
||||
"---\n",
|
||||
"\n",
|
||||
"While display equations look good for a page of samples, the ability to mix math and *formatted* **text** in a paragraph is also important.\n",
|
||||
"\n",
|
||||
"## Source\n",
|
||||
"``` This expression $\\sqrt{3x-1}+(1+x)^2$ is an example of a TeX inline equation in a **[Markdown-formatted](http://daringfireball.net/projects/markdown/)** sentence. \n",
|
||||
"```\n",
|
||||
"## Display\n",
|
||||
"This expression $\\sqrt{3x-1}+(1+x)^2$ is an example of a TeX inline equation in a **[Markdown-formatted](http://daringfireball.net/projects/markdown/)** sentence. "
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"# Other Syntax\n",
|
||||
"\n",
|
||||
"---\n",
|
||||
"\n",
|
||||
"You will notice in other places on the web that `$$` are needed explicitly to begin and end MathJax typesetting. This is **not** required if you will be using TeX environments, but the IPython notebook will accept this syntax on legacy notebooks. \n",
|
||||
"\n",
|
||||
"### Source\n",
|
||||
"```\n",
|
||||
"$$\n",
|
||||
"\\begin{array}{c}\n",
|
||||
"y_1 \\\\\\\n",
|
||||
"y_2 \\mathtt{t}_i \\\\\\\n",
|
||||
"z_{3,4}\n",
|
||||
"\\end{array}\n",
|
||||
"$$\n",
|
||||
"```\n",
|
||||
"\n",
|
||||
"```\n",
|
||||
"$$\n",
|
||||
"\\begin{array}{c}\n",
|
||||
"y_1 \\cr\n",
|
||||
"y_2 \\mathtt{t}_i \\cr\n",
|
||||
"y_{3}\n",
|
||||
"\\end{array}\n",
|
||||
"$$\n",
|
||||
"```\n",
|
||||
"\n",
|
||||
"```\n",
|
||||
"$$\\begin{eqnarray} \n",
|
||||
"x' &=& &x \\sin\\phi &+& z \\cos\\phi \\\\\n",
|
||||
"z' &=& - &x \\cos\\phi &+& z \\sin\\phi \\\\\n",
|
||||
"\\end{eqnarray}$$\n",
|
||||
"```\n",
|
||||
"\n",
|
||||
"```\n",
|
||||
"$$\n",
|
||||
"x=4\n",
|
||||
"$$\n",
|
||||
"```\n",
|
||||
"\n",
|
||||
"### Display\n",
|
||||
"$$\n",
|
||||
"\\begin{array}{c}\n",
|
||||
"y_1 \\\\\\\n",
|
||||
"y_2 \\mathtt{t}_i \\\\\\\n",
|
||||
"z_{3,4}\n",
|
||||
"\\end{array}\n",
|
||||
"$$\n",
|
||||
"\n",
|
||||
"$$\n",
|
||||
"\\begin{array}{c}\n",
|
||||
"y_1 \\cr\n",
|
||||
"y_2 \\mathtt{t}_i \\cr\n",
|
||||
"y_{3}\n",
|
||||
"\\end{array}\n",
|
||||
"$$\n",
|
||||
"\n",
|
||||
"$$\\begin{eqnarray} \n",
|
||||
"x' &=& &x \\sin\\phi &+& z \\cos\\phi \\\\\n",
|
||||
"z' &=& - &x \\cos\\phi &+& z \\sin\\phi \\\\\n",
|
||||
"\\end{eqnarray}$$\n",
|
||||
"\n",
|
||||
"$$\n",
|
||||
"x=4\n",
|
||||
"$$"
|
||||
]
|
||||
}
|
||||
]
|
||||
],
|
||||
"metadata": {},
|
||||
"nbformat": 4,
|
||||
"nbformat_minor": 0
|
||||
}
|
||||
File diff suppressed because one or more lines are too long
@ -1,180 +1,168 @@
|
||||
{
|
||||
"cells": [
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {
|
||||
"slideshow": {
|
||||
"slide_type": "slide"
|
||||
}
|
||||
},
|
||||
"source": [
|
||||
"# What is the IPython Notebook?"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"## Introduction"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"The IPython Notebook is an **interactive computing environment** that enables users to author notebook documents that include: \n",
|
||||
"- Live code\n",
|
||||
"- Interactive widgets\n",
|
||||
"- Plots\n",
|
||||
"- Narrative text\n",
|
||||
"- Equations\n",
|
||||
"- Images\n",
|
||||
"- Video\n",
|
||||
"\n",
|
||||
"These documents provide a **complete and self-contained record of a computation** that can be converted to various formats and shared with others using email, [Dropbox](http://dropbox.com), version control systems (like git/[GitHub](http://github.com)) or [nbviewer.ipython.org](http://nbviewer.ipython.org)."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {
|
||||
"slideshow": {
|
||||
"slide_type": "slide"
|
||||
}
|
||||
},
|
||||
"source": [
|
||||
"### Components"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"The IPython Notebook combines three components:\n",
|
||||
"\n",
|
||||
"* **The notebook web application**: An interactive web application for writing and running code interactively and authoring notebook documents.\n",
|
||||
"* **Kernels**: Separate processes started by the notebook web application that runs users' code in a given language and returns output back to the notebook web application. The kernel also handles things like computations for interactive widgets, tab completion and introspection. \n",
|
||||
"* **Notebook documents**: Self-contained documents that contain a representation of all content visible in the notebook web application, including inputs and outputs of the computations, narrative\n",
|
||||
"text, equations, images, and rich media representations of objects. Each notebook document has its own kernel."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {
|
||||
"slideshow": {
|
||||
"slide_type": "slide"
|
||||
}
|
||||
},
|
||||
"source": [
|
||||
"## Notebook web application"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"The notebook web application enables users to:\n",
|
||||
"\n",
|
||||
"* **Edit code in the browser**, with automatic syntax highlighting, indentation, and tab completion/introspection.\n",
|
||||
"* **Run code from the browser**, with the results of computations attached to the code which generated them.\n",
|
||||
"* See the results of computations with **rich media representations**, such as HTML, LaTeX, PNG, SVG, PDF, etc.\n",
|
||||
"* Create and use **interactive JavaScript wigets**, which bind interactive user interface controls and visualizations to reactive kernel side computations.\n",
|
||||
"* Author **narrative text** using the [Markdown](https://daringfireball.net/projects/markdown/) markup language.\n",
|
||||
"* Build **hierarchical documents** that are organized into sections with different levels of headings.\n",
|
||||
"* Include mathematical equations using **LaTeX syntax in Markdown**, which are rendered in-browser by [MathJax](http://www.mathjax.org/).\n",
|
||||
"* Start **parallel computing** clusters that work with IPython's interactive parallel computing libraries `IPython.parallel`."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {
|
||||
"slideshow": {
|
||||
"slide_type": "slide"
|
||||
}
|
||||
},
|
||||
"source": [
|
||||
"## Kernels"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Through IPython's kernel and messaging architecture, the Notebook allows code to be run in a range of different programming languages. For each notebook document that a user opens, the web application starts a kernel that runs the code for that notebook. Each kernel is capable of running code in a single programming language and there are kernels available in the following languages:\n",
|
||||
"\n",
|
||||
"* Python(https://github.com/ipython/ipython)\n",
|
||||
"* Julia (https://github.com/JuliaLang/IJulia.jl)\n",
|
||||
"* R (https://github.com/takluyver/IRkernel)\n",
|
||||
"* Ruby (https://github.com/minrk/iruby)\n",
|
||||
"* Haskell (https://github.com/gibiansky/IHaskell)\n",
|
||||
"* Scala (https://github.com/Bridgewater/scala-notebook)\n",
|
||||
"* node.js (https://gist.github.com/Carreau/4279371)\n",
|
||||
"* Go (https://github.com/takluyver/igo)\n",
|
||||
"\n",
|
||||
"The default kernel runs Python code. When it is released in the Summer/Fall of 2014, IPython 3.0 will provide a simple way for users to pick which of these kernels is used for a given notebook. \n",
|
||||
"\n",
|
||||
"Each of these kernels communicate with the notebook web application and web browser using a JSON over ZeroMQ/WebSockets message protocol that is described [here](http://ipython.org/ipython-doc/dev/development/messaging.html). Most users don't need to know about these details, but it helps to understand that \"kernels run code.\""
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {
|
||||
"slideshow": {
|
||||
"slide_type": "slide"
|
||||
}
|
||||
},
|
||||
"source": [
|
||||
"## Notebook documents"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Notebook documents contain the **inputs and outputs** of an interactive session as well as **narrative text** that accompanies the code but is not meant for execution. **Rich output** generated by running code, including HTML, images, video, and plots, is embeddeed in the notebook, which makes it a complete and self-contained record of a computation. "
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"When you run the notebook web application on your computer, notebook documents are just **files on your local filesystem with a `.ipynb` extension**. This allows you to use familiar workflows for organizing your notebooks into folders and sharing them with others using email, Dropbox and version control systems."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Notebooks consist of a **linear sequence of cells**. There are four basic cell types:\n",
|
||||
"\n",
|
||||
"* **Code cells:** Input and output of live code that is run in the kernel\n",
|
||||
"* **Markdown cells:** Narrative text with embedded LaTeX equations\n",
|
||||
"* **Heading cells:** 6 levels of hierarchical organization and formatting\n",
|
||||
"* **Raw cells:** Unformatted text that is included, without modification, when notebooks are converted to different formats using nbconvert\n",
|
||||
"\n",
|
||||
"Internally, notebook documents are **[JSON](http://en.wikipedia.org/wiki/JSON) data** with **binary values [base64](http://en.wikipedia.org/wiki/Base64)** encoded. This allows them to be **read and manipulated programmatically** by any programming language. Because JSON is a text format, notebook documents are version control friendly.\n",
|
||||
"\n",
|
||||
"**Notebooks can be exported** to different static formats including HTML, reStructeredText, LaTeX, PDF, and slide shows ([reveal.js](http://lab.hakim.se/reveal-js/#/)) using IPython's `nbconvert` utility.\n",
|
||||
"\n",
|
||||
"Furthermore, any notebook document available from a **public URL on or GitHub can be shared** via [nbviewer](http://nbviewer.ipython.org). This service loads the notebook document from the URL and renders it as a static web page. The resulting web page may thus be shared with others **without their needing to install IPython**."
|
||||
]
|
||||
}
|
||||
],
|
||||
"metadata": {
|
||||
"celltoolbar": "Slideshow",
|
||||
"name": "",
|
||||
"signature": "sha256:86e99da10fb4a123108149196f182861fa434fb59520b256405c6052601c2486"
|
||||
},
|
||||
"nbformat": 3,
|
||||
"nbformat_minor": 0,
|
||||
"worksheets": [
|
||||
{
|
||||
"cells": [
|
||||
{
|
||||
"cell_type": "heading",
|
||||
"level": 1,
|
||||
"metadata": {
|
||||
"slideshow": {
|
||||
"slide_type": "slide"
|
||||
}
|
||||
},
|
||||
"source": [
|
||||
"What is the IPython Notebook?"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "heading",
|
||||
"level": 2,
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Introduction"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"The IPython Notebook is an **interactive computing environment** that enables users to author notebook documents that include: \n",
|
||||
"- Live code\n",
|
||||
"- Interactive widgets\n",
|
||||
"- Plots\n",
|
||||
"- Narrative text\n",
|
||||
"- Equations\n",
|
||||
"- Images\n",
|
||||
"- Video\n",
|
||||
"\n",
|
||||
"These documents provide a **complete and self-contained record of a computation** that can be converted to various formats and shared with others using email, [Dropbox](http://dropbox.com), version control systems (like git/[GitHub](http://github.com)) or [nbviewer.ipython.org](http://nbviewer.ipython.org)."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "heading",
|
||||
"level": 3,
|
||||
"metadata": {
|
||||
"slideshow": {
|
||||
"slide_type": "slide"
|
||||
}
|
||||
},
|
||||
"source": [
|
||||
"Components"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"The IPython Notebook combines three components:\n",
|
||||
"\n",
|
||||
"* **The notebook web application**: An interactive web application for writing and running code interactively and authoring notebook documents.\n",
|
||||
"* **Kernels**: Separate processes started by the notebook web application that runs users' code in a given language and returns output back to the notebook web application. The kernel also handles things like computations for interactive widgets, tab completion and introspection. \n",
|
||||
"* **Notebook documents**: Self-contained documents that contain a representation of all content visible in the notebook web application, including inputs and outputs of the computations, narrative\n",
|
||||
"text, equations, images, and rich media representations of objects. Each notebook document has its own kernel."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "heading",
|
||||
"level": 2,
|
||||
"metadata": {
|
||||
"slideshow": {
|
||||
"slide_type": "slide"
|
||||
}
|
||||
},
|
||||
"source": [
|
||||
"Notebook web application"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"The notebook web application enables users to:\n",
|
||||
"\n",
|
||||
"* **Edit code in the browser**, with automatic syntax highlighting, indentation, and tab completion/introspection.\n",
|
||||
"* **Run code from the browser**, with the results of computations attached to the code which generated them.\n",
|
||||
"* See the results of computations with **rich media representations**, such as HTML, LaTeX, PNG, SVG, PDF, etc.\n",
|
||||
"* Create and use **interactive JavaScript wigets**, which bind interactive user interface controls and visualizations to reactive kernel side computations.\n",
|
||||
"* Author **narrative text** using the [Markdown](https://daringfireball.net/projects/markdown/) markup language.\n",
|
||||
"* Build **hierarchical documents** that are organized into sections with different levels of headings.\n",
|
||||
"* Include mathematical equations using **LaTeX syntax in Markdown**, which are rendered in-browser by [MathJax](http://www.mathjax.org/).\n",
|
||||
"* Start **parallel computing** clusters that work with IPython's interactive parallel computing libraries `IPython.parallel`."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "heading",
|
||||
"level": 2,
|
||||
"metadata": {
|
||||
"slideshow": {
|
||||
"slide_type": "slide"
|
||||
}
|
||||
},
|
||||
"source": [
|
||||
"Kernels"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Through IPython's kernel and messaging architecture, the Notebook allows code to be run in a range of different programming languages. For each notebook document that a user opens, the web application starts a kernel that runs the code for that notebook. Each kernel is capable of running code in a single programming language and there are kernels available in the following languages:\n",
|
||||
"\n",
|
||||
"* Python(https://github.com/ipython/ipython)\n",
|
||||
"* Julia (https://github.com/JuliaLang/IJulia.jl)\n",
|
||||
"* R (https://github.com/takluyver/IRkernel)\n",
|
||||
"* Ruby (https://github.com/minrk/iruby)\n",
|
||||
"* Haskell (https://github.com/gibiansky/IHaskell)\n",
|
||||
"* Scala (https://github.com/Bridgewater/scala-notebook)\n",
|
||||
"* node.js (https://gist.github.com/Carreau/4279371)\n",
|
||||
"* Go (https://github.com/takluyver/igo)\n",
|
||||
"\n",
|
||||
"The default kernel runs Python code. When it is released in the Summer/Fall of 2014, IPython 3.0 will provide a simple way for users to pick which of these kernels is used for a given notebook. \n",
|
||||
"\n",
|
||||
"Each of these kernels communicate with the notebook web application and web browser using a JSON over ZeroMQ/WebSockets message protocol that is described [here](http://ipython.org/ipython-doc/dev/development/messaging.html). Most users don't need to know about these details, but it helps to understand that \"kernels run code.\""
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "heading",
|
||||
"level": 2,
|
||||
"metadata": {
|
||||
"slideshow": {
|
||||
"slide_type": "slide"
|
||||
}
|
||||
},
|
||||
"source": [
|
||||
"Notebook documents"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Notebook documents contain the **inputs and outputs** of an interactive session as well as **narrative text** that accompanies the code but is not meant for execution. **Rich output** generated by running code, including HTML, images, video, and plots, is embeddeed in the notebook, which makes it a complete and self-contained record of a computation. "
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"When you run the notebook web application on your computer, notebook documents are just **files on your local filesystem with a `.ipynb` extension**. This allows you to use familiar workflows for organizing your notebooks into folders and sharing them with others using email, Dropbox and version control systems."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Notebooks consist of a **linear sequence of cells**. There are four basic cell types:\n",
|
||||
"\n",
|
||||
"* **Code cells:** Input and output of live code that is run in the kernel\n",
|
||||
"* **Markdown cells:** Narrative text with embedded LaTeX equations\n",
|
||||
"* **Heading cells:** 6 levels of hierarchical organization and formatting\n",
|
||||
"* **Raw cells:** Unformatted text that is included, without modification, when notebooks are converted to different formats using nbconvert\n",
|
||||
"\n",
|
||||
"Internally, notebook documents are **[JSON](http://en.wikipedia.org/wiki/JSON) data** with **binary values [base64](http://en.wikipedia.org/wiki/Base64)** encoded. This allows them to be **read and manipulated programmatically** by any programming language. Because JSON is a text format, notebook documents are version control friendly.\n",
|
||||
"\n",
|
||||
"**Notebooks can be exported** to different static formats including HTML, reStructeredText, LaTeX, PDF, and slide shows ([reveal.js](http://lab.hakim.se/reveal-js/#/)) using IPython's `nbconvert` utility.\n",
|
||||
"\n",
|
||||
"Furthermore, any notebook document available from a **public URL on or GitHub can be shared** via [nbviewer](http://nbviewer.ipython.org). This service loads the notebook document from the URL and renders it as a static web page. The resulting web page may thus be shared with others **without their needing to install IPython**."
|
||||
]
|
||||
}
|
||||
],
|
||||
"metadata": {}
|
||||
}
|
||||
]
|
||||
"nbformat": 4,
|
||||
"nbformat_minor": 0
|
||||
}
|
||||
@ -1,319 +1,304 @@
|
||||
{
|
||||
"cells": [
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"# Markdown Cells"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Text can be added to IPython Notebooks using Markdown cells. Markdown is a popular markup language that is a superset of HTML. Its specification can be found here:\n",
|
||||
"\n",
|
||||
"<http://daringfireball.net/projects/markdown/>"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"## Markdown basics"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"You can make text *italic* or **bold**."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"You can build nested itemized or enumerated lists:\n",
|
||||
"\n",
|
||||
"* One\n",
|
||||
" - Sublist\n",
|
||||
" - This\n",
|
||||
" - Sublist\n",
|
||||
" - That\n",
|
||||
" - The other thing\n",
|
||||
"* Two\n",
|
||||
" - Sublist\n",
|
||||
"* Three\n",
|
||||
" - Sublist\n",
|
||||
"\n",
|
||||
"Now another list:\n",
|
||||
"\n",
|
||||
"1. Here we go\n",
|
||||
" 1. Sublist\n",
|
||||
" 2. Sublist\n",
|
||||
"2. There we go\n",
|
||||
"3. Now this"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"You can add horizontal rules:\n",
|
||||
"\n",
|
||||
"---"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Here is a blockquote:\n",
|
||||
"\n",
|
||||
"> Beautiful is better than ugly.\n",
|
||||
"> Explicit is better than implicit.\n",
|
||||
"> Simple is better than complex.\n",
|
||||
"> Complex is better than complicated.\n",
|
||||
"> Flat is better than nested.\n",
|
||||
"> Sparse is better than dense.\n",
|
||||
"> Readability counts.\n",
|
||||
"> Special cases aren't special enough to break the rules.\n",
|
||||
"> Although practicality beats purity.\n",
|
||||
"> Errors should never pass silently.\n",
|
||||
"> Unless explicitly silenced.\n",
|
||||
"> In the face of ambiguity, refuse the temptation to guess.\n",
|
||||
"> There should be one-- and preferably only one --obvious way to do it.\n",
|
||||
"> Although that way may not be obvious at first unless you're Dutch.\n",
|
||||
"> Now is better than never.\n",
|
||||
"> Although never is often better than *right* now.\n",
|
||||
"> If the implementation is hard to explain, it's a bad idea.\n",
|
||||
"> If the implementation is easy to explain, it may be a good idea.\n",
|
||||
"> Namespaces are one honking great idea -- let's do more of those!"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"And shorthand for links:\n",
|
||||
"\n",
|
||||
"[IPython's website](http://ipython.org)"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"## Headings"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"If you want, you can add headings using Markdown's syntax:\n",
|
||||
"\n",
|
||||
"# Heading 1\n",
|
||||
"# Heading 2\n",
|
||||
"## Heading 2.1\n",
|
||||
"## Heading 2.2"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"**BUT most of the time you should use the Notebook's Heading Cells to organize your Notebook content**, as they provide meaningful structure that can be interpreted by other tools, not just large bold fonts."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"## Embedded code"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"You can embed code meant for illustration instead of execution in Python:\n",
|
||||
"\n",
|
||||
" def f(x):\n",
|
||||
" \"\"\"a docstring\"\"\"\n",
|
||||
" return x**2\n",
|
||||
"\n",
|
||||
"or other languages:\n",
|
||||
"\n",
|
||||
" if (i=0; i<n; i++) {\n",
|
||||
" printf(\"hello %d\\n\", i);\n",
|
||||
" x += 4;\n",
|
||||
" }"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"## LaTeX equations"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Courtesy of MathJax, you can include mathematical expressions both inline: \n",
|
||||
"$e^{i\\pi} + 1 = 0$ and displayed:\n",
|
||||
"\n",
|
||||
"$$e^x=\\sum_{i=0}^\\infty \\frac{1}{i!}x^i$$"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"## Github flavored markdown (GFM)"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"The Notebook webapp support Github flavored markdown meaning that you can use triple backticks for code blocks \n",
|
||||
"<pre>\n",
|
||||
"```python\n",
|
||||
"print \"Hello World\"\n",
|
||||
"```\n",
|
||||
"\n",
|
||||
"```javascript\n",
|
||||
"console.log(\"Hello World\")\n",
|
||||
"```\n",
|
||||
"</pre>\n",
|
||||
"\n",
|
||||
"Gives \n",
|
||||
"```python\n",
|
||||
"print \"Hello World\"\n",
|
||||
"```\n",
|
||||
"\n",
|
||||
"```javascript\n",
|
||||
"console.log(\"Hello World\")\n",
|
||||
"```\n",
|
||||
"\n",
|
||||
"And a table like this : \n",
|
||||
"\n",
|
||||
"<pre>\n",
|
||||
"| This | is |\n",
|
||||
"|------|------|\n",
|
||||
"| a | table| \n",
|
||||
"</pre>\n",
|
||||
"\n",
|
||||
"A nice Html Table\n",
|
||||
"\n",
|
||||
"| This | is |\n",
|
||||
"|------|------|\n",
|
||||
"| a | table| "
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"## General HTML"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Because Markdown is a superset of HTML you can even add things like HTML tables:\n",
|
||||
"\n",
|
||||
"<table>\n",
|
||||
"<tr>\n",
|
||||
"<th>Header 1</th>\n",
|
||||
"<th>Header 2</th>\n",
|
||||
"</tr>\n",
|
||||
"<tr>\n",
|
||||
"<td>row 1, cell 1</td>\n",
|
||||
"<td>row 1, cell 2</td>\n",
|
||||
"</tr>\n",
|
||||
"<tr>\n",
|
||||
"<td>row 2, cell 1</td>\n",
|
||||
"<td>row 2, cell 2</td>\n",
|
||||
"</tr>\n",
|
||||
"</table>"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"## Local files"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"If you have local files in your Notebook directory, you can refer to these files in Markdown cells directly:\n",
|
||||
"\n",
|
||||
" [subdirectory/]<filename>\n",
|
||||
"\n",
|
||||
"For example, in the images folder, we have the Python logo:\n",
|
||||
"\n",
|
||||
" <img src=\"images/python-logo.svg\" />\n",
|
||||
"\n",
|
||||
"<img src=\"images/python-logo.svg\" />\n",
|
||||
"\n",
|
||||
"and a video with the HTML5 video tag:\n",
|
||||
"\n",
|
||||
" <video controls src=\"images/animation.m4v\" />\n",
|
||||
"\n",
|
||||
"<video controls src=\"images/animation.m4v\" />\n",
|
||||
"\n",
|
||||
"These do not embed the data into the notebook file, and require that the files exist when you are viewing the notebook."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"### Security of local files"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Note that this means that the IPython notebook server also acts as a generic file server\n",
|
||||
"for files inside the same tree as your notebooks. Access is not granted outside the\n",
|
||||
"notebook folder so you have strict control over what files are visible, but for this\n",
|
||||
"reason it is highly recommended that you do not run the notebook server with a notebook\n",
|
||||
"directory at a high level in your filesystem (e.g. your home directory).\n",
|
||||
"\n",
|
||||
"When you run the notebook in a password-protected manner, local file access is restricted\n",
|
||||
"to authenticated users unless read-only views are active."
|
||||
]
|
||||
}
|
||||
],
|
||||
"metadata": {
|
||||
"name": "",
|
||||
"signature": "sha256:3b7cae0c0936f25e6ccb7acafe310c08a4162a1a7fd66fa9874a52cffa0f64f9"
|
||||
},
|
||||
"nbformat": 3,
|
||||
"nbformat_minor": 0,
|
||||
"worksheets": [
|
||||
{
|
||||
"cells": [
|
||||
{
|
||||
"cell_type": "heading",
|
||||
"level": 1,
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Markdown Cells"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Text can be added to IPython Notebooks using Markdown cells. Markdown is a popular markup language that is a superset of HTML. Its specification can be found here:\n",
|
||||
"\n",
|
||||
"<http://daringfireball.net/projects/markdown/>"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "heading",
|
||||
"level": 2,
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Markdown basics"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"You can make text *italic* or **bold**."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"You can build nested itemized or enumerated lists:\n",
|
||||
"\n",
|
||||
"* One\n",
|
||||
" - Sublist\n",
|
||||
" - This\n",
|
||||
" - Sublist\n",
|
||||
" - That\n",
|
||||
" - The other thing\n",
|
||||
"* Two\n",
|
||||
" - Sublist\n",
|
||||
"* Three\n",
|
||||
" - Sublist\n",
|
||||
"\n",
|
||||
"Now another list:\n",
|
||||
"\n",
|
||||
"1. Here we go\n",
|
||||
" 1. Sublist\n",
|
||||
" 2. Sublist\n",
|
||||
"2. There we go\n",
|
||||
"3. Now this"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"You can add horizontal rules:\n",
|
||||
"\n",
|
||||
"---"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Here is a blockquote:\n",
|
||||
"\n",
|
||||
"> Beautiful is better than ugly.\n",
|
||||
"> Explicit is better than implicit.\n",
|
||||
"> Simple is better than complex.\n",
|
||||
"> Complex is better than complicated.\n",
|
||||
"> Flat is better than nested.\n",
|
||||
"> Sparse is better than dense.\n",
|
||||
"> Readability counts.\n",
|
||||
"> Special cases aren't special enough to break the rules.\n",
|
||||
"> Although practicality beats purity.\n",
|
||||
"> Errors should never pass silently.\n",
|
||||
"> Unless explicitly silenced.\n",
|
||||
"> In the face of ambiguity, refuse the temptation to guess.\n",
|
||||
"> There should be one-- and preferably only one --obvious way to do it.\n",
|
||||
"> Although that way may not be obvious at first unless you're Dutch.\n",
|
||||
"> Now is better than never.\n",
|
||||
"> Although never is often better than *right* now.\n",
|
||||
"> If the implementation is hard to explain, it's a bad idea.\n",
|
||||
"> If the implementation is easy to explain, it may be a good idea.\n",
|
||||
"> Namespaces are one honking great idea -- let's do more of those!"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"And shorthand for links:\n",
|
||||
"\n",
|
||||
"[IPython's website](http://ipython.org)"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "heading",
|
||||
"level": 2,
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Headings"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"If you want, you can add headings using Markdown's syntax:\n",
|
||||
"\n",
|
||||
"# Heading 1\n",
|
||||
"# Heading 2\n",
|
||||
"## Heading 2.1\n",
|
||||
"## Heading 2.2"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"**BUT most of the time you should use the Notebook's Heading Cells to organize your Notebook content**, as they provide meaningful structure that can be interpreted by other tools, not just large bold fonts."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "heading",
|
||||
"level": 2,
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Embedded code"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"You can embed code meant for illustration instead of execution in Python:\n",
|
||||
"\n",
|
||||
" def f(x):\n",
|
||||
" \"\"\"a docstring\"\"\"\n",
|
||||
" return x**2\n",
|
||||
"\n",
|
||||
"or other languages:\n",
|
||||
"\n",
|
||||
" if (i=0; i<n; i++) {\n",
|
||||
" printf(\"hello %d\\n\", i);\n",
|
||||
" x += 4;\n",
|
||||
" }"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "heading",
|
||||
"level": 2,
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"LaTeX equations"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Courtesy of MathJax, you can include mathematical expressions both inline: \n",
|
||||
"$e^{i\\pi} + 1 = 0$ and displayed:\n",
|
||||
"\n",
|
||||
"$$e^x=\\sum_{i=0}^\\infty \\frac{1}{i!}x^i$$"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "heading",
|
||||
"level": 2,
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Github flavored markdown (GFM)"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"The Notebook webapp support Github flavored markdown meaning that you can use triple backticks for code blocks \n",
|
||||
"<pre>\n",
|
||||
"```python\n",
|
||||
"print \"Hello World\"\n",
|
||||
"```\n",
|
||||
"\n",
|
||||
"```javascript\n",
|
||||
"console.log(\"Hello World\")\n",
|
||||
"```\n",
|
||||
"</pre>\n",
|
||||
"\n",
|
||||
"Gives \n",
|
||||
"```python\n",
|
||||
"print \"Hello World\"\n",
|
||||
"```\n",
|
||||
"\n",
|
||||
"```javascript\n",
|
||||
"console.log(\"Hello World\")\n",
|
||||
"```\n",
|
||||
"\n",
|
||||
"And a table like this : \n",
|
||||
"\n",
|
||||
"<pre>\n",
|
||||
"| This | is |\n",
|
||||
"|------|------|\n",
|
||||
"| a | table| \n",
|
||||
"</pre>\n",
|
||||
"\n",
|
||||
"A nice Html Table\n",
|
||||
"\n",
|
||||
"| This | is |\n",
|
||||
"|------|------|\n",
|
||||
"| a | table| "
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "heading",
|
||||
"level": 2,
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"General HTML"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Because Markdown is a superset of HTML you can even add things like HTML tables:\n",
|
||||
"\n",
|
||||
"<table>\n",
|
||||
"<tr>\n",
|
||||
"<th>Header 1</th>\n",
|
||||
"<th>Header 2</th>\n",
|
||||
"</tr>\n",
|
||||
"<tr>\n",
|
||||
"<td>row 1, cell 1</td>\n",
|
||||
"<td>row 1, cell 2</td>\n",
|
||||
"</tr>\n",
|
||||
"<tr>\n",
|
||||
"<td>row 2, cell 1</td>\n",
|
||||
"<td>row 2, cell 2</td>\n",
|
||||
"</tr>\n",
|
||||
"</table>"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "heading",
|
||||
"level": 2,
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Local files"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"If you have local files in your Notebook directory, you can refer to these files in Markdown cells directly:\n",
|
||||
"\n",
|
||||
" [subdirectory/]<filename>\n",
|
||||
"\n",
|
||||
"For example, in the images folder, we have the Python logo:\n",
|
||||
"\n",
|
||||
" <img src=\"images/python-logo.svg\" />\n",
|
||||
"\n",
|
||||
"<img src=\"images/python-logo.svg\" />\n",
|
||||
"\n",
|
||||
"and a video with the HTML5 video tag:\n",
|
||||
"\n",
|
||||
" <video controls src=\"images/animation.m4v\" />\n",
|
||||
"\n",
|
||||
"<video controls src=\"images/animation.m4v\" />\n",
|
||||
"\n",
|
||||
"These do not embed the data into the notebook file, and require that the files exist when you are viewing the notebook."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "heading",
|
||||
"level": 3,
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Security of local files"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Note that this means that the IPython notebook server also acts as a generic file server\n",
|
||||
"for files inside the same tree as your notebooks. Access is not granted outside the\n",
|
||||
"notebook folder so you have strict control over what files are visible, but for this\n",
|
||||
"reason it is highly recommended that you do not run the notebook server with a notebook\n",
|
||||
"directory at a high level in your filesystem (e.g. your home directory).\n",
|
||||
"\n",
|
||||
"When you run the notebook in a password-protected manner, local file access is restricted\n",
|
||||
"to authenticated users unless read-only views are active."
|
||||
]
|
||||
}
|
||||
],
|
||||
"metadata": {}
|
||||
}
|
||||
]
|
||||
"nbformat": 4,
|
||||
"nbformat_minor": 0
|
||||
}
|
||||
@ -1,59 +1,51 @@
|
||||
{
|
||||
"metadata": {
|
||||
"name": ""
|
||||
},
|
||||
"nbformat": 3,
|
||||
"nbformat_minor": 0,
|
||||
"worksheets": [
|
||||
"cells": [
|
||||
{
|
||||
"cells": [
|
||||
{
|
||||
"cell_type": "heading",
|
||||
"level": 1,
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"My Notebook"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"collapsed": false,
|
||||
"input": [
|
||||
"def foo():\n",
|
||||
" return \"foo\""
|
||||
],
|
||||
"language": "python",
|
||||
"metadata": {},
|
||||
"outputs": [],
|
||||
"prompt_number": 1
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"collapsed": false,
|
||||
"input": [
|
||||
"def has_ip_syntax():\n",
|
||||
" listing = !ls\n",
|
||||
" return listing"
|
||||
],
|
||||
"language": "python",
|
||||
"metadata": {},
|
||||
"outputs": [],
|
||||
"prompt_number": 2
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"collapsed": false,
|
||||
"input": [
|
||||
"def whatsmyname():\n",
|
||||
" return __name__"
|
||||
],
|
||||
"language": "python",
|
||||
"metadata": {},
|
||||
"outputs": [],
|
||||
"prompt_number": 4
|
||||
}
|
||||
],
|
||||
"metadata": {}
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"# My Notebook"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": 1,
|
||||
"metadata": {
|
||||
"collapsed": false
|
||||
},
|
||||
"outputs": [],
|
||||
"source": [
|
||||
"def foo():\n",
|
||||
" return \"foo\""
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": 2,
|
||||
"metadata": {
|
||||
"collapsed": false
|
||||
},
|
||||
"outputs": [],
|
||||
"source": [
|
||||
"def has_ip_syntax():\n",
|
||||
" listing = !ls\n",
|
||||
" return listing"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": 4,
|
||||
"metadata": {
|
||||
"collapsed": false
|
||||
},
|
||||
"outputs": [],
|
||||
"source": [
|
||||
"def whatsmyname():\n",
|
||||
" return __name__"
|
||||
]
|
||||
}
|
||||
]
|
||||
],
|
||||
"metadata": {},
|
||||
"nbformat": 4,
|
||||
"nbformat_minor": 0
|
||||
}
|
||||
@ -1,33 +1,26 @@
|
||||
{
|
||||
"metadata": {
|
||||
"name": ""
|
||||
},
|
||||
"nbformat": 3,
|
||||
"nbformat_minor": 0,
|
||||
"worksheets": [
|
||||
"cells": [
|
||||
{
|
||||
"cells": [
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"This notebook just defines `bar`"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"collapsed": false,
|
||||
"input": [
|
||||
"def bar(x):\n",
|
||||
" return \"bar\" * x"
|
||||
],
|
||||
"language": "python",
|
||||
"metadata": {},
|
||||
"outputs": [],
|
||||
"prompt_number": 2
|
||||
}
|
||||
],
|
||||
"metadata": {}
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"This notebook just defines `bar`"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "code",
|
||||
"execution_count": 2,
|
||||
"metadata": {
|
||||
"collapsed": false
|
||||
},
|
||||
"outputs": [],
|
||||
"source": [
|
||||
"def bar(x):\n",
|
||||
" return \"bar\" * x"
|
||||
]
|
||||
}
|
||||
]
|
||||
],
|
||||
"metadata": {},
|
||||
"nbformat": 4,
|
||||
"nbformat_minor": 0
|
||||
}
|
||||
Loading…
Reference in new issue