Lux API is the core Python framework for supporting intelligent data discovery. Lux API can be used in conjunction with the Lux widget, which is a frontend Jupyter widget extension built with ipywidget.

You can install the Python Lux API through PyPI

pip install lux-api

To activate the Jupyter notebook extension:

jupyter nbextension install --py luxwidget
jupyter nbextension enable --py luxwidget

To activate the JupyterLab extension:

jupyter labextension install @jupyter-widgets/jupyterlab-manager
jupyter labextension install luxwidget

Additional Requirements

If you want to use Lux with a SQL execution engine as a backend, you need to install Postgres (version >= 9.5). A tutorial on installing PostgresSQL on Mac OSX can be found here.

In addition to setting up Postgres, you also need to install Psycopg2 for the Python code in Lux to query Postgres database.

pip install psycopg2

Manual Installation (Dev Setup)

To setup Lux manually for development purposes, you should clone the two Github repos for Lux: 1) the core Python Lux API and 2) the Jupyter widget frontend.

To install the Python Lux API:

git clone
cd lux/
pip install --user -r requirements.txt
python install

To install the widget, we need to install webpack:

npm install --save-dev webpack webpack-cli

Then, we can install the Lux Jupyter widget using the custom installation script:

git clone
cd lux-widget/
npm install

If you are experiencing issues with installing Lux, please checkout the Troubleshooting page.