JupyterHub Instructor Guide

Set up JupyterHub

1. Log in to Jupyter Open using your UBC CWL (Campus-Wide Login).
2. Your JupyterHub server will start up, and you can begin adding content such as notebooks and files.

Create a new Jupyter notebook or file

1. Log in to Jupyter Open using your UBC CWL.
2. In the top left corner of your JupyterHub server, click the plus icon.
3. In the "Launcher" tab that opens, choose the notebook or file type that you would like to make.
4. A new notebook or file with the name “Untitled” will open. To rename the notebook or file, right-click the name in the left side panel, and select Rename.
5. Add content to the notebook or file. When you make changes, a dark circle will appear in the right corner of the tab's name. This icon replaces the 'X' button for closing the tab and serves as a visual indicator of unsaved changes.
6. To save your changes, click File from the top toolbar, then select either Save Notebook or Save File, depending on what you are working on.

Upload an existing Jupyter notebook or file

Instead of creating a new notebook or file in JupyterHub, you can choose to upload existing content.

1. Log in to Jupyter Open using your UBC CWL.
2. In the top left corner of JupyterHub, click the "Upload Files" up arrow icon.
3. Select the file you would like to upload, and click Open. While you may be able to choose from all your files, ensure that whatever you are uploading is one of the accepted file types for JupyterHub.
4. The file will appear in the panel on the left. Double-click the file name to open and edit the file. When you make changes, a dark circle will appear in the right corner of the tab's name. This icon replaces the 'X' button for closing the tab and serves as a visual indicator of unsaved changes.
5. To save changes to your file, click File from the top toolbar, then select Save File.
   • Please note that for certain file types, such as those for Python and Java, the "Save File" text might be different (e.g., "Save Python File", "Save Java Text File"), but it should still be grouped together with the "Save All" button in the same location as other file types.

Share a Jupyter notebook with students

The simplest way to share a Jupyter notebook with students is to upload a copy of the file to Canvas for students to download and use in JupyterHub.

1. Log in to Jupyter Open using your UBC CWL.
2. From the panel on the left, right-click the notebook that you would like to share and select Download. This action will download the notebook to your computer in a Jupyter interactive notebook file format (.ipynb).
3. Upload the notebook file to your Canvas course where students can find it (e.g., in a module). Refer to our Canvas instructor guide for steps on adding content to your Canvas course.
4. Students can then download the notebook file from Canvas and upload it to their own JupyterHub server. Once the notebook file is uploaded, students can open and edit the file.