Jupyter notebook support
With Jupyter Notebook integration available in PyCharm, you can edit, execute, and debug notebook source code and examine execution outputs including stream data, images, and other media.
Notebook support in PyCharm includes:
Coding assistance:
Error and syntax highlighting.
Ability to create line comments Ctrl+/.
Ability to execute IPython commands in the Python console.
Dedicated Jupyter Notebook Debugger.
Shortcuts for basic operations with Jupyter notebooks.
Ability to recognize .ipynb files and mark them with the
icon.Jupyter project template.
Jupyter-specific AI features.
Quick start
To start working with Jupyter notebooks in PyCharm:
Create a Jupyter project.
Open or create an .ipynb file.
Add and edit source cells.
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:
Item | Description |
|---|---|
Code Cell Below | Adds a code cell below the selected cell. |
Move Cell Up | Moves the current cell up. |
Move Cell Down | Moves the current cell down. |
Run Cell and Select Below | Executes this cell and selects a cell below. If there is no cell below, PyCharm will create it. |
Run All | Executes all cells in the notebook. |
Restart Kernel | Click this icon to restart the currently running kernel. |
Clear All Outputs | Clears all outputs in the notebook. |
| Click this widget to navigate to the last executed cell. |
| Shows the currently used Jupyter server. Click this widget and select to set up another local or remote Jupyter server. |
Open Jupyter Console | Opens the Jupyter Console tab of the Jupyter tool window. This button is enabled when you have started a Jupyter server for the current notebook. |
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:
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
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 | |
| Get AI assistance for code suggestions or improvements. |
| Debug the code in the 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. |
AI Edit Cell
Debug Cell
Delete CellItem | Description |
|---|---|
Toolbar actions | |
| Get AI assistance for code suggestions or improvements. |
| Switch to edit mode. |
| Execute all cells within a Markdown section. |
| 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. |
EditItem | Description |
|---|---|
Toolbar actions | |
| Get AI assistance for code suggestions or improvements. |
| 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 (
) and launch the stopped server (
).
Jupyter console
You can execute commands in a Jupyter Console:
Click
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.Type a command or a series of commands and press
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.
Structure tool window
For .ipynb files, both Markdown and Python cells can be displayed in the Structure tool window.
A Python cell is displayed only if it starts with a comment. The initial comment's content is used as the cell's title.
