Installation

The pdpilot package is available on PyPI and can be installed with pip. When working with virtual environments, it is easiest to run the Jupyter server and kernel in the same environment.

Here’s an example of using conda and JupyterLab:

# Set up the environment.
conda create -n pdpilot
conda activate pdpilot
# Install Python and JupyterLab.
conda install -c conda-forge "python=3.10" jupyterlab
# Install PDPilot.
pip install pdpilot
# Run the server.
jupyter-lab

And here’s an example of using conda and Jupyter Notebook:

# Set up the environment.
conda create -n pdpilot
conda activate pdpilot
# Install Python and Jupyter Notebook.
conda install -c conda-forge "python=3.10" notebook
# Install PDPilot.
pip install pdpilot
# Run the server.
jupyter-notebook

With Jupyter Notebook, if you see errors in your terminal such as “Uncaught exception in zmqstream callback” or “zmq message arrived on closed channel”, then it is related to this open issue. To avoid this error, you can update the conda install command to conda install -c conda-forge "python=3.10" "pyzmq<25" "jupyter_client<8" notebook.

To get you started, you can download an example notebook:

curl -O https://raw.githubusercontent.com/DanielKerrigan/PDPilot/main/examples/bike-rentals-regression.ipynb