Installation on Current Jupyter Notebook

You can use this framework with the existing installation of Jupyter Notebooks on your local machine by following this guide.

First, make sure you have npm (Node Package Manager) installed on your local machine, check NodeJS for more information. Then, clone the repository -if you haven't already done that- and install the requirements inside the notebook directory:

git clone https://github.com/qcri/collaborativedatascience.git
cd collaborativedatascience/notebook
pip install -r requirements.txt

Install & Enable Extensions:

git clone https://github.com/meshalawy/qgrid.git 
cd qgrid
pip install -e .
cd js && npm install .
jupyter nbextension install --py --symlink --sys-prefix qgrid && jupyter nbextension enable --py --sys-prefix qgrid

Start Jupyter Notebook (make sure to update the .env file with the appropriate configuration, especially, replace HOST with your actual server IP from step 1 in the installation guide:

# Navigate to the repository:
cd collaborativedatascience/notebook

# this will load the configuration from file and 
# make it available for jupyter process
sh -ac '. ../.env; jupyter notebook'

Now all you need is to import the file collaborative_data_frame.py in your notebooks. Follow the example notebooks for more information.