mirror of https://github.com/jupyter/notebook.git synced 2024-12-15 04:00:34 +08:00

Go to file

John Kirkham fb07ccb06f README.md: Make note about using `docker-machine` or `boot2docker`.		2015-10-08 00:47:02 -04:00
docs	Merge pull request #508 from jdfreder/handlerdoc	2015-10-03 16:46:27 +02:00
git-hooks	Update githooks and description	2015-09-16 11:47:53 -07:00
notebook	Make the subarea not have a scrollbar when the enclosing output area already provides scrollbars	2015-10-06 16:27:18 -04:00
scripts	Adds an entrypoint to the Docker image	2015-10-06 00:01:27 +02:00
tools	start workign on typeahead	2015-08-10 17:35:45 -07:00
.bowerrc	s/jupyter_notebook/notebook	2015-05-14 10:49:28 -07:00
.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	remove submodule	2015-04-21 15:37:09 -07:00
.mailmap	fix backward n_pulls, n_issues in github stats	2015-04-03 13:05:18 -07:00
.travis.yml	shrink travis matrix	2015-09-30 16:06:15 +02:00
bower.json	bump term.js to 0.0.7	2015-09-11 15:08:42 +02:00
CONTRIBUTING.md	package skeleton	2015-04-21 15:37:06 -07:00
COPYING.md	package skeleton	2015-04-21 15:37:06 -07:00
Dockerfile	Dockerfile: Install all `apt-get` dependencies first and purge all unneeded things. Install `pip` in a separate layer. Separate out adding link into a layer. Install ipython dependencies in another layer.	2015-10-08 00:47:02 -04:00
MANIFEST.in	Add missing files to manifest	2015-07-27 14:54:38 -07:00
package.json	Revert "Use NPM, node ES5, and browserify."	2015-08-27 09:00:15 +02:00
README.md	README.md: Make note about using `docker-machine` or `boot2docker`.	2015-10-08 00:47:02 -04:00
setup.cfg	package skeleton	2015-04-21 15:37:06 -07:00
setup.py	formatting for long_description	2015-09-22 21:25:47 +02:00
setupbase.py	shell=True wants a string cmd	2015-09-07 12:12:24 +02: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 -d -p "8888:8888" --name="myproject" jupyter/notebook

In your browser open the URL http://localhost:8888/.

The image defines a volume for notebook files at /notebooks. You can override it to mount a host path, e.g. the current working directory:

$ docker run -d -p "8888:8888" -v "$(pwd):/notebooks" --name="myproject" jupyter/notebook

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.

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