mirror of https://github.com/jupyter/notebook.git synced 2024-12-09 03:50:45 +08:00

Go to file

Peter Parente f27c5c8a38 Additional changelog updates for 4.1 * Grammar consistency * More details about how users trigger new features * Screenshot of new location of cell toolbar triggers * Couple more "other improvements" * Links to PR and issue lists in the 4.1 milestone on GitHub (c) Copyright IBM Corp. 2015		2015-12-15 07:51:15 -05:00
docs	Additional changelog updates for 4.1	2015-12-15 07:51:15 -05:00
git-hooks
notebook	Merge pull request #868 from SylvainCorlay/prompt_number_select	2015-12-14 18:05:50 +01:00
scripts
tools	Merge pull request #760 from Carreau/secure-server	2015-12-09 18:37:55 -08:00
.bowerrc
.dockerignore
.gitignore
.gitmodules
.mailmap
.travis.yml	Rework multiple selections to be continuous	2015-12-02 14:15:09 +01:00
bower.json
CONTRIBUTING.md	Flesh out development installation instructions	2015-11-02 09:44:02 -08:00
COPYING.md
Dockerfile
MANIFEST.in
package.json
README.md	Flesh out development installation instructions	2015-11-02 09:44:02 -08:00
setup.cfg
setup.py	Remove explicit Python 3.3 classifier	2015-12-01 15:00:37 +00:00
setupbase.py

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