|
@@ -10,10 +10,7 @@ An extensible computational environment for Jupyter.
|
|
|
Jupyter Notebook Extension
|
|
|
--------------------------
|
|
|
|
|
|
-The Jupyter notebook extension source files are in the `jupyterlab/` subdirectory.
|
|
|
-
|
|
|
-### Prerequisites
|
|
|
-- Jupyter notebook 4.2+
|
|
|
+The Jupyter notebook extension source files are in the `jupyterlab/` subdirectory. To use this extension, you need Jupyter notebook version 4.2 or later.
|
|
|
|
|
|
### User installation
|
|
|
```
|
|
@@ -31,46 +28,36 @@ You will need npm (preferably version 5 or later).
|
|
|
git clone https://github.com/jupyter/jupyterlab.git
|
|
|
cd jupyterlab
|
|
|
npm install
|
|
|
-npm run build
|
|
|
-python setup.py build
|
|
|
-pip install -e .
|
|
|
+pip install -e . # will take a long time to build everything
|
|
|
jupyter serverextension enable --py jupyterlab
|
|
|
```
|
|
|
|
|
|
Start up the Jupyter notebook, and then open a browser to the server's URL with path `/lab` (e.g., `http://localhost:8888/lab`).
|
|
|
|
|
|
-When you make a change to the jupyterlab npm package source files, run `python setup.py build` to rebuild the extension and refresh your browser to see the changes.
|
|
|
+When you make a change to JupyterLab npm package source files, run `python setup.py jsdeps` to build the changes and refresh your browser to see the changes.
|
|
|
|
|
|
|
|
|
-NPM Package Install
|
|
|
--------------------
|
|
|
+NPM Package
|
|
|
+-----------
|
|
|
|
|
|
The npm package source files are in the `src/` subdirectory.
|
|
|
|
|
|
**Prerequisites**
|
|
|
-- [node](http://nodejs.org/)
|
|
|
-- [python](https://www.continuum.io/downloads)
|
|
|
+- [node](http://nodejs.org/) (preferably version 5 or later)
|
|
|
+- Jupyter notebook version 4.2 or later (to run examples)
|
|
|
|
|
|
```bash
|
|
|
npm install --save jupyterlab
|
|
|
-conda install notebook # notebook 4.2+ required
|
|
|
```
|
|
|
|
|
|
|
|
|
-NPM Source Build
|
|
|
-----------------
|
|
|
-
|
|
|
-**Prerequisites**
|
|
|
-- [git](http://git-scm.com/)
|
|
|
-- [node 0.12+](http://nodejs.org/)
|
|
|
-- [python](https://www.continuum.io/downloads)
|
|
|
+### NPM Source Build
|
|
|
|
|
|
```bash
|
|
|
git clone https://github.com/jupyter/jupyterlab.git
|
|
|
cd jupyterlab
|
|
|
npm install
|
|
|
npm run build
|
|
|
-conda install notebook # notebook 4.2+ required
|
|
|
```
|
|
|
|
|
|
**Rebuild**
|
|
@@ -79,9 +66,7 @@ npm run clean
|
|
|
npm run build
|
|
|
```
|
|
|
|
|
|
-
|
|
|
-Run Tests
|
|
|
----------
|
|
|
+### Run Tests
|
|
|
|
|
|
Follow the source build instructions first.
|
|
|
|
|
@@ -90,8 +75,7 @@ npm test
|
|
|
```
|
|
|
|
|
|
|
|
|
-Build Example
|
|
|
--------------
|
|
|
+### Build Examples
|
|
|
|
|
|
Follow the source build instructions first.
|
|
|
Requires a Python install with the Jupyter notebook (version 4.2 or later).
|
|
@@ -103,8 +87,7 @@ npm run build:examples
|
|
|
Change to the appropriate example in the `examples` directory and run `python main.py`.
|
|
|
|
|
|
|
|
|
-Build Docs
|
|
|
-----------
|
|
|
+### Build Docs
|
|
|
|
|
|
Follow the source build instructions first.
|
|
|
|
|
@@ -137,9 +120,5 @@ 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
|
|
|
+**Note:** This npm module is fully compatible with Node/Babel/ES6/ES5. Simply
|
|
|
omit the type declarations when using a language other than TypeScript.
|