Skip to content

Commit

Permalink
Updated docs for JupyterLab (#148)
Browse files Browse the repository at this point in the history
* added functionality to delete Vis

* fixed deletion logic

* add observer to automatically update deletions

* able to refresh widget on setting intent

* support for setting intent from frontend

* quick fix to output

* changed variable intentindex name

* added better error msg for > 1 intent for vis

* reverting some changes

* updated install and faq

* added install_lab.sh script
  • Loading branch information
cjachekang committed Nov 19, 2020
1 parent f5be470 commit da79415
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 4 deletions.
15 changes: 12 additions & 3 deletions doc/source/getting_started/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,19 @@ You can install the Python Lux API through `PyPI <https://pypi.org/project/lux-a
pip install lux-api
You can install the Lux Jupyter widget through `npm <https://www.npmjs.com/package/lux-widget>`_
To activate the Jupyter notebook extension:

.. code-block:: bash
npm i lux-widget
jupyter nbextension install --py luxwidget
jupyter nbextension enable --py luxwidget
To activate the JupyterLab extension:

.. code-block:: bash
jupyter labextension install @jupyter-widgets/jupyterlab-manager
jupyter lab build
Additional Requirements
-----------------------
Expand Down Expand Up @@ -56,6 +64,7 @@ Then, we can install the `Lux Jupyter widget <https://github.com/lux-org/lux-wid
git clone git@github.com:lux-org/lux-widget.git
cd lux-widget/
npm install
bash install.sh
sh install.sh
sh install_lab.sh
If you are experiencing issues with installing Lux, please checkout the `Troubleshooting page <https://lux-api.readthedocs.io/en/latest/source/guide/FAQ.html#troubleshooting-tips>`_.
1 change: 0 additions & 1 deletion doc/source/guide/FAQ.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,6 @@ The Lux Jupyter widget does not show up when I print a dataframe.
- If you are able to import lux successfully and you do not see the "Toggle button" when you print the dataframe, it may be possible that Lux is not compatible with your browser. Lux is compatible with Google Chrome, but have not been extensively tested on Safari or Firefox.
- If you recieve the error message :code:`A Jupyter widget could not be displayed because the widget state could not be found.` This could happen if the kernel storing the widget is no longer available, or if the widget state was not saved in the notebook. You may be able to create the widget by running the appropriate cells.`, you may want to restart the notebook and rerun the cell.
- If you recieve the error message :code:`Error displaying widget: model not found`, it is possible that you are using JupyterLab or other frontends (e.g., VSCode) to open up your notebook. Lux does not currently support JupyterLab (`#16 <https://github.com/lux-org/lux-widget/issues/16>`_), please try out Lux with the basic :code:`jupyter notebook`.
- If you receive the error message :code:`ModuleNotFoundError: No module named 'luxwidget'`, it is possible that your luxwidget and lux-api versions are not in sync. The latest version of lux-api requires luxwidget v0.1 or above. Try running the following code:

.. code-block:: bash
Expand Down

0 comments on commit da79415

Please sign in to comment.