IPython/Jupyter Notebook Support

In this section:

• IPython/Jupyter Notebook Support
  • Prerequisite
  • Notebook support
  • Creating and opening ipynb files
  • File *.ipynb in the editor
• Running IPython/Jupyter Notebook Cells
• Tutorial: Using IPython/Jupyter Notebook with PyCharm

Prerequisite

Prior to working, make sure that the following prerequisite is met:

Jupyter Notebook is properly installed on your computer. To learn how to install Jupyter Notebook, refer to the official documentation.

Notebook support

PyCharm supports Jupyter Notebook, recognizes *.ipynb files, and allows you to edit them.

Jupyter Notebook files are marked with icon.

A Notebook file <file name>.ipynb shows document cells including code, text, equations etc.

Notebook support includes:

• Coding assistance:
  • Error and syntax highlighting.
  • Code completion.
  • Ability to create line comments (Ctrl+Slash).
• Dedicated kernel view: Jupyter Notebook tab in the Run tool window.
• Ability to run cells.

Creating and opening ipynb files

To create an *.ipynb file:

1. Do one of the following:
   • Right-click the target directory in the Project tool window, and choose New on the context menu.
   • Press Alt+Insert
2. Choose the option Jupyter Notebook.
3. In the dialog box that opens, type the file name.

To open the existing .ipynb files, follow the same steps as for the files of the other types.

File *.ipynb in the editor

The *.ipynb files feature a toolbar with the following buttons:

Item	Tooltip	Description
	Save and checkpoint	Click this button to forcibly save all changes to the notebook in its current state (even if the calculations not finished yet).
	Insert cell below	Click this button to add an empty cell under the current one.
	Cut cell	Click this button to delete the current cell and place it to the clipboard.
	Copy cell	Click this button to create copy of the current cell in the clipboard.
	Paste cell below	Click this button to the paste contents of the clipboard below the current cell.
	Run cell	Click this button to execute the current cell.
	Interrupt kernel	Click this button to stop the current kernel.
	Restart kernel	Click this button to restart the current kernel.
Styles drop-down list		Select the desired presentation style from the drop-down list.