xwcoder / jupyterlab

JupyterLab computational environment.

Jupyterlab

This is the private version of Jupyterlab, based on Jupyterlab v3.4.8. The default branch is main which is based on tag v3.4.8.

Set up a local development environment

We recommend using conda to create the development environment.

Install Node.js

The project installation requires Node.js less than version 17, we recommend Node.js version 16.x.

Create develoment environment

Create develoment environment using conda, you can specify any enviroment env, for example jupyterlab here.

$ conda create -n jupyterlab --override-channels --strict-channel-priority -c conda-forge python=3.10 // create conda env named jupyterlab
$ conda activate jupyterlab // activate the env

Install JupyterLab

Clone the repository

$ git clone [e-mail]:xwcoder/jupyterlab.git

Install JupyterLab in editable model

$ cd jupyterlab
$ pip install -e .

// Or using aliyun mirror
$ pip install -e . -i https://mirrors.aliyun.com/pypi/simple/

Install dependencies

You can install dependencies using yarn or jlpm.

$ yarn install
$ jlpm install

Run JupyterLab

Start JupyterLab in development mode:

$ jupyter lab --dev-mode

Start JupyterLab in development and watch mode:

$ jupyter lab --dev-mode --watch

Run Jupyterlab in production mode using local repo

In some cases you may want to run jupyterlab in production using local version, for example, testing after development.

Start Jupyterlab in production mode:

$ yarn run build:packages
$ jupyter lab build
$ jupyter lab

Release

You can make a merge request to main or test branch when you complete the development, When the mr is merged, a pipeline will start, and a new version docker image will be created.