Installation

Currently, we are in private access mode. You will receive the initial pip install command and your license directly from us when you have been chosen for early access.

The installation consists of 4 steps:

1) pip install

From the terminal, you can install edaviz with the pip command that you received from us via mail.

2) setup jupyter extensions

Jupyter Notebook

From the terminal, you need to setup the Jupyter Notebook extensions via the following commands:

jupyter nbextension enable --py widgetsnbextension
jupyter nbextension enable --py qgrid

If this worked for you, you can continue with step 3.

Jupyter Lab

Small tip: The setup process with Jupyter Notebook is faster and easier than with Jupyter Lab. Also, JupyterLab 1.0.1 does not work yet, because there are still dependency incompatibilities. However, it works with the latest JupyterLab version before 1.0

If you use Jupyter Lab, you need to use the following commands from your terminal. The Jupyter Lab Extension manager will not work because the version numbers cannot be fixed yet.

Important: Jupyter Lab extensions require that you have nodejs installed on your computer. Official install guide for Jupyter Lab Extensions

jupyter labextension install @jupyter-widgets/jupyterlab-manager@0.38 --no-build
jupyter labextension install plotlywidget@0.11.0 --no-build
jupyter labextension install @jupyterlab/plotly-extension@0.18.2 --no-build
jupyter labextension install qgrid@1.1.1 --no-build
jupyter lab build

If this worked for you, you can continue with step 3.

If you have troubles with the correct display of the edaviz widgets, please validate again, that you have the right versions of the pip dependencies installed because some version combinations are incompatible:

From the terminal, you need to enter: (maybe you use pip3?)

pip install jupyterlab==0.35.6
pip install ipywidgets==7.4.2
pip install plotly==3.10.0

3) start edaviz in Jupyter

From the terminal, start your Jupyter Notebook (or Jupyter Lab):

jupyter notebook

From a Jupyter cell, you need to start edaviz via the following Python code:

import edaviz as eda
df = eda.get_titanic_df()  # sample pandas dataframe
df

4) enter your license

If everything works fine, edaviz asks you for a license. Please enter the license key which you received from us.