Create and edit Jupyter notebooks
Set up your project
In PyCharm, create a new Python project.
Install the jupyter package for the selected interpreter.
When all the indexing processes are finished, you are ready to start working with the notebook files.
Creating and opening Jupyter notebooks
To open an existing .ipynb file, follow the same steps as for the files of the other types. If needed, you can create a notebook file.
Create a notebook file
Do one of the following:
Right-click the target directory in the Project tool window, and select New from the context menu.
Select Jupyter Notebook.
In the dialog that opens, type a filename.
A notebook document has the *.ipynb extension and is marked with the corresponding icon.
Editing Jupyter notebooks
You can apply various editing actions to one cell or to the entire notebook. Press the Ctrl+A once to select a cell at caret, and press Ctrl+A twice to select all cells in the notebook.
When editing notebook files, mind that PyCharm updates the source code and the preview of the notebook if it has been changed externally.
The editor for Jupyter notebooks has two modes: the edit mode and the command mode. Depending on the mode you can either edit code in notebook cells or use keyboard shortcuts to perform specific actions with cells.
To toggle the edit mode, press Enter or click any cell.
When a cell is in the edit mode, it has a green border on the left and a highlighted line with a caret.
When in the edit mode, you can navigate through all cells line by line using Up/Down keys.
A newly created notebook contains one code cell. You can change its type with the cell type selector in the notebook toolbar:
To edit a code cell, just click it.
To edit a Markdown cell, double-click it and start typing. To preview the output, press Shift + Enter.
Working with notebook cells
To add a code cell above the selected cell, do one of the following:
In the edit mode, press Alt+Shift+A.
In the command mode, press A.
Selectin the main menu.
To add a code cell below the selected cell, do one of the following:
In the edit mode, press Alt+Shift+B.
In the command mode, press B.
Selectin the main menu.
Click in the notebook toolbar.
You can add code or Markdown cells by using the popup between cells:
To add a Markdown cell, go toin the main menu, and then select either or .
To select a cell, click the gutter next to the cell.
To select several cells:
Hold Shift and click the gutter next to cells.
You can select a series of consecutive cells.
In command mode, press Shift and Up/Down keys.
You can execute, copy, merge, and delete the selected cells.
Copy and paste cells
To copy a cell in the command mode, press Ctrl+C, C, or click on the notebook toolbar.
To paste the copied cell below, press Ctrl+V, V, or click .
To paste it above the current cell, press Shift with Ctrl+V/Shift+V.
You can also select the required action from the cell's context menu.
Split and merge cells
To merge a current cell with the cell below, right-click the cell and selectcommand from the context menu.
Similarly, you can merge a cell above the selected cell with the corresponding command.
To merge several cells, select them, and then choose from the main menu.
Alternatively, you can use Find action to run the Merge Selected Cells command.
To split a cell into two cells, set the cursor on the line to break at, then right-click, and select thefrom the context menu.
In the command mode, press D, D or Delete.
Click on the notebook editor toolbar.
Right-click the cell and selectfrom the context menu.
Use code assistance
You can edit code cells with the help of Python code insights, such as syntax highlighting, code completion, and so on.
PyCharm enables code completion for the names of classes, functions, and variables. Start typing the name of the code construct, and the suggestion list appears.
Intention actions and quick fixes. You can add the missing imports on-the-fly by using the intention actions.
Note that you can add an import statement to the current cell or to the first cell of the notebook.