Jupyter_Interface

The Jupyter Interface

Your session

Your session is active for as long as you requested "wall time" when spawning the notebook server. If you exceed the allocated wall time, your notebook server will become unresponsive, and any unsaved work may be lost. You can stop your notebook server by clicking on the Control Panel button on the top right, and selecting Stop My Server. You can also log out of your server by clicking on Logout. This does not stop the notebook server, which will remain active for the entire allocated wall time. Logging back in will take you to the running notebook server.

The dashboard

The dashboard is the primary interface of the notebook server. You can navigate to the dashboard from any page by clicking on the "Jupyter" logo on the top left of the page. By default, the dashboard has three tabs named Files, Running and IPython Clusters.

Files and folders

The Files tab of the dashboard displays the file explorer, which lets you interact with files and folders stored on the Palmetto cluster. Clicking on an item (file or folder) opens it. Checking the box next to an item lets you perform actions on it, such as deleting or renaming.

You can create new files or folders by clicking on the "New" button on the top right of the file explorer.

Terminals

To start a terminal session, click on New, and then Terminal on the top right of the file explorer. This opens a terminal running on a compute node of the cluster. You can have several terminals open at the same time. You can always ssh into the user/login node of the cluster:

$ ssh user001

Notebooks

Finally, you can create Jupyter notebooks by clicking New, and selecting a notebook kernel to use. Kernels are processes that run interactive code in a particular programming language and return output to the user. The default kernels available are:

  1. Python 3
  2. R
  3. MATLAB

When you select a kernel, the notebook interface is opened in a new tab. See the Quickstart section for a quick introduction to editing and running Notbeooks, and the section on Notebook Basics for details. Note that the MATLAB kernel needs a small amount of additional configuration; please see the Configuration page for details.

Running notebooks and terminals

The Running tab of the dashboard shows all running notebooks and terminals. Simply closing the browser window with a running notebook or terminal does not shut down that notebook or terminal. They need to be explicitly shut down from this tab.