kernel

Example

The kernel block defines a kernel instance name and configures the kernel.

kernel "py_kernel" {
  kernel_name = "python3"
  pass_env = ["PATH", "HOME"]
}

Description

  • kernel_name (str | optional | default: "")

    kernel_name is a Jupyter kernel name. You can install multiple kernels and switch them by specifying kernel_name. If it is not specified, the default kernel will be launched. The kernel must be IPython kernel and the Python version must be greater than or equal to 3.4. See also Installing the IPython kernel in the IPython document.

  • pass_env ([str] | optional | default: [])

    pass_env defines environment variables which will be passed to the kernel. Jaffle itself has the environment variables defined in your environment, but the kernel will be launched as an independent process and the environment variables are not passed by default.

    Tip

    If the kernel executes a Python console script in a virtualenv, you will have to pass PATH environment variable to the kernel.