Go to file

Carol Willing 2ef91bb64f Add links to CONTRIBUTING.rst		10 years ago
docs	Merge pull request #1208 from mgeier/devel-docs	10 years ago
git-hooks	Update githooks and description	10 years ago
notebook	Merge pull request #1249 from blink1073/plugin-update	10 years ago
scripts	scripts/lxc-launcher.sh: Remove the LXC launcher as it is now unused.	10 years ago
tools	Add source maps, chunks, and remove previous build tool	10 years ago
.bowerrc	s/jupyter_notebook/notebook	11 years ago
.dockerignore	Adds a .dockerignore	10 years ago
.gitignore	Add a jupyter lab page	10 years ago
.gitmodules	remove submodule	11 years ago
.mailmap	fix backward n_pulls, n_issues in github stats	11 years ago
.travis.yml	retry js tests on travis	10 years ago
CONTRIBUTING.rst	Add instructions for getting the doc-building requirements	10 years ago
COPYING.md	package skeleton	11 years ago
Dockerfile	Dockerfile: Add missing `--no-cache-dir` option.	10 years ago
MANIFEST.in	Add missing files to manifest	11 years ago
README.md	Add links to CONTRIBUTING.rst	10 years ago
bower.json	Re-add moment	10 years ago
circle.yml	circle.yml: Build the Dockerfile as a test step.	10 years ago
package.json	simplify js build steps	10 years ago
readthedocs.yml	Add nbsphinx to conda yaml	10 years ago
setup.cfg	Show warnings during tests	10 years ago
setup.py	Add instructions for getting the doc-building requirements	10 years ago
setupbase.py	Fix webpack static file configuration	10 years ago
webpack.config.js	Don't use arrow functions in webpack js config	10 years ago

README.md

Jupyter Notebook

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. [The Big Split™ announcement] [Jupyter Ascending blog post]

Installation

You can find the installation documentation for the Jupyter platform, on ReadTheDocs. The documentation for advanced usage of Jupyter notebook can be found here.

For a local installation, make sure you have pip installed and run:

$ pip install notebook

Usage - Running Jupyter notebook

Running in a local installation

Launch with:

$ jupyter notebook

Running in a Docker container

If you are using Linux and have a Docker daemon running, 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/. All notebooks from your session will be saved in the current directory.

On other platforms, such as Windows and OS X, that use docker-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>:

$ docker-machine ip <MACHINE>

For example,

$ docker-machine ip myjupytermachine
192.168.99.104

In browser, open http://192.168.99.104:8888.

NOTE: With the deprecated boot2docker, use the command boot2docker ip to determine the URL.

Development Installation

See CONTRIBUTING.rst for how to set up a local development installation.

Contributing

If you are interested in contributing to the project, see CONTRIBUTING.rst.