Notebook_Basics

Notebook Basics

Starting up notebooks

To create a new notebook, click on the "New" button on the top right of the Files tab of the dashboard. The different options listed in this menu are the available kernels for writing notebooks. The kernel is what decides which programming language to use to run notebook commands, and each notebook is associated with a single kernel.

When you select a kernel, the notebook user interface (UI) is launched with the corresponding kernel running in the background. On the top right of the notebook window, you will see messages about the kernel:

By default, notebooks are named "Untitled" (with an .ipynb extension). You can click on the name of the notebook on the top left of the notebook UI to change its name.

Uploading notebooks

Notebooks and files can be uploaded from your local machine to the Palmetto by using the "Upload" button on the Files tab of the dashboard.

Shutting down notebooks

The file browser shows green "Running" text and a green notebook icon next to running notebooks (as seen below). Notebooks remain running until you explicitly shut them down; closing the notebook's page is not sufficient.

To shutdown, delete, duplicate, or rename a notebook check the checkbox next to it and an array of controls will appear at the top of the notebook list (as seen below). You can also use the same operations on directories and files when applicable.

To see all of your running notebooks along with their directories, click on the "Running" tab:

This view provides a convenient way to track notebooks that you start as you navigate the file system in a long running notebook server.

Overview of the Notebook UI

If you create a new notebook or open an existing one, you will be taken to the notebook user interface. This UI allows you to run code and author notebook documents interactively. The notebook UI has the following main areas:

  • Menu
  • Toolbar
  • Notebook area and cells

The notebook has an interactive tour of these elements that can be started in the "Help:User Interface Tour" menu item.

The Jupyter Notebook has a "modal" user interface. This means that the keyboard does different things depending on which "mode" the Notebook is in. There are two modes: edit mode and command mode.

Edit mode

Edit mode is indicated by a green cell border and a prompt showing in the editor area:

When a cell is in edit mode, you can type into the cell, like a normal text editor.

Enter edit mode by pressing `Enter` or using the mouse to click on a cell's editor area.

Command mode

Command mode is indicated by a grey cell border with a blue left margin:

When you are in command mode, you are able to edit the notebook as a whole, but not type into individual cells. Most importantly, in command mode, the keyboard is mapped to a set of shortcuts that let you perform notebook and cell actions efficiently. For example, if you are in command mode and you press c, you will copy the current cell. If you then press v, you will paste the copied cell below the current cell.

Be aware of which mode you are in at all times. Don't try to type into a cell in command mode; unexpected things will happen!
Enter command mode by pressing `Esc` or using the mouse to click *outside* a cell's editor area.

Mouse navigation

All navigation and actions in the Notebook are available using the mouse through the menubar and toolbar, which are both above the main Notebook area:

The first idea of mouse based navigation is that cells can be selected by clicking on them. The currently selected cell gets a grey or green border depending on whether the notebook is in edit or command mode. If you click inside a cell's editor area, you will enter edit mode. If you click on the prompt or output area of a cell you will enter command mode.

If you are running this notebook in a live session (not on http://nbviewer.jupyter.org) try selecting different cells and going between edit and command mode. Try typing into a cell.

The second idea of mouse based navigation is that cell actions usually apply to the currently selected cell. Thus if you want to run the code in a cell, you would select it and click the "run cell" button in the toolbar or the "Cell:Run" menu item. Similarly, to copy a cell you would select it and click the "copy cell" button in the toolbar or the "Edit:Copy" menu item. With this simple pattern, you should be able to do most everything you need with the mouse.

Markdown and heading cells have one other state that can be modified with the mouse. These cells can either be rendered or unrendered. When they are rendered, you will see a nice formatted representation of the cell's contents. When they are unrendered, you will see the raw text source of the cell. To render the selected cell with the mouse, click the "run cell" button in the toolbar or the "Cell:Run" menu item. To unrender the selected cell, double click on the cell.

Keyboard Navigation

The modal user interface of the Jupyter Notebook has been optimized for efficient keyboard usage. This is made possible by having two different sets of keyboard shortcuts: one set that is active in edit mode and another in command mode.

The most important keyboard shortcuts are Enter, which enters edit mode, and Esc, which enters command mode.

In edit mode, most of the keyboard is dedicated to typing into the cell's editor. Thus, in edit mode there are relatively few shortcuts. In command mode, the entire keyboard is available for shortcuts, so there are many more. The Help->Keyboard Shortcuts dialog lists the available shortcuts.

We recommend learning the command mode shortcuts in the following rough order:

Key Action
enter Enter edit mode from command mode
shift-enter Execute cell
up/k, down/j Move to cell above or below
s Save notebook
y Change cell type to code cell
m Change cell type to Markdown cell
1-6 Change cell type to heading (levels 1-6)
a Create cell above current cell
b Create cell below current cell
x, c, v Cut, copy, paste cell
dd Delete cell
z Undo cell deletion
ii, 00 Interrupt kernel, restart kernel