Skip to content

Commit

Permalink
user defined view tutorial docs; installation doc
Browse files Browse the repository at this point in the history
  • Loading branch information
dorisjlee committed Jun 22, 2020
1 parent f1ab029 commit aa73881
Show file tree
Hide file tree
Showing 2 changed files with 123 additions and 235 deletions.
32 changes: 29 additions & 3 deletions doc/source/getting_started/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,32 @@ In addition to setting up Postgres, you also need to install Psycopg2 for the Py
pip install psycopg2
Development Setup
-----------------
Instructions forthcoming.
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 <https://github.com/lux-org/lux>`_ and 2) the `Jupyter widget frontend <https://github.com/lux-org/lux-widget>`_.

To install the Python Lux API:

.. code-block:: console
pip install --user -r requirements.txt
cd lux/
python setup.py install
To install the widget, we need to install webpack:

.. code-block:: console
npm install --save-dev webpack webpack-cli
Then, we can install the `Lux Jupyter widget <https://github.com/lux-org/lux-widget>`_ using the custom installation script:

.. code-block:: console
git clone git@github.com:lux-org/lux-widget.git
cd lux-widget/
npm install
bash install.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>`_.

0 comments on commit aa73881

Please sign in to comment.