Skip to content

Adding Conda Environments as Jupyter Kernels

To have a conda environment show as a kernel in Jupyter, two more steps are needed. The conda environment must be activated when these steps are run.

Install the ipykernel package

In order to use an environment in Jupyter, we need to make sure we install the ipykernel package in the environment:

conda install ipykernel

Create the kernel definition

The ipykernel python module includes a utility for adding a kernel definition. With the conda environment active, run the following command:

python -m ipykernel install --user --name my_kernel_name  --display-name my_display_name

"my_kernel_name" and "my_display_name" can be any value you like, but each kernel you create should have a distinct name.

Troubleshooting Kernels

If you kernel doesn't display, or won't launch, check the Jupyter output log.

In Open on Demand, each session has a card with a link to the Session ID.

Screenshot of the Jupyter card in OOD showing Session ID link.

Click on that link and open the output.log file. That log file will often provide clues as to why kernels cannot launch.