In order to run the example, you need to have:
- Docker installed and running. See their documentation.
- Your Civis Platform API key in your environment as
${CIVIS_API_KEY}. - The ID of notebook in the Civis Platform to test against. This ID is the number that appears at the end
of the URL for the notebook,
https://platform.civisanalytics.com/#/notebooks/<NOTEBOOK ID>.
To run the example:
- Clone this repo and then change to this directory:
cd civis-jupyter-notebook/example. - Build the image using build.sh:
./build.sh. - Change
<NOTEBOOK ID>in run.sh to the ID of your notebook from step 3 above. - Run the Jupyter notebook server using run.sh:
./run.sh. - Connect to the notebook. If you are running Docker locally via
docker run, then http://localhost:8888/notebooks/notebook.ipynb should work. Other setups require the Docker host IP in the URL,http://<docker-host-ip>:8888notebooks/notebook.ipynb.