DataSpell 2025.1 Help

Jupyter notebooks

With Jupyter Notebook integration available in DataSpell you can edit, execute, and debug notebook source code and examine execution outputs including stream data, images, and other media.

Notebook support in DataSpell includes:

  • Coding assistance:

    • Error and syntax highlighting.

    • Code completion.

    • Ability to create line comments Ctrl+/.

  • Dedicated Jupyter Notebook Debugger.

  • Shortcuts for basic operations with Jupyter notebooks.

  • Ability to recognize .ipynb files and mark them with the Jupyter icon icon.

  • Jupyter-specific AI features.

Quick start

To start working with Jupyter notebooks in DataSpell:

  1. Open files in your workspace.

  2. If needed, configure or create a new virtual environment.

  3. Add and edit source cells.

  4. Execute any of the code cells to launch the Jupyter server.

Get familiar with the user interface

Jupyter notebook toolbar

The Jupyter notebook toolbar provides quick access to all basic operations with notebooks:

Jupyter toolbar

Item

Description

Code Cell Below

Code Cell Below

Adds a code cell below the selected cell.

Move Cell Up

Move Cell Up

Moves the current cell up.

Move Cell Down

Move Cell Down

Moves the current cell down.

Run Cell and Select Below

Run Cell and Select Below

Executes this cell and selects a cell below. If there is no cell below, DataSpell will create it.

Run All

Run All

Executes all cells in the notebook.

Restart Kernel

Restart Kernel

Click this icon to restart the currently running kernel.

Clear All Outputs

Clear All Outputs

Clears all outputs in the notebook.

Go To Cell

Click this widget to navigate to the last executed cell.

Configure Jupyter Server

Shows the currently used Jupyter server. Click this widget and select Configure Jupyter Server to set up another local or remote Jupyter server.

Open Notebook in Browser

Open Notebook in Browser

Opens the current notebook in a browser.

Cells

A cell contains a piece of either a code or Markdown text. When you run a code cell, you can view the cell output, which is the result of code execution:

Code cell

Each cell includes its own toolbar, providing quick access to essential actions.

Cell toolbar consists of the following elements:

  • Actions available directly on the toolbar.

  • Additional actions in the context menu. To open the context menu, click More on the cell toolbar.

The actions available on the toolbar and in the context menu vary depending on the type of cell:

Item

Description

Toolbar actions

AI Edit Cell AI Edit Cell

Get AI assistance for code suggestions or improvements.

Debug Cell Debug Cell

Debug the code in the cell.

Delete Cell Delete Cell

Remove the current cell.

Context menu options

Clear Output

Clear the output of the cell.

Add Cell Tag

Add a tag to organize or manage the cell.

Move Cell Up

Move the current cell up.

Move Cell Down

Moves the current cell down.

Copy Cell

Copy the cell and add it to the clipboard.

Cut Cell

Remove the cell and add it to the clipboard.

Item

Description

Toolbar actions

AI Edit Cell AI Edit Cell

Get AI assistance for code suggestions or improvements.

Edit Edit

Switch to edit mode.

Run Section Run Section

Execute all cells within a Markdown section.

Delete Cell Delete Cell

Remove the current cell.

Context menu options

Add Cell Tag

Add a tag to organize or manage the cell.

Move Cell Up

Move the current cell up.

Move Cell Down

Moves the current cell one down.

Copy Cell

Copy the cell and add it to the clipboard.

Cut Cell

Remove the cell and add it to the clipboard.

Item

Description

Toolbar actions

AI Edit Cell AI Edit Cell

Get AI assistance for code suggestions or improvements.

Delete Cell Delete Cell

Remove the current cell.

Context menu options

Clear Output

Clear the output of the cell.

Add Cell Tag

Add a tag to organize or manage the cell.

Move Cell Up

Move the current cell up.

Move Cell Down

Moves the current cell down.

Copy Cell

Copy the cell and add it to the clipboard.

Cut Cell

Remove the cell and add it to the clipboard.

Jupyter tool window

Jupyter tool window appears when you have any of the Jupyter servers launched. The Server tab of this window shows the current state of the Jupyter server and the link to the notebook in a browser.

It also provides controls to stop the running server (Stop the server) and launch the stopped server (Run the server).

Jupyter console

You can execute commands in a Jupyter Console:

  1. Click Open Jupyter Console Open Jupyter Console on the notebook toolbar. This button is enabled when you have started a Jupyter server for the current notebook. You can open one console for each notebook file.

  2. Type a command or a series of commands and press Execute Current Statement in One-Line Console on the console toolbar.

The Variables tab provides a detailed report about variable values of the executed cell. The tab automatically opens when you launch the Jupyter console.

Jupyter Variables tool window

The Jupyter Variabes tool window will appear each time you execute a cell. If you need to hide it permanently, go to Settings | Tools | Jupyter | Jupyter General and uncheck the Show Variables tool window on execution checkbox.

Jupyter Variables tool window
Last modified: 06 May 2025