JupyterLab

An extensible computational environment for Jupyter.

API Docs

Jupyter Notebook Extension

Prerequisites

• Jupyter notebook 4.2+

Developer Installation

git clone https://github.com/jupyter/jupyterlab.git
pip install -e jupyterlab
jupyter serverextension enable --py jupyterlab

Use

Start up the Jupyter notebook, and then open a browser to the server's URL with path /lab (e.g., http://localhost:8888/lab).

NPM Package Install

Prerequisites

• node
• python

npm install --save jupyterlab
conda install notebook  # notebook 4.2+ required

NPM Source Build

Prerequisites

• git
• node 0.12+
• python

git clone https://github.com/jupyter/jupyterlab.git
cd jupyterlab
npm install
npm run build
conda install notebook  # notebook 4.2+ required

Rebuild

npm run clean
npm run build

Run Tests

Follow the source build instructions first.

npm test

Build Example

Follow the source build instructions first. Requires a Python install with the Jupyter notebook (version 4.2 or later).

npm run build:examples

Change to the appropriate example in the examples directory and run python main.py.

Build Docs

Follow the source build instructions first.

npm run docs

Navigate to docs/index.html.

Supported Runtimes

The runtime versions which are currently known to work are listed below. Earlier versions may also work, but come with no guarantees.

• IE 11+
• Firefox 32+
• Chrome 38+

Note: "requirejs" must be included in a global context (usually as a <script> tag) for Comm targets.

Bundle for the Browser

Follow the package install instructions first.

Any bundler that understands how to require() files with .js and .css extensions can be used with this package.

Usage Examples

Note: This module is fully compatible with Node/Babel/ES6/ES5. Simply omit the type declarations when using a language other than TypeScript.