mirror of
https://github.com/jupyter/notebook.git
synced 2024-12-15 04:00:34 +08:00
135 lines
5.3 KiB
Markdown
135 lines
5.3 KiB
Markdown
# Jupyter Notebook
|
|
|
|
[](https://groups.google.com/forum/#!forum/jupyter)
|
|
[](https://travis-ci.org/jupyter/notebook)
|
|
[](http://jupyter-notebook.readthedocs.org/en/latest/?badge=latest)
|
|
|
|
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](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/)]
|
|
|
|
## 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
|
|
|
|
### 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](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/`.
|
|
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`](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/):
|
|
|
|
$ 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 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.
|
|
|
|
For more detailed development install instructions (e.g. recompiling javascript
|
|
and css, running tests), see the
|
|
[Developer Documentation](https://jupyter-notebook.readthedocs.org/en/latest/development_js.html)
|
|
on ReadTheDocs and the [contributing guide](CONTRIBUTING.md).
|
|
|
|
### Ubuntu Trusty
|
|
|
|
```
|
|
sudo apt-get install nodejs-legacy npm python-virtualenv python-dev
|
|
# ensure setuptools/pip are up-to-date
|
|
pip install --upgrade setuptools pip
|
|
git clone https://github.com/jupyter/notebook.git
|
|
cd notebook
|
|
pip install --pre -e .
|
|
jupyter notebook
|
|
```
|
|
|
|
### FreeBSD
|
|
|
|
```
|
|
cd /usr/ports/www/npm
|
|
sudo make install # (Be sure to select the "NODE" option)
|
|
cd /usr/ports/devel/py-pip
|
|
sudo make install
|
|
cd /usr/ports/devel/py-virtualenv
|
|
sudo make install
|
|
cd /usr/ports/shells/bash
|
|
sudo make install
|
|
mkdir -p ~/.virtualenvs
|
|
python2.7 -m virtualenv ~/.virtualenvs/notebook
|
|
bash
|
|
source ~/.virtualenvs/notebook/bin/activate
|
|
pip install --upgrade setuptools pip pycurl
|
|
git clone https://github.com/jupyter/notebook.git
|
|
cd notebook
|
|
pip install -r requirements.txt -e .
|
|
jupyter notebook
|
|
```
|
|
|
|
## Contributing
|
|
|
|
If you are interested in contributing to the project, you can find information about the
|
|
contribution process in the [Jupyter Contribution Guidelines]
|
|
(http://jupyter.readthedocs.org/en/latest/contrib_guide_code.html).
|
|
|
|
## 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)
|