PyCharm 2017.3 Help

IPython/Jupyter Notebook Support


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 ipnb icon icon.

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

Notebook support includes:

Configuring an interpreter for a notebook

To configure a remote connection for a notebook, follow these steps:

  1. Open the Jupyter Notebook page of the Settings/Preferences dialog.
  2. On this page, select or clear the Markdown cells rendering enabled option, and specify the username and password. Note that for the single-user notebooks these fields are optional - leave them blank.
  3. Choose the Remote radio-button:
  4. Fill in the username (for JupyterHub) and password.
  5. Click the link Configure remote interpreter. You'll find yourself at the Project Interpreter page.
    py ipnb remote
  6. Configure the remote interpreter, as described in the section Configuring Remote Interpreters via Deployment Configuration.

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:

ioSave and checkpointClick this button to forcibly save all changes to the notebook in its current state (even if the calculations not finished yet).
addInsert cell belowClick this button to add an empty cell under the current one.
mainToolbarCutCut cellClick this button to delete the current cell and place it to the clipboard.
copyCopy cellClick this button to create copy of the current cell in the clipboard.
pastePaste cell belowClick this button to the paste contents of the clipboard below the current cell.
runRun cellClick this button to execute the current cell.
stopInterrupt kernelClick this button to stop the current kernel.
refreshRestart kernelClick this button to restart the current kernel.
Styles drop-down listSelect the desired presentation style from the drop-down list.
Last modified: 28 March 2018

See Also