DataSpell 2024.2 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

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.

Cut

Cut

Moves the selected item or items from the current location to the clipboard. Moves the entire cell if it's selected.

Copy

Copy

Copies the selected item or items to the clipboard. Copies the entire cell if it's selected.

Paste

Paste

Inserts the contents of the clipboard into the selected location. If you've selected an entire cell, the contents are pasted to a new cell below the selected one.

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.

Debug Cell

Debug Cell

Starts debugging for the selected cell.

Interrupt Kernel

Interrupt Kernel

Click this icon if you want to interrupt any cell execution.

Restart Kernel

Restart Kernel

Click this icon to restart the currently running kernel.

Run All

Run All

Executes all cells in the notebook.

Clear All Outputs

Clear All Outputs

Clears all outputs in the notebook.

Delete Cell

Delete Cell

Deletes the current cell.

Cell type

You can select a cell type from this list and change the type for the selected cell.

Configure Jupyter Server

The Jupyter Server widget that shows the currently used Jupyter server. Click the widget and select Configure Jupyter Server to setup another local or remote Jupyter server.

List of Jupyter kernels

List of the available Jupyter kernels.

Trusted JS widgets

Select this checkbox to allow executing JavaScript in your Jupyter notebook.

Select Cell Above

Select Cell Above

This action selects the cell above.

Select Cell Below

Select Cell Below

This action selects the cell blow.

Open Notebook in Browser

Open Notebook in Browser

You can preview the 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

Tool windows

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

Jupyter server tool window: the Server log tab

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

The Jupyter Variables tool window the detailed report about variable values of the executed cell.

Jupyter server tool window: the Variables tab
Last modified: 13 September 2024