---
metadata:
  - name: generator
    content: Diplodoc Platform v5.50.6
alternate:
  - https://ytsaurus.tech/docs/en/user-guide/jupyt.md
  - https://ytsaurus.tech/docs/ru/user-guide/jupyt.md
title: Jupyter Notebooks | YTsaurus
---
> **Documentation Index:** Fetch the complete configuration index at https://ytsaurus.tech/docs/en/llms.txt

<!-- source: en/_includes/user-guide/jupyt.md -->
# Using Jupyter Notebooks in YTsaurus

{% note warning %}

This feature is under development and may be unstable. It is not recommended for use in production workflows or for serious development and debugging.

{% endnote %}

YTsaurus allows to launch Jupyter Notebooks on the computational resources of the cluster. Functionality can be used on clusters using CRI job environment.

Following actions are required to launch a notebook:

1. Set the environment variable `JUPYT_CTL_ADDRESS` to the address of JUPYT strawberry controller.
```bash
export JUPYT_CTL_ADDRESS=jupyt.test.yt.mycloud.net
```

1. Select docker-image of the jupyter-notebook. You can use [jupyter stacks](https://jupyter-docker-stacks.readthedocs.io/en/latest/) as an image or as a base of the image. Example of such an image is [minimal-notebook](https://quay.io/jupyter/minimal-notebook).

1. Create a notebook. To create a notebook you should specify docker-image with the notebook and scheduler pool for the operation.
```bash
yt jupyt ctl create --speclet-options '{jupyter_docker_image="quay.io/jupyter/minimal-notebook"; pool=my-pool}' test-jupyt
```

1. Launch the notebook.
```bash
yt jupyt ctl start test-jupyt
```

1. Wait until notebook is started and get the link to it using CLI.
```bash
foo@bar:~$ yt jupyt ctl get-endpoint test-jupyt
{
    "address" = "http://some-node.yt.mycloud.net:27042";
    "operation_id" = "60b8ec86-6f123a7d-134403e8-ee6b88de";
    "job_id" = "16f76ac9-2a20ab96-13440384-14e";
}
```

{% note warning "Warning" %}

Notebooks and files created on filesystem are not preserved after job restart. For the reliable storage of the files you should store them in [Cypress](https://ytsaurus.tech/docs/en/user-guide/storage/cypress.md).

{% endnote %}
<!-- endsource: en/_includes/user-guide/jupyt.md -->