@ -4,45 +4,86 @@
[](https://travis-ci.org/jupyter/notebook)
[](http://jupyter-notebook.readthedocs.org/en/latest/?badge=latest)
The Jupyter HTML notebook is a web-based notebook environment for interactive computing.
The Jupyter notebook is a web-based notebook environment for interactive
computing.

### Jupyter notebook, the language-agnostic evolution of IPython notebook
Jupyter notebook is the language-agnostic HTML notebook application for
Project Jupyter. In 2015, Jupyter notebook was released as part of
The Big Split™ of the IPython codebase. IPython 3 was the last major monolithic
release containing both language-agnostic code, such as the *IPython notebook* ,
and language specific code, such as the *IPython kernel for Python* . As
computing spans many languages, Project Jupyter will continue to develop the
language-agnostic **Jupyter notebook** in this repo and with the help of the
community develop language specific kernels which are found in their own
discrete repos.
[]
[]
## Usage
## Installation
You can find the installation documentation for the
[Jupyter platform, on ReadTheDocs ](http://jupyter.readthedocs.org/en/latest/install.html ).
The documentation for advanced usage of Jupyter notebook can be found
[here ](http://jupyter-notebook.readthedocs.org/en/latest ).
For a local installation, make sure you have
[pip installed ](https://pip.readthedocs.org/en/stable/installing/ ) and run:
$ pip install notebook
## Usage - Running Jupyter notebook
### Local installation
### Running in a l ocal installation
Launch with:
$ jupyter notebook
### In a Docker container
### Running i n a Docker container
If you have a [Docker daemon running ](https://docs.docker.com/installation/ ), e.g. reachable on `localhost` , start a container with:
If you are using **Linux** and have a
[Docker daemon running ](https://docs.docker.com/installation/ ),
e.g. reachable on `localhost` , start a container with:
$ docker run --rm -it -p 8888:8888 -v "$(pwd):/notebooks" jupyter/notebook
In your browser open the URL `http://localhost:8888/` .
In your browser, open the URL `http://localhost:8888/` .
All notebooks from your session will be saved in the current directory.
On other platforms without `docker` , this can be started using `docker-machine`
by replacing `localhost` with an IP from [`docker-machine ip <MACHINE>` ](https://docs.docker.com/machine/reference/ip/ ).
With the deprecated `boot2docker` , this IP will be `boot2docker ip` .
On other platforms, such as **Windows and OS X** , that use
[`docker-machine` ](https://docs.docker.com/machine/install-machine/ ) with `docker` , a container can be started using
`docker-machine` . In the browser, open the URL `http://ip:8888/` where `ip` is
the IP address returned from the command [`docker-machine ip <MACHINE>` ](https://docs.docker.com/machine/reference/ip/ ):
## Installation
$ docker-machine ip < MACHINE >
For a local installation, make sure you have [pip installed ](https://pip.readthedocs.org/en/stable/installing/ ) and run:
For example,
$ pip install notebook
$ docker-machine ip myjupytermachine
192.168.99.104
In browser, open `http://192.168.99.104:8888` .
### Dev quickstart
NOTE: With the deprecated `boot2docker` , use the command `boot2docker ip` to
determine the URL.
* ensure that you have node/npm installed (e.g. `brew install node` on OS X)
* Clone this repo and cd into it
## Development Installation Quickstart
Detailed [Developer Documentation ](http://jupyter-notebook.readthedocs.org/en/latest )
is available on ReadTheDocs.
* Ensure that you have node/npm installed (e.g. `brew install node` on OS X)
* Clone this repo and `cd` into it
* `pip install --pre -e .`
_NOTE_: For Debian/Ubuntu systems, if you're installing the system node you need
to use the 'nodejs-legacy' package and not the 'node' package.
NOTE: For ** Debian/Ubuntu** systems, if you're installing the system node you
need to use the 'nodejs-legacy' package and not the 'node' package.
For more detailed development install instructions (e.g. recompiling javascript and css, running tests), please see the [contributing guide ](CONTRIBUTING.md ).
For more detailed development install instructions (e.g. recompiling javascript
and css, running tests), see the
[Developer Documentation ](http://jupyter-notebook.readthedocs.org/en/latest )
on ReadTheDocs and the [contributing guide ](CONTRIBUTING.md ).
### Ubuntu Trusty
@ -77,3 +118,11 @@ cd notebook
pip install -r requirements.txt -e .
jupyter notebook
```
## Resources
- [Project Jupyter website ](https://jupyter.org )
- [Online Demo at try.jupyter.org ](https://try.jupyter.org )
- [Documentation for Jupyter notebook ](http://jupyter-notebook.readthedocs.org/en/latest/ ) [[PDF ](https://media.readthedocs.org/pdf/jupyter-notebook/latest/jupyter-notebook.pdf )]
- [Documentation for Project Jupyter ](http://jupyter.readthedocs.org/en/latest/index.html ) [[PDF ](https://media.readthedocs.org/pdf/jupyter/latest/jupyter.pdf )]
- [Issues ](https://github.com/jupyter/notebook/issues )
- [Technical support - Jupyter Google Group ](https://groups.google.com/forum/#!forum/jupyter )