notebook/README.md

62 lines
2.9 KiB
Markdown
Raw Normal View History

2015-04-11 07:20:18 +08:00
# Jupyter Notebook
2015-09-25 22:27:45 +08:00
[![Google Group](https://img.shields.io/badge/-Google%20Group-lightgrey.svg)](https://groups.google.com/forum/#!forum/jupyter)
[![Build Status](https://travis-ci.org/jupyter/notebook.svg?branch=master)](https://travis-ci.org/jupyter/notebook)
2016-11-03 12:17:08 +08:00
[![Documentation Status](https://readthedocs.org/projects/jupyter-notebook/badge/?version=latest)](http://jupyter-notebook.readthedocs.io/en/latest/?badge=latest)
2016-09-26 09:35:02 +08:00
2015-09-25 22:27:45 +08:00
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
![Jupyter notebook example](docs/resources/running_code_med.png "Jupyter notebook example")
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
2016-09-22 21:20:19 +08:00
Jupyter notebook is a language-agnostic HTML notebook application for
Project Jupyter. In 2015, Jupyter notebook was released as a part of
2016-09-22 21:20:19 +08:00
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 across 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](https://blog.jupyter.org/the-big-split-9d7b88a031a7)]
[[Jupyter Ascending blog post](https://blog.jupyter.org/jupyter-ascending-1bf5b362d97e)]
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](https://jupyter.readthedocs.io/en/latest/install.html).
2016-01-05 01:11:19 +08:00
The documentation for advanced usage of Jupyter notebook can be found
[here](https://jupyter-notebook.readthedocs.io/en/latest/).
2015-12-28 16:00:40 +08:00
For a local installation, make sure you have
[pip installed](https://pip.readthedocs.io/en/stable/installing/) and run:
2015-12-28 16:00:40 +08:00
$ 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
## 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)
- [Documentation for Jupyter notebook](https://jupyter-notebook.readthedocs.io/en/latest/) [[PDF](https://media.readthedocs.org/pdf/jupyter-notebook/latest/jupyter-notebook.pdf)]
- [Korean Version of Installation](https://github.com/ChungJooHo/Jupyter_Kor_doc/)
- [Documentation for Project Jupyter](https://jupyter.readthedocs.io/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)