README.md

JupyterLab extension for SoS polyglot notebook and workflow system

jupyterlab-sos is a JupyterLab extension for the SoS Polyglot Notebook that allows you to use multiple Jupyter kernels in one notebook. It is also a frontend to the SoS Workflow Engine that is designed for daily computational research with both exploratory interactive data analysis and batch data processing.

Prerequisites

• sos-notebook and language modules of interest (e.g. sos-python and sos-r). See installation instruction for details.
• JupyterLab >= 1.0.0
• transient-display-data

Installation

• If you are using conda, you can install jupyterlab-sos with command

  conda install jupyterlab-sos -c conda-forge

  This will automatically install the transient-display-data extension, even jupyterlab, sos-notebook, and sos if needed.

• If you have a working jupyterlab installation with sos-notebook, you can install jupyterlab-sos from command line

  pip install jupyterlab-sos

  or through the jupyterlab extension installation process, which will require node.js

  jupyter labextension install transient-display-data
  jupyter labextension install jupyterlab-sos

  You could also install these two extensions from the extension manager (Enable Extension Manager from Settings if needed).

  Finally, if you just upgraded jupyterlab with jupyterlab-sos installed, you could run

  jupyter labextension update --all

  to upgrade all your extensions to the latest version.

Development

For a development install (requires npm version 4 or later), do the following in the repository directory:

npm install
npm run build
jupyter labextension link .

To rebuild the package and the JupyterLab app:

npm run build
jupyter lab build