2015-04-11 07:20:18 +08:00
|
|
|
# Jupyter Notebook
|
|
|
|
|
|
2015-09-25 22:27:45 +08:00
|
|
|
[](https://groups.google.com/forum/#!forum/jupyter)
|
|
|
|
|
[](https://travis-ci.org/jupyter/notebook)
|
|
|
|
|
[](http://jupyter-notebook.readthedocs.org/en/latest/?badge=latest)
|
|
|
|
|
|
2015-12-28 16:00:40 +08:00
|
|
|
The Jupyter notebook is a web-based notebook environment for interactive
|
|
|
|
|
computing.
|
2015-04-11 07:20:18 +08:00
|
|
|
|
2015-12-28 23:31:23 +08:00
|
|
|
|
2015-12-28 16:36:12 +08:00
|
|
|
|
2015-12-28 23:33:37 +08:00
|
|
|
### Jupyter notebook, the language-agnostic evolution of IPython notebook
|
2015-12-28 23:15:07 +08:00
|
|
|
Jupyter notebook is the language-agnostic HTML notebook application for
|
|
|
|
|
Project Jupyter. In 2015, Jupyter notebook was released as part of
|
2015-12-28 23:42:28 +08:00
|
|
|
The Big Split™ of the IPython codebase. IPython 3 was the last major monolithic
|
2015-12-28 23:15:07 +08:00
|
|
|
release containing both language-agnostic code, such as the *IPython notebook*,
|
|
|
|
|
and language specific code, such as the *IPython kernel for Python*. As
|
2015-12-28 23:31:23 +08:00
|
|
|
computing spans many languages, Project Jupyter will continue to develop the
|
2015-12-28 23:15:07 +08:00
|
|
|
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.
|
2016-01-05 01:11:19 +08:00
|
|
|
[[The Big Split™ announcement](https://blog.jupyter.org/2015/04/15/the-big-split/)]
|
|
|
|
|
[[Jupyter Ascending blog post](http://blog.jupyter.org/2015/08/12/first-release-of-jupyter/)]
|
2015-12-28 23:15:07 +08:00
|
|
|
|
2015-12-28 16:00:40 +08:00
|
|
|
## Installation
|
2015-12-29 00:35:10 +08:00
|
|
|
You can find the installation documentation for the
|
|
|
|
|
[Jupyter platform, on ReadTheDocs](http://jupyter.readthedocs.org/en/latest/install.html).
|
2016-01-05 01:11:19 +08:00
|
|
|
The documentation for advanced usage of Jupyter notebook can be found
|
2015-12-29 00:35:10 +08:00
|
|
|
[here](http://jupyter-notebook.readthedocs.org/en/latest).
|
2015-12-28 16:00:40 +08:00
|
|
|
|
|
|
|
|
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
|
2015-10-07 07:56:31 +08:00
|
|
|
|
2015-12-28 16:00:40 +08:00
|
|
|
### Running in a local installation
|
2015-10-07 07:56:31 +08:00
|
|
|
|
|
|
|
|
Launch with:
|
|
|
|
|
|
|
|
|
|
$ jupyter notebook
|
|
|
|
|
|
2016-03-15 03:21:27 +08:00
|
|
|
## Development Installation
|
|
|
|
|
|
2016-03-25 06:05:01 +08:00
|
|
|
See [`CONTRIBUTING.rst`](CONTRIBUTING.rst) for how to set up a local development installation.
|
2015-12-28 22:45:31 +08:00
|
|
|
|
2016-02-25 01:08:45 +08:00
|
|
|
## Contributing
|
|
|
|
|
|
2016-03-25 06:05:01 +08:00
|
|
|
If you are interested in contributing to the project, see [`CONTRIBUTING.rst`](CONTRIBUTING.rst).
|
2016-02-25 01:08:45 +08:00
|
|
|
|
2015-12-28 22:45:31 +08:00
|
|
|
## Resources
|
|
|
|
|
- [Project Jupyter website](https://jupyter.org)
|
|
|
|
|
- [Online Demo at try.jupyter.org](https://try.jupyter.org)
|
2015-12-29 00:11:25 +08:00
|
|
|
- [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)]
|
2015-12-28 22:45:31 +08:00
|
|
|
- [Issues](https://github.com/jupyter/notebook/issues)
|
2016-01-05 01:11:19 +08:00
|
|
|
- [Technical support - Jupyter Google Group](https://groups.google.com/forum/#!forum/jupyter)
|
