Merge pull request ipython#54 from minrk/binder

make it work on Binder

Author: minrk

README.md

@@ -1,20 +1,22 @@
 # IPython in depth tutorial
 
+Try it out on Binder! [![Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/ipython/ipython-in-depth/master?filepath=binder%2FIndex.ipynb)
+
 In its current form, this tutorial is meant to be executed with Jupyter notebook
 5.0, using IPython 6.0 or newer on Python 3, the latest IPython version
 compatible with Python 2 is IPython 5.x that may not have the exact same
-behavior and all the features presented in this tutorial. 
+behavior and all the features presented in this tutorial.
 
 
 You can find our installation instructions [for
-IPython](http://ipython.org/install.html) and [Jupyter
-notebook](http://jupyter.readthedocs.io/en/latest/install.html)
+IPython](https://ipython.org/install.html) and [Jupyter
+notebook](https://jupyter.readthedocs.io/en/latest/install.html)
 
 To get the tutorial, checkout the `ipython-in-depth` repo:
 
     git clone https://github.com/ipython/ipython-in-depth
 
-Or just [download current
+Or [download current
 master](https://github.com/ipython/ipython-in-depth/zipball/master) and unzip
 it.
 
@@ -35,7 +37,7 @@ Change directory inside the directory newly created:
 
     cd ipython-in-depth
 
-You can then start the IPython notebook server at a terminal with:
+You can then start the Jupyter notebook server at a terminal with:
 
     jupyter notebook
 
@@ -50,4 +52,4 @@ time:
   $ docker pull jupyter/datascience-notebook
 
 The image contains a installation of the Jupyter notebook with R, Julia,
-Python2, Python3 and a couple of library for each language.
+Python2, Python3 and a couple of libraries for each language.

binder/Index.ipynb

@@ -0,0 +1,75 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Welcome to Jupyter!"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "This repo contains an introduction to [Jupyter](https://jupyter.org) and [IPython](https://ipython.org).\n",
+    "\n",
+    "Outline of some basics:\n",
+    "\n",
+    "* [Notebook Basics](../examples/Notebook/Notebook Basics.ipynb)\n",
+    "* [IPython - beyond plain python](../examples/IPython Kernel/Beyond Plain Python.ipynb)\n",
+    "* [Markdown Cells](../examples/Notebook/Working With Markdown Cells.ipynb)\n",
+    "* [Rich Display System](../examples/IPython Kernel/Rich Output.ipynb)\n",
+    "* [Custom Display logic](../examples/IPython%20Kernel/Custom%20Display%20Logic.ipynb)\n",
+    "* [Running a Secure Public Notebook Server](../examples/Notebook/Running%20the%20Notebook%20Server.ipynb#Securing-the-notebook-server)\n",
+    "* [How Jupyter works](../examples/Notebook/Multiple%20Languages%2C%20Frontends.ipynb) to run code in different languages."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "You can also get this tutorial and run it on your laptop:\n",
+    "\n",
+    "    git clone https://github.com/ipython/ipython-in-depth\n",
+    "\n",
+    "Install IPython and Jupyter:\n",
+    "\n",
+    "with [conda](https://www.anaconda.com/download):\n",
+    "\n",
+    "    conda install ipython jupyter\n",
+    "\n",
+    "with pip:\n",
+    "\n",
+    "    # first, always upgrade pip!\n",
+    "    pip install --upgrade pip\n",
+    "    pip install --upgrade ipython jupyter\n",
+    "\n",
+    "Start the notebook in the tutorial directory:\n",
+    "\n",
+    "    cd ipython-in-depth\n",
+    "    jupyter notebook"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.6.3"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

binder/apt.txt

@@ -0,0 +1 @@
+texlive

binder/environment.yml

@@ -0,0 +1,17 @@
+channels:
+  - conda-forge
+  - defaults
+dependencies:
+  - python=3.6
+  - cython
+  - ipython
+  - ipyparallel
+  - ipywidgets
+  - numpy
+  - matplotlib
+  - mpi4py
+  - networkx
+  - pandas
+  - scikit-image
+  - scikit-learn
+  - sympy

examples/Notebook/Multiple Languages, Frontends.ipynb

@@ -4,10 +4,10 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# How IPython works\n",
+    "# How Jupyter works\n",
     "\n",
     "\n",
-    "## Terminal IPython\n",
+    "## ...But first, Terminal IPython\n",
     "\n",
     "When you type `ipython`, you get the original IPython interface, running in\n",
     "the terminal. It does something like this:\n",
@@ -19,7 +19,7 @@
     "```\n",
     "\n",
     "Of course, it's much more complex, because it has to deal with multi-line\n",
-    "code, tab completion using `readline`, magic commands, and so on. But the\n",
+    "code, tab completion using `readline` or `prompt-toolkit`, magic commands, and so on. But the\n",
     "model is like that: prompt the user for some code, and when they've entered it,\n",
     "exec it in the same process. This model is often called a REPL, or\n",
     "Read-Eval-Print-Loop."
@@ -29,14 +29,14 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## The IPython Kernel\n",
+    "## Jupyter and The IPython Kernel\n",
     "\n",
-    "All the other interfaces—the Notebook, the Qt console, `ipython console` in\n",
+    "Jupyter expands on this REPL model and provides other interfaces to running code–the notebook, the Qt console, `jupyter console` in\n",
     "the terminal, and third party interfaces—use the IPython Kernel. This is a\n",
     "separate process which is responsible for running user code, and things like\n",
     "computing possible completions. Frontends communicate with it using JSON\n",
     "messages sent over [ZeroMQ](http://zeromq.org/) sockets; the protocol they use is described in\n",
-    ":doc:`messaging`.\n",
+    "[the jupyter protocol](https://jupyter-client.readthedocs.io/en/stable/messaging.html).\n",
     "\n",
     "The core execution machinery for the kernel is shared with terminal IPython:\n",
     "\n",
@@ -213,7 +213,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.6.0"
+   "version": "3.6.3"
   }
  },
  "nbformat": 4,

examples/Notebook/Running Code.ipynb

@@ -30,21 +30,17 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
-   "metadata": {
-    "collapsed": false
-   },
+   "execution_count": 3,
+   "metadata": {},
    "outputs": [],
    "source": [
     "a = 10"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 2,
-   "metadata": {
-    "collapsed": false
-   },
+   "execution_count": 4,
+   "metadata": {},
    "outputs": [
     {
      "name": "stdout",
@@ -85,9 +81,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {
-    "collapsed": false
-   },
+   "metadata": {},
    "outputs": [],
    "source": [
     "import time\n",
@@ -105,9 +99,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {
-    "collapsed": false
-   },
+   "metadata": {},
    "outputs": [],
    "source": [
     "import sys\n",
@@ -170,9 +162,7 @@
   {
    "cell_type": "code",
    "execution_count": 2,
-   "metadata": {
-    "collapsed": false
-   },
+   "metadata": {},
    "outputs": [
     {
      "name": "stdout",
@@ -189,9 +179,7 @@
   {
    "cell_type": "code",
    "execution_count": 3,
-   "metadata": {
-    "collapsed": false
-   },
+   "metadata": {},
    "outputs": [
     {
      "name": "stderr",
@@ -223,9 +211,7 @@
   {
    "cell_type": "code",
    "execution_count": 4,
-   "metadata": {
-    "collapsed": false
-   },
+   "metadata": {},
    "outputs": [
     {
      "name": "stdout",
@@ -266,9 +252,7 @@
   {
    "cell_type": "code",
    "execution_count": 5,
-   "metadata": {
-    "collapsed": false
-   },
+   "metadata": {},
    "outputs": [
     {
      "name": "stdout",
@@ -342,9 +326,7 @@
   {
    "cell_type": "code",
    "execution_count": 6,
-   "metadata": {
-    "collapsed": false
-   },
+   "metadata": {},
    "outputs": [
     {
      "name": "stdout",
@@ -861,24 +843,30 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {
-    "collapsed": false
-   },
+   "metadata": {},
    "outputs": [],
    "source": []
   }
  ],
  "metadata": {
   "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
    "codemirror_mode": {
     "name": "ipython",
     "version": 3
    },
-   "display_name": "IPython (Python 3)",
-   "language": "python",
-   "name": "python3"
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.6.2"
   }
  },
  "nbformat": 4,
- "nbformat_minor": 0
-}
+ "nbformat_minor": 1
+}

examples/Notebook/Typesetting Equations.ipynb

@@ -24,6 +24,7 @@
     "\\end{align}\n",
     "```\n",
     "### Display\n",
+    "\n",
     "\\begin{align}\n",
     "\\dot{x} & = \\sigma(y-x) \\\\\n",
     "\\dot{y} & = \\rho x - y - xz \\\\\n",
@@ -247,7 +248,25 @@
    ]
   }
  ],
- "metadata": {},
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.6.2"
+  }
+ },
  "nbformat": 4,
- "nbformat_minor": 0
-}
+ "nbformat_minor": 1
+}