419 lines
45 KiB
Text
419 lines
45 KiB
Text
|
{
|
||
|
|
"metadata": {
|
||
|
|
"name": "01_notebook_introduction"
|
||
|
|
},
|
||
|
|
"nbformat": 2,
|
||
|
|
"worksheets": [
|
||
|
|
{
|
||
|
|
"cells": [
|
||
|
|
{
|
||
|
|
"cell_type": "markdown",
|
||
|
|
"source": [
|
||
|
|
"# An introduction to the Jupyter notebook",
|
||
|
|
"",
|
||
|
|
"The IPython web notebook is a frontend that allows for new modes",
|
||
|
|
"of interaction with IPython: this web-based interface allows you to execute Python and IPython",
|
||
|
|
"commands in each input cell just like you would at the IPython terminal or Qt console, but you can",
|
||
|
|
"also save an entire session as a document in a file with the `.ipynb` extension.",
|
||
|
|
"",
|
||
|
|
"The document you are reading now is precisely an example of one such notebook, and we will show you",
|
||
|
|
"here how to best use this new interface.",
|
||
|
|
"",
|
||
|
|
"The first thing to understand is that a notebook consists of a sequence of 'cells' that can contain ",
|
||
|
|
"either text (such as this one) or code meant for execution (such as the next one):",
|
||
|
|
"",
|
||
|
|
"* Text cells can be written using [Markdown syntax](http://daringfireball.net/projects/markdown/syntax) ",
|
||
|
|
"(in a future release we will also provide support for reStructuredText and Sphinx integration, and we ",
|
||
|
|
"welcome help from interested contributors to make that happen).",
|
||
|
|
"",
|
||
|
|
"* Code cells take IPython input (i.e. Python code, `%magics`, `!system calls`, etc) like IPython at",
|
||
|
|
"the terminal or at the Qt Console. The only difference is that in order to execute a cell, you *must*",
|
||
|
|
"use `Shift-Enter`, as pressing `Enter` will add a new line of text to the cell. When you type ",
|
||
|
|
"`Shift-Enter`, the cell content is executed, output displayed and a new cell is created below. Try",
|
||
|
|
"it now by putting your cursor on the next cell and typing `Shift-Enter`:"
|
||
|
|
]
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"cell_type": "code",
|
||
|
|
"collapsed": false,
|
||
|
|
"input": [
|
||
|
|
"\"This is the new Jupyter notebook\""
|
||
|
|
],
|
||
|
|
"language": "python",
|
||
|
|
"outputs": [
|
||
|
|
{
|
||
|
|
"output_type": "pyout",
|
||
|
|
"prompt_number": 1,
|
||
|
|
"text": [
|
||
|
|
"'This is the new Jupyter notebook'"
|
||
|
|
]
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"prompt_number": 1
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"cell_type": "markdown",
|
||
|
|
"source": [
|
||
|
|
"You can re-execute the same cell over and over as many times as you want. Simply put your",
|
||
|
|
"cursor in the cell again, edit at will, and type `Shift-Enter` to execute. ",
|
||
|
|
"",
|
||
|
|
"**Tip:** A cell can also be executed",
|
||
|
|
"*in-place*, where IPython executes its content but leaves the cursor in the same cell. This is done by",
|
||
|
|
"typing `Ctrl-Enter` instead, and is useful if you want to quickly run a command to check something ",
|
||
|
|
"before tping the real content you want to leave in the cell. For example, in the next cell, try issuing",
|
||
|
|
"several system commands in-place with `Ctrl-Enter`, such as `pwd` and then `ls`:"
|
||
|
|
]
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"cell_type": "code",
|
||
|
|
"collapsed": false,
|
||
|
|
"input": [
|
||
|
|
"ls"
|
||
|
|
],
|
||
|
|
"language": "python",
|
||
|
|
"outputs": [
|
||
|
|
{
|
||
|
|
"output_type": "stream",
|
||
|
|
"stream": "stdout",
|
||
|
|
"text": [
|
||
|
|
"00_notebook_tour.ipynb formatting.ipynb sympy_quantum_computing.ipynb",
|
||
|
|
"01_notebook_introduction.ipynb python-logo.svg trapezoid_rule.ipynb",
|
||
|
|
"display_protocol.ipynb sympy.ipynb"
|
||
|
|
]
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"prompt_number": 2
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"cell_type": "markdown",
|
||
|
|
"source": [
|
||
|
|
"In a cell, you can type anything from a single python expression to an arbitrarily long amount of code ",
|
||
|
|
"(although for reasons of readability, you should probably limit this to a few dozen lines):"
|
||
|
|
]
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"cell_type": "code",
|
||
|
|
"collapsed": false,
|
||
|
|
"input": [
|
||
|
|
"def f(x):",
|
||
|
|
" \"\"\"My function",
|
||
|
|
" x : parameter\"\"\"",
|
||
|
|
" ",
|
||
|
|
" return x+1",
|
||
|
|
"",
|
||
|
|
"print \"f(3) = \", f(3)"
|
||
|
|
],
|
||
|
|
"language": "python",
|
||
|
|
"outputs": [
|
||
|
|
{
|
||
|
|
"output_type": "stream",
|
||
|
|
"stream": "stdout",
|
||
|
|
"text": [
|
||
|
|
"f(3) = 4"
|
||
|
|
]
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"prompt_number": 3
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"cell_type": "markdown",
|
||
|
|
"source": [
|
||
|
|
"## User interface",
|
||
|
|
"",
|
||
|
|
"When you start a new notebook server with `ipython notebook`, your",
|
||
|
|
"browser should open into the *Dashboard*, a page listing all notebooks",
|
||
|
|
"available in the current directory as well as letting you create new",
|
||
|
|
"notebooks. In this page, you can also drag and drop existing `.py` files",
|
||
|
|
"over the file list to import them as notebooks (see the manual for ",
|
||
|
|
"[further details on how these files are ",
|
||
|
|
"interpreted](http://ipython.org/ipython-doc/stable/interactive/htmlnotebook.html)).",
|
||
|
|
"",
|
||
|
|
"Once you open an existing notebook (like this one) or create a new one,",
|
||
|
|
"you are in the main notebook interface, which consists of a main editing",
|
||
|
|
"area (where these cells are contained) as well as a collapsible left panel, ",
|
||
|
|
"a permanent header area at the top, and a pager that rises from the",
|
||
|
|
"bottom when needed and can be collapsed again."
|
||
|
|
]
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"cell_type": "markdown",
|
||
|
|
"source": [
|
||
|
|
"### Main editing area",
|
||
|
|
"",
|
||
|
|
"Here, you can move with the arrow keys or using the ",
|
||
|
|
"scroll bars. The cursor enters code cells immediately, but only selects",
|
||
|
|
"text (markdown) cells without entering in them; to enter a text cell,",
|
||
|
|
"use `Enter`, and `Shift-Enter` to exit it again (just like to execute a ",
|
||
|
|
"code cell)."
|
||
|
|
]
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"cell_type": "markdown",
|
||
|
|
"source": [
|
||
|
|
"### Left panel",
|
||
|
|
"",
|
||
|
|
"This panel contains a number of panes that can be",
|
||
|
|
"collapsed vertically by clicking on their title bar, and the whole panel",
|
||
|
|
"can also be collapsed by clicking on the vertical divider (note that you",
|
||
|
|
"can not *drag* the divider, for now you can only click on it).",
|
||
|
|
"",
|
||
|
|
"The *Notebook* section contains actions that pertain to the whole notebook,",
|
||
|
|
"such as downloading the current notebook either in its original format",
|
||
|
|
"or as a `.py` script, and printing it. When you click the `Print` button,",
|
||
|
|
"a new HTML page opens with a static copy of the notebook; you can then",
|
||
|
|
"use your web browser's mechanisms to save or print this file.",
|
||
|
|
"",
|
||
|
|
"The *Cell* section lets you manipulate individual cells, and the names should ",
|
||
|
|
"be fairly self-explanatory.",
|
||
|
|
"",
|
||
|
|
"The *Kernel* section lets you signal the kernel executing your code. ",
|
||
|
|
"`Interrupt` does the equivalent of hitting `Ctrl-C` at a terminal, and",
|
||
|
|
"`Restart` fully kills the kernel process and starts a fresh one. Obviously",
|
||
|
|
"this means that all your previous variables are destroyed, but it also",
|
||
|
|
"makes it easy to get a fresh kernel in which to re-execute a notebook, perhaps",
|
||
|
|
"after changing an extension module for which Python's `reload` mechanism",
|
||
|
|
"does not work. If you check the 'Kill kernel upon exit' box, when you ",
|
||
|
|
"close the page IPython will automatically shut down the running kernel;",
|
||
|
|
"otherwise the kernels won't close until you stop the whole ",
|
||
|
|
"",
|
||
|
|
"The *Help* section contains links to the documentation of some projects",
|
||
|
|
"closely related to IPython as well as the minimal keybindings you need to",
|
||
|
|
"know. But you should use `Ctrl-m h` (or click the `QuickHelp` button at",
|
||
|
|
"the top) and learn some of the other keybindings, as it will make your ",
|
||
|
|
"workflow much more fluid and efficient.",
|
||
|
|
"",
|
||
|
|
"The *Configuration* section at the bottom lets you change some values",
|
||
|
|
"related to the display of tooltips and the behavior of the tab completer."
|
||
|
|
]
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"cell_type": "markdown",
|
||
|
|
"source": [
|
||
|
|
"### Header bar",
|
||
|
|
"",
|
||
|
|
"The header area at the top allows you to rename an existing ",
|
||
|
|
"notebook and open up a short help tooltip. This area also indicates",
|
||
|
|
"with a red **Busy** mark on the right whenever the kernel is busy executing",
|
||
|
|
"code."
|
||
|
|
]
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"cell_type": "markdown",
|
||
|
|
"source": [
|
||
|
|
"### The pager at the bottom",
|
||
|
|
"",
|
||
|
|
"Whenever IPython needs to display additional ",
|
||
|
|
"information, such as when you type `somefunction?` in a cell, the notebook",
|
||
|
|
"opens a pane at the bottom where this information is shown. You can keep",
|
||
|
|
"this pager pane open for reference (it doesn't block input in the main area)",
|
||
|
|
"or dismiss it by clicking on its divider bar."
|
||
|
|
]
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"cell_type": "markdown",
|
||
|
|
"source": [
|
||
|
|
"### Tab completion and tooltips",
|
||
|
|
"",
|
||
|
|
"The notebook uses the same underlying machinery for tab completion that ",
|
||
|
|
"IPython uses at the terminal, but displays the information differently.",
|
||
|
|
"Whey you complete with the `Tab` key, IPython shows a drop list with all",
|
||
|
|
"available completions. If you type more characters while this list is open,",
|
||
|
|
"IPython automatically eliminates from the list options that don't match the",
|
||
|
|
"new characters; once there is only one option left you can hit `Tab` once",
|
||
|
|
"more (or `Enter`) to complete. You can also select the completion you",
|
||
|
|
"want with the arrow keys or the mouse, and then hit `Enter`.",
|
||
|
|
"",
|
||
|
|
"In addition, if you hit `Tab` inside of open parentheses, IPython will ",
|
||
|
|
"search for the docstring of the last object left of the parens and will",
|
||
|
|
"display it on a tooltip. For example, type `list(<TAB>` and you will",
|
||
|
|
"see the docstring for the builtin `list` constructor:"
|
||
|
|
]
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"cell_type": "code",
|
||
|
|
"collapsed": true,
|
||
|
|
"input": [
|
||
|
|
"# Position your cursor after the ( and hit the Tab key:",
|
||
|
|
"list("
|
||
|
|
],
|
||
|
|
"language": "python",
|
||
|
|
"outputs": []
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"cell_type": "markdown",
|
||
|
|
"source": [
|
||
|
|
"## The frontend/kernel model",
|
||
|
|
"",
|
||
|
|
"The Jupyter notebook works on a client/server model where an *IPython kernel*",
|
||
|
|
"starts in a separate process and acts as a server to executes the code you type,",
|
||
|
|
"while the web browser provides acts as a client, providing a front end environment",
|
||
|
|
"for you to type. But one kernel is capable of simultaneously talking to more than",
|
||
|
|
"one client, and they do not all need to be of the same kind. All IPython frontends",
|
||
|
|
"are capable of communicating with a kernel, and any number of them can be active",
|
||
|
|
"at the same time. In addition to allowing you to have, for example, more than one",
|
||
|
|
"browser session active, this lets you connect clients with different user interface features.",
|
||
|
|
"",
|
||
|
|
"For example, you may want to connect a Qt console to your kernel and use it as a help",
|
||
|
|
"browser, calling `??` on objects in the Qt console (whose pager is more flexible than the",
|
||
|
|
"one in the notebook). You can start a new Qt console connected to your current kernel by ",
|
||
|
|
"using the `%qtconsole` magic, this will automatically detect the necessary connection",
|
||
|
|
"information.",
|
||
|
|
"",
|
||
|
|
"If you want to open one manually, or want to open a text console from a terminal, you can ",
|
||
|
|
"get your kernel's connection information with the `%connect_info` magic:"
|
||
|
|
]
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"cell_type": "code",
|
||
|
|
"collapsed": false,
|
||
|
|
"input": [
|
||
|
|
"%connect_info"
|
||
|
|
],
|
||
|
|
"language": "python",
|
||
|
|
"outputs": [
|
||
|
|
{
|
||
|
|
"output_type": "stream",
|
||
|
|
"stream": "stdout",
|
||
|
|
"text": [
|
||
|
|
"{",
|
||
|
|
" \"stdin_port\": 53970, ",
|
||
|
|
" \"ip\": \"127.0.0.1\", ",
|
||
|
|
" \"hb_port\": 53971, ",
|
||
|
|
" \"key\": \"30daac61-6b73-4bae-a7d9-9dca538794d5\", ",
|
||
|
|
" \"shell_port\": 53968, ",
|
||
|
|
" \"iopub_port\": 53969",
|
||
|
|
"}",
|
||
|
|
"",
|
||
|
|
"Paste the above JSON into a file, and connect with:",
|
||
|
|
" $> ipython <app> --existing <file>",
|
||
|
|
"or, if you are local, you can connect with just:",
|
||
|
|
" $> ipython <app> --existing kernel-dd85d1cc-c335-44f4-bed8-f1a2173a819a.json ",
|
||
|
|
"or even just:",
|
||
|
|
" $> ipython <app> --existing ",
|
||
|
|
"if this is the most recent IPython session you have started."
|
||
|
|
]
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"prompt_number": 4
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"cell_type": "markdown",
|
||
|
|
"source": [
|
||
|
|
"## The kernel's `raw_input` and `%debug`",
|
||
|
|
"",
|
||
|
|
"The one feature the notebook currently doesn't support as a client is the ability to send data to the kernel's",
|
||
|
|
"standard input socket. That is, if the kernel requires information to be typed interactively by calling the",
|
||
|
|
"builtin `raw_input` function, the notebook will be blocked. This happens for example if you run a script",
|
||
|
|
"that queries interactively for parameters, and very importantly, is how the interactive IPython debugger that ",
|
||
|
|
"activates when you type `%debug` works.",
|
||
|
|
"",
|
||
|
|
"So, in order to be able to use `%debug` or anything else that requires `raw_input`, you can either use a Qt ",
|
||
|
|
"console or a terminal console:",
|
||
|
|
"",
|
||
|
|
"- From the notebook, typing `%qtconsole` finds all the necessary connection data for you.",
|
||
|
|
"- From the terminal, first type `%connect_info` while still in the notebook, and then copy and paste the ",
|
||
|
|
"resulting information, using `qtconsole` or `console` depending on which type of client you want."
|
||
|
|
]
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"cell_type": "markdown",
|
||
|
|
"source": [
|
||
|
|
"## Display of complex objects",
|
||
|
|
"",
|
||
|
|
"As the 'tour' notebook shows, the Jupyter notebook has fairly sophisticated display capabilities. In addition",
|
||
|
|
"to the examples there, you can study the `display_protocol` notebook in this same examples folder, to ",
|
||
|
|
"learn how to customize arbitrary objects (in your own code or external libraries) to display in the notebook",
|
||
|
|
"in any way you want, including graphical forms or mathematical expressions."
|
||
|
|
]
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"cell_type": "markdown",
|
||
|
|
"source": [
|
||
|
|
"## Plotting support",
|
||
|
|
"",
|
||
|
|
"As we've explained already, the notebook is just another frontend talking to the same IPython kernel that",
|
||
|
|
"you're already familiar with, so the same options for plotting support apply.",
|
||
|
|
"",
|
||
|
|
"If you start the notebook with `--pylab`, you will get matplotlib's floating, interactive windows and you",
|
||
|
|
"can call the `display` function to paste figures into the notebook document. If you start it with ",
|
||
|
|
"`--pylab inline`, all plots will appear inline automatically. In this regard, the notebook works identically",
|
||
|
|
"to the Qt console.",
|
||
|
|
"",
|
||
|
|
"Note that if you start the notebook server with pylab support, *all* kernels are automatically started in",
|
||
|
|
"pylab mode and with the same choice of backend (i.e. floating windows or inline figures). But you can also",
|
||
|
|
"start the notebook server simply by typing `ipython notebook`, and then selectively turn on pylab support ",
|
||
|
|
"only for the notebooks you want by using the `%pylab` magic (see its docstring for details)."
|
||
|
|
]
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"cell_type": "code",
|
||
|
|
"collapsed": false,
|
||
|
|
"input": [
|
||
|
|
"%pylab inline",
|
||
|
|
"plot(rand(100))"
|
||
|
|
],
|
||
|
|
"language": "python",
|
||
|
|
"outputs": [
|
||
|
|
{
|
||
|
|
"output_type": "stream",
|
||
|
|
"stream": "stdout",
|
||
|
|
"text": [
|
||
|
|
"",
|
||
|
|
"Welcome to pylab, a matplotlib-based Python environment [backend: module://IPython.zmq.pylab.backend_inline].",
|
||
|
|
"For more information, type 'help(pylab)'."
|
||
|
|
]
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"output_type": "pyout",
|
||
|
|
"prompt_number": 5,
|
||
|
|
"text": [
|
||
|
|
"[<matplotlib.lines.Line2D at 0x11165bcd0>]"
|
||
|
|
]
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"output_type": "display_data",
|
||
|
|
"png": "iVBORw0KGgoAAAANSUhEUgAAAXgAAAD3CAYAAAAXDE8fAAAABHNCSVQICAgIfAhkiAAAAAlwSFlz\nAAALEgAACxIB0t1+/AAAIABJREFUeJztfXuUFdWd7nf63c2jG2hEEEGRNjQan0DjFaFvdJAsos6M\nmkhmnCw0czsmuWASTUImc5XMWomTuXfEMETbleDNqNHJmGRMfA7otO1dCS/HidpAEBFB3k032O9n\n3T+2m7NPnb2r9q7aVbXPOftbq1d3n1N1ap+qvb/66vv99m+nHMdxYGFhYWGRdyhKugEWFhYWFtHA\nEryFhYVFnsISvIWFhUWewhK8hYWFRZ7CEryFhYVFnsISvIWFhUWewpPg77jjDkyZMgWf/OQnhdus\nWbMGs2bNwpVXXondu3drb6CFhYWFRTB4EvzKlSvx0ksvCd/ftm0bXn/9dezYsQP33HMP7rnnHu0N\ntLCwsLAIBk+Cv+aaazBhwgTh+1u3bsUtt9yCiRMnYsWKFdi1a5f2BlpYWFhYBENJmJ23bduG22+/\n/cz/kydPxnvvvYcLLrgga9tUKhXmUBYWFhYFi6AFB0IFWR3HyTqwF5E7joNXX3XwyU86Z/YtxJ/7\n7rsv8TaY8mPPRf6ei/fec1Bdnfy5eP55B7t2JX8+gv6EQSiCb2howM6dO8/8f+LECcyaNctzn54e\nYHAwzFEtCgGPPgqMjCTdCosw6O8HenuTbgXwf/8v8MorSbdCDu3twNKl+j4vNMH/8pe/xMmTJ/Hz\nn/8c9fX1vvtYgldHXx/w/PNJtyJefOMbQGdn0q2wCIP+fmBoiPwkidOnyU8uoLMT2LdP3+d5evAr\nVqzAa6+9hvb2dpx77rlYu3Ythj6+Wk1NTViwYAEWLVqEefPmYeLEiXjiiSd8D2gJHmhsbFTa/u23\ngTVrgOXLo2lPkhCdCxOIIW6o9gvT0ddHfvf0ADU1avvqPBenTuUOwXd1AePH6/s8T4J/6qmnfD/g\ngQcewAMPPCB9wJ4eYGBAevO8hGrnHR5OD5Z8g+hcDA5ags919PeT3729yRJ8Lin4jz4Cxo3T93mx\nz2S1Cl4dw8NmeJlxYWQEcJzCI/h8AyX4np5k25FLBK9bwVuCzwEMDeWvgueB9o9CJ/j+fuCPfwR2\n7Ei6JcFgCsHnkkVjFXwBotAUPCX2Qu0n27cD06cD1dUk7rJwYW7e4FmLJikMDJB2nDqVXBtUkBcK\nfnTUpsCpYHiYdNRCOWeU4AtVwT/3HPC5zxFi3LsXmDiRKLtcgwkKnip3q+BjAr3YharOgmB4mPym\nAybfUegWzRtvAIsWAcXF5P9x44iyyzWYQvDl5blD8Hmh4AFL8CqgRFcoNk0hK3jHIZ77lVemX8t1\ngk+y3546BcyYkTsEbxV8AYIq+Fz0YYOgkBX84cPEijv33PRrJhB8ZyfQ0aG2D5sHnxROnwbOOYfc\nZMJYnCErBkjDKvgCBCV4q+DzH2+8QdQ7W9LJBIJ/6CFg3Tq1fUyxaCZMIOcwTBzjkkuAEyf0tUsE\nq+ALEJbgCweU4FmYQPCnTqm3ob8fKClJ3qKpriY/YWya48fjuQZ5oeBTKUvwKqBEV2gWTSH2kTfe\nAObNy3zNBILv6lIn6v5+YNKk5BV8TQ0h+DCpkoODaaEVJfJCwdfUFObgDQqr4AsDvAArYA7BqxJ1\nfz9J8UyS4HUp+LhKZ3R15QHBT5hgCV4FNshaGOAFWIHcJvhJk5IVJlTB19SEJ/i4FHzOWjSOYwk+\nCGyaZGGAF2AFzCH4XLRodCj40VFC7nEQfE4r+MFBoKgIGDPGErwKCs2iKVQFz/PfATMIvrs7Ny0a\n1oMPSvC0H0ZN8I6T4wTf00PIvazMErwKCs2iKXQF78b48ckTfBAF39cH1NbmfhZNXIKjrw8oLSU/\numAJPgeQCwq+rU3fZxUiwYsCrIAZCj6MB5/rCp5yVdQKXneKJJAgwRf6oh8qMD1Nsr8fuOIKfZ9X\niBaNKMAK5DbBT5yYfJCVKvigaZJxEbzuFEnAKvicwPAwufCmKvjBQfIzOqrn8wqxXLAowAokT/DD\nw8EW0DZBweu0aKyC94El+GCgBG+qgtetuAtRwYsCrED4afZh0dUFVFTknkXjOOS8VVeL0yTnzycB\nZC9YBS8JS/DBMDxM7uwmK3j2d1gUoge/axdw0UX895JW8F1dJFiqmiqYtEXT3U1KBZeW8hV8fz+J\ne/gRfFz9MS8UfFUVOemW4OUxNGQJPt/R30/GBg8mEPy4cUScqfTBpBU8DbACfII/epT89utnVsFL\nwir4YKAK3nSLRtc1pfMlCongh4bE6XFjxhCyTGpFL0rwVVVqZN3fT/rt6Ggy15L67wCf4A8fJr9N\nIfi8UPCW4NVhukWjOyg6NET6SaERfFkZ/71UipwPPyshKgRR8I5DBEllJbkxJNF33QrenUVz5Aj5\nbQrBWwVfoChEBV9VVXgE7zXBJUmbJoiCHxoipYKLi8mYT8KmoSmSADB2LHmiYPuUKsFbD94HluCD\noRA9+EJU8KYTvApR9/eTzBsgOYI/dSqt4FMpMobYbCSr4DXDEnwwmG7RREHwVVWF1UdyheBl+yBL\n8ElaNFTBA9mpktSD9+tn1oOXhCX4YMiVPHhr0QSHyQTf3a1u0Zii4FmCdwdaC0HBl+j9OG9Qggcs\nwavAWjT5D5MJPlctGjbICvAJvrraHILXXUkSsAo+J2B6kFV33rpV8NlImuDHjs09i0ZGwc+caU6Q\nVfdiH4Al+JxAIXrwVsFnImmCz0WLhqfgaark4CD5e+pUq+C1wRJ8MAwPk3zipCaM+CEKD15E8Hv2\nAF/5ip7jmIRcIHgVBd/Xl6ngk06TBDIV/LFjwOTJZFa9KQSf8wq+tzc3CP6Pf0y6BZmgg7+qykyb\nRoXgH3uMTILxgpeCP3AA2LJFvY2mY3DQfIJXVfCVleRv1RIHusCmSQKZBH/kCDBtGjnnphC8VfAx\noL8fuPTSpFuRieHhNMGbaNPIEnxPD3DHHf7fwStNcnAwuRmdUSJXFHyuWTSiNMnDh4k9o0LwMk/P\nzzxDvrsqoliuD7AEn4WBAfITxwK7shgeJrMCKytzW8HTtDS/AeAVZB0cTLa+eFTIFYIPGmQ1LU3y\nyBE1gq+okOOE73wHePdd9bZGsVwfIEHwra2tqK+vR11dHdavX89pWB++8IUv4PLLL8eSJUvw7LPP\nCj8rF1Z0MnH1JErwpip42Vo0dGKJ37n1smgGBqyCjxs6gqxJ16IBwhF8VZUcwQ8OBuO2KPx3QILg\nV69ejebmZmzevBkbNmxAe3t7xvs/+9nPMGbMGLz55pv453/+Z3z961+HIzBZc0HBm0jwtK5Hrit4\nSvA6FLyfj59ryAWCzyWLZmiIjJWxY9OvhfHgx4yRI/ihoWAEH4U9A/gQ/OmPz8bixYsxc+ZMLF26\nFFu3bs3Yprq6Gl1dXRgaGkJHRweqqqqQ4q07BvLlKyoswavCy4MfHdW3VF5QqBJ8WAU/PGxu/wmC\nkRFSK6W4WLyNKQSfK3nwdCUnlorYNEnqwctwkaqCD+LBJ6Lgt2/fjjlz5pz5f+7cudjiSmFYsWIF\nRkZGUFtbi0WLFuHJJ58Ufl5VFTnhJi/4QUklyEWKCl4WzQ9/CPyf/5NMuyh0K3gvgqfHyCcf3k+9\nA8kRPFWj5eW5lQfv9t+B8BaNTJA1qEUTlYIPXargn/7pn1BSUoIjR47g7bffxvLly/HBBx+gqCj7\n3uE49+P++4H2duDUqUYAjWEPrx0mKngvi+bDD8UrAcUFmuKnS8F7DSg6eLq7yXJw+QCTCZ4lnqB5\n8EkQvNt/B3LHg29paUFLS4v6h3DgSfDz58/Hvffee+b/trY2LFu2LGOb1tZW3HnnnaiqqkJDQwOm\nTZuGPXv2ZCh/iilTCMG/9x7w4ota2q8dlKRMIngvi6azM3k/mipuGYIvLdWj4PMp0JorBK+q4KmC\nTsKicadIAuk0yeFh4ORJYMoU
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"prompt_number": 5
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"cell_type": "markdown",
|
||
|
|
"source": [
|
||
|
|
"## Security",
|
||
|
|
"",
|
||
|
|
"By default the notebook only listens on localhost, so it does not expose your computer to attacks coming from",
|
||
|
|
"the internet. By default the notebook does not require any authentication, but you can configure it to",
|
||
|
|
"ask for a password before allowing access to the files. ",
|
||
|
|
"",
|
||
|
|
"Furthermore, you can require the notebook to encrypt all communications by using SSL and making all connections",
|
||
|
|
"using the https protocol instead of plain http. This is a good idea if you decide to run your notebook on",
|
||
|
|
"addresses that are visible from the internet. For further details on how to configure this, see the",
|
||
|
|
"[security section](http://ipython.org/ipython-doc/stable/interactive/htmlnotebook.html#security) of the ",
|
||
|
|
"manual.",
|
||
|
|
"",
|
||
|
|
"Finally, note that you can also run a notebook with the `--read-only` flag, which lets you provide access",
|
||
|
|
"to your notebook documents to others without letting them execute code (which can be useful to broadcast",
|
||
|
|
"a computation to colleagues or students, for example). The read-only flag behaves differently depending",
|
||
|
|
"on whether the server has a password or not:",
|
||
|
|
"",
|
||
|
|
"- Passwordless server: users directly see all notebooks in read-only mode.",
|
||
|
|
"- Password-protected server: users can see all notebooks in read-only mode, but a login button is available",
|
||
|
|
"and once a user authenticates, he or she obtains write/execute privileges.",
|
||
|
|
"",
|
||
|
|
"The first case above makes it easy to broadcast on the fly an existing notebook by simply starting a *second* ",
|
||
|
|
"notebook server in the same directory as the first, but in read-only mode. This can be done without having",
|
||
|
|
"to configure a password first (which requires calling a hashing function and editing a configuration file)."
|
||
|
|
]
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"cell_type": "code",
|
||
|
|
"collapsed": true,
|
||
|
|
"input": [],
|
||
|
|
"language": "python",
|
||
|
|
"outputs": []
|
||
|
|
}
|
||
|
|
]
|
||
|
|
}
|
||
|
|
]
|
||
|
|
}
|