Installation#

Installing from PyPi#

K3D-jupyter releases are available as wheel packages for macOS, Windows and Linux on PyPi.

pip install k3d

When using the package within Jupyter Notebook, install and enable the k3d extension.

jupyter nbextension install --py --user k3d
jupyter nbextension enable --py --user k3d

When upgrading from an earlier version, use the following commands.

pip install -U k3d

jupyter nbextension install --py --user k3d
jupyter nbextension enable --py --user k3d

k3d is available via the conda-forge community channel.

conda install -c conda-forge k3d

You can install directly from the repository:

Note

Requires git, Node.js and npm.

pip install git+https://github.com/K3D-tools/K3D-jupyter

You can also install the most up-to-date development version:

pip install git+https://github.com/K3D-tools/K3D-jupyter@devel

If you want to install any historical version, replace devel with any tag or commit hash.

For a development installation:

Note

Requires git, Node.js and npm.

git clone https://github.com/K3D-tools/K3D-jupyter.git
cd K3D-jupyter
pip install -e .

Then, if required, JupyterLab installation:

jupyter labextension install ./js

If required, you can install the JupyterLab extension:

Note

Do not run this within K3D-jupyter directory.

jupyter labextension install @jupyter-widgets/jupyterlab-manager
jupyter labextension install k3d

Important

Please notice that support for JupyterLab is still experimental.