JupyterHub: Difference between revisions

From Alliance Doc
Jump to navigation Jump to search
(Reordering stuff, adding subsection titles)
(Added the Server Options figure and description)
Line 9: Line 9:
JupyterHub eliminates the requirement for users to install their own version of [[Jupyter]] Notebook; they can connect to the application using only a recent web browser.
JupyterHub eliminates the requirement for users to install their own version of [[Jupyter]] Notebook; they can connect to the application using only a recent web browser.


== User Interface == <!--T:9-->
== Server Options ==
While JupyterHub allows each user to use one Jupyter server at a time, there may be multiple user interfaces available:
[[File:JupyterHub_Server_Options.png|thumb|''Server Options'' form on Béluga's JupyterHub]]
Once logged in, depending on the configuration of JupyterHub, a user can set different options for their Jupyter server before pressing the ''Start'' button. It is similar to requesting resources for an [[Running_jobs#Interactive_jobs|interactive job]].
 
=== Compute resources ===
For example, ''Server Options'' available on [https://jupyterhub.beluga.computecanada.ca/ Béluga's JupyterHub] are:
* ''Account'' to be used: any <code>def-*</code>, <code>rrg-*</code>, <code>rpp-*</code> or <code>ctb-*</code> account a user has access to
* ''Time (hours)'' required for the session
* ''Number of (CPU) cores'' that will be reserved on a single node
* ''Memory (MB)'' limit for the entire session
* (Optional) ''GPU configuration'': at least one GPU
* ''[[JupyterHub#User_Interface|User interface]]'' (see below)
 
=== User Interface === <!--T:9-->
While JupyterHub allows each user to use one Jupyter server at a time on each hub, there can be multiple options under ''User interface'':
* Jupyter Notebook (classic interface)
* Jupyter Notebook (classic interface)
* [[JupyterLab]] (recommended, modern interface)
* '''[[JupyterLab]]''' (recommended, modern interface)
* Terminal (for a single terminal only)
* Terminal (for a single terminal only) - It gives access to a terminal connected to a remote account, which is comparable to connecting to a server through an SSH connection


<!--T:10-->
<!--T:10-->
Otherwise, JupyterHub could have been configured to force a specific user interface.
Note: JupyterHub could have also been configured to force a specific user interface. This is usually done for special events.


== Compute Canada initiatives == <!--T:4-->
== Compute Canada initiatives == <!--T:4-->

Revision as of 16:22, 11 January 2021

Other languages:

Introduction

"JupyterHub, a multi-user Hub, spawns, manages, and proxies multiple instances of the single-user Jupyter notebook server. JupyterHub can be used to serve notebooks to a class of students, a corporate data science group, or a scientific research group."[1]

JupyterHub eliminates the requirement for users to install their own version of Jupyter Notebook; they can connect to the application using only a recent web browser.

Server Options

Server Options form on Béluga's JupyterHub

Once logged in, depending on the configuration of JupyterHub, a user can set different options for their Jupyter server before pressing the Start button. It is similar to requesting resources for an interactive job.

Compute resources

For example, Server Options available on Béluga's JupyterHub are:

  • Account to be used: any def-*, rrg-*, rpp-* or ctb-* account a user has access to
  • Time (hours) required for the session
  • Number of (CPU) cores that will be reserved on a single node
  • Memory (MB) limit for the entire session
  • (Optional) GPU configuration: at least one GPU
  • User interface (see below)

User Interface

While JupyterHub allows each user to use one Jupyter server at a time on each hub, there can be multiple options under User interface:

  • Jupyter Notebook (classic interface)
  • JupyterLab (recommended, modern interface)
  • Terminal (for a single terminal only) - It gives access to a terminal connected to a remote account, which is comparable to connecting to a server through an SSH connection

Note: JupyterHub could have also been configured to force a specific user interface. This is usually done for special events.

Compute Canada initiatives

Some regional initiatives offer access to computing resources through JupyterHub.

JupyterHub on clusters

On the following clusters, use your Compute Canada username and password to connect to JupyterHub:

JupyterHub for universities and schools

References