Skip to content

Latest commit

 

History

History
54 lines (36 loc) · 2.13 KB

CONTRIBUTING.md

File metadata and controls

54 lines (36 loc) · 2.13 KB
Raw

Lux is a project undergoing active development. If you are interested in contributing to Lux, the open tasks on GitHub issues (esp. issues labelled with the tag easy) are good places for newcomers to contribute. This guide contains information on the workflow for contributing to the Lux Widget codebase. For any additional questions and issues, please post on the Slack channel.

Setting up Build and Installation Process

To setup the Lux widget manually for development purposes, you should fork the Github repo and clone the forked version.

git clone https://github.com/USERNAME/lux-widget.git

To build the widget locally, you need to install npm and webpack:

npm install --save-dev webpack webpack-cli

You can install lux-widget by building from the source code in your fork directly:

cd lux-widget/
npm install 
sh install.sh

The install.sh transpiles the typescript files to javascript source, then packs everything into an index.js for the Jupyter Widget. Then we install the jupyter extension.

Debugging and Testing with Jupyter

If you are developing with Jupyter Notebook and make a change to the source code in the lux-widget/ folder, you can rebuild by doing this:

sh install.sh

If you are developing with JupyterLab, first make sure your JupyterLab is up to date using:

sh install_lab.sh

You can rebuild by running this command in the lux-widget/ folder:

jupyter labextension install

On low memory systems or for faster build times, you can run:

jupyter lab build --minimize=False

We recommend working in JupyterLab as the build time is much faster than building for Notebook.

In order for the Jupyter extension to get updated, we need to restart the Jupyter notebook server by killing the currently running notebook, then restarting the kernel via jupyter notebook or jupyter lab.