mirror of https://github.com/jupyter/notebook.git synced 2025-03-01 12:56:54 +08:00

Go to file

Min RK 71c5057ae5 Merge pull request #876 from SylvainCorlay/no_body_class Multi-select: avoid adding a css class to body element		2015-12-17 14:52:31 +01:00
docs	add clear_output option to set_next_input payload	2015-12-15 14:41:36 +01:00
git-hooks
notebook	Merge pull request #876 from SylvainCorlay/no_body_class	2015-12-17 14:52:31 +01:00
scripts	scripts/lxc-launcher.sh: Remove the LXC launcher as it is now unused.	2015-10-08 00:47:02 -04:00
tools	Merge pull request #760 from Carreau/secure-server	2015-12-09 18:37:55 -08:00
.bowerrc
.dockerignore	Adds a .dockerignore	2015-10-06 00:01:27 +02:00
.gitignore	Add generated notebooks rst files to version control	2015-09-24 15:16:38 -07:00
.gitmodules
.mailmap
.travis.yml	Rework multiple selections to be continuous	2015-12-02 14:15:09 +01:00
bower.json	CodeMirror 5.8	2015-10-21 14:57:15 +01:00
CONTRIBUTING.md	Flesh out development installation instructions	2015-11-02 09:44:02 -08:00
COPYING.md
Dockerfile	Dockerfile: Add a basic jupyter notebook profile. Allow for IPs from anywhere to connect by adding this into the the jupyter notebook profile.	2015-10-12 09:18:39 -04:00
MANIFEST.in
package.json
README.md	Flesh out development installation instructions	2015-11-02 09:44:02 -08:00
setup.cfg
setup.py	Assume versions are normalised in setup.py	2015-12-14 16:58:42 +01:00
setupbase.py	Assume versions are normalised in setup.py	2015-12-14 16:58:42 +01:00

README.md

Jupyter Notebook

The Jupyter HTML notebook is a web-based notebook environment for interactive computing.

Usage

Local installation

Launch with:

$ jupyter notebook

In a Docker container

If you 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 without docker, this can be started using docker-machine by replacing localhost with an IP from docker-machine ip <MACHINE>. With the deprecated boot2docker, this IP will be boot2docker ip.

Installation

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

$ pip install notebook

Dev quickstart

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), please see the contributing guide.

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