JupyterHub: Difference between revisions

no edit summary
No edit summary
No edit summary
Line 110: Line 110:
** Alliance modules can be loaded and unloaded in the JupyterLab session. Depending on the modules loaded, icons directing to the corresponding [[#Prebuilt_Applications|Jupyter applications]] will appear in the <i>Launcher</i> tab.
** Alliance modules can be loaded and unloaded in the JupyterLab session. Depending on the modules loaded, icons directing to the corresponding [[#Prebuilt_Applications|Jupyter applications]] will appear in the <i>Launcher</i> tab.
** The search box can search for any [[Available software|available module]] and give the result in the <i>Available Modules</i> sub-panel. Note: some modules are hidden until their dependency is loaded - we recommend that you first look for a specific module with <code>module spider module_name</code> from a terminal.
** The search box can search for any [[Available software|available module]] and give the result in the <i>Available Modules</i> sub-panel. Note: some modules are hidden until their dependency is loaded - we recommend that you first look for a specific module with <code>module spider module_name</code> from a terminal.
** The next sub-panel is the list of ''Loaded Modules'' in the whole JupyterLab session. Note: while <code>python</code> and <code>ipython-kernel</code> modules are loaded by default, additional modules must be loaded before launching some other applications or notebooks. For example: <code>scipy-stack</code>.
** The next sub-panel is the list of <i>Loaded Modules</i> in the whole JupyterLab session. Note: while <code>python</code> and <code>ipython-kernel</code> modules are loaded by default, additional modules must be loaded before launching some other applications or notebooks. For example: <code>scipy-stack</code>.
** The last sub-panel is the list of ''Available modules'', similar to the output of <code>module avail</code>. By clicking on a module's name, detailed information about the module is displayed. By clicking on the ''Load'' link, the module will be loaded and added to the ''Loaded Modules'' list.
** The last sub-panel is the list of <i>Available modules</i>, similar to the output of <code>module avail</code>. By clicking on a module's name, detailed information about the module is displayed. By clicking on the <i>Load</i> link, the module will be loaded and added to the <i>Loaded Modules</i> list.


=== Application area on right === <!--T:27-->
=== Application area on right === <!--T:27-->


<!--T:28-->
<!--T:28-->
* The ''Launcher'' tab is opened by default
* The <i>Launcher</i> tab is opened by default
** It contains all available [[#Prebuilt_Applications|Jupyter applications and notebooks]], depending on which modules are loaded
** It contains all available [[#Prebuilt_Applications|Jupyter applications and notebooks]], depending on which modules are loaded


Line 122: Line 122:


<!--T:30-->
<!--T:30-->
* By clicking on the icons, this brings you to the ''Running Terminals and Kernels'' tool.
* By clicking on the icons, this brings you to the <i>Running Terminals and Kernels</i> tool.


== Prebuilt Applications == <!--T:31-->
== Prebuilt Applications == <!--T:31-->
Line 139: Line 139:


<!--T:36-->
<!--T:36-->
To enable the ''Julia 1.x'' console launcher, an <code>ijulia-kernel</code> module needs to be loaded. When launched, a Julia interpreter is presented in a new JupyterLab tab.
To enable the <i>Julia 1.x</i> console launcher, an <code>ijulia-kernel</code> module needs to be loaded. When launched, a Julia interpreter is presented in a new JupyterLab tab.


==== Python Console ==== <!--T:37-->
==== Python Console ==== <!--T:37-->


<!--T:38-->
<!--T:38-->
The ''Python 3.x'' console launcher is available by default in a new JupyterLab session. When launched, a Python 3 interpreter is presented in a new JupyterLab tab.
The <i>Python 3.x</i> console launcher is available by default in a new JupyterLab session. When launched, a Python 3 interpreter is presented in a new JupyterLab tab.


==== Terminal ==== <!--T:39-->
==== Terminal ==== <!--T:39-->
Line 163: Line 163:


<!--T:43-->
<!--T:43-->
To enable the ''Julia 1.x'' notebook launcher, an <code>ijulia-kernel</code> module needs to be loaded. When launched, a Julia notebook is presented in a new JupyterLab tab.
To enable the <i>Julia 1.x</i> notebook launcher, an <code>ijulia-kernel</code> module needs to be loaded. When launched, a Julia notebook is presented in a new JupyterLab tab.


==== Python Notebook ==== <!--T:44-->
==== Python Notebook ==== <!--T:44-->
Line 176: Line 176:
* <code>scipy</code>
* <code>scipy</code>
* Other notable packages: <code>Cycler</code>, <code>futures</code>, <code>jupyter_client</code>, <code>jupyter_core</code>, <code>mpmath</code>, <code>pathlib2</code>, <code>pexpect</code>, <code>pickleshare</code>, <code>ptyprocess</code>, <code>pyzmq</code>, <code>simplegeneric</code>, <code>sympy</code>, <code>tornado</code>, <code>traitlets</code>
* Other notable packages: <code>Cycler</code>, <code>futures</code>, <code>jupyter_client</code>, <code>jupyter_core</code>, <code>mpmath</code>, <code>pathlib2</code>, <code>pexpect</code>, <code>pickleshare</code>, <code>ptyprocess</code>, <code>pyzmq</code>, <code>simplegeneric</code>, <code>sympy</code>, <code>tornado</code>, <code>traitlets</code>
* And many more (click on the <code>scipy-stack</code> module to see all ''Included extensions'')
* And many more (click on the <code>scipy-stack</code> module to see all <i>Included extensions</i>)


<!--T:46-->
<!--T:46-->
Line 185: Line 185:
<!--T:47-->
<!--T:47-->
To open an existing Python notebook:
To open an existing Python notebook:
* Go back to the ''File Browser''
* Go back to the <i>File Browser</i>
* Browse to the location of the <code>*.ipynb</code> file
* Browse to the location of the <code>*.ipynb</code> file
* Double-click on the <code>*.ipynb</code> file:
* Double-click on the <code>*.ipynb</code> file:
Line 192: Line 192:


<!--T:48-->
<!--T:48-->
To open a new Python notebook in the current ''File Browser'' directory:
To open a new Python notebook in the current <i>File Browser</i> directory:
* Click on the ''Python 3.x'' launcher under the ''Notebook'' section:
* Click on the <i>Python 3.x</i> launcher under the <i>Notebook</i> section:
** This will open a new Python 3 notebook in a new JupyterLab tab
** This will open a new Python 3 notebook in a new JupyterLab tab
** A new IPython kernel will start running in background for this notebook
** A new IPython kernel will start running in background for this notebook
Line 203: Line 203:
<!--T:51-->
<!--T:51-->
[[File:JupyterLab_Launcher_OpenRefine.png|thumb|OpenRefine launcher button]]
[[File:JupyterLab_Launcher_OpenRefine.png|thumb|OpenRefine launcher button]]
To enable the ''OpenRefine'' application launcher, an <code>openrefine</code> module needs to be loaded. Depending on the software environment version, the latest version of OpenRefine should be loaded:
To enable the <i>OpenRefine</i> application launcher, an <code>openrefine</code> module needs to be loaded. Depending on the software environment version, the latest version of OpenRefine should be loaded:
* With <code>StdEnv/2020</code>, load module: <code>openrefine/3.4.1</code>
* With <code>StdEnv/2020</code>, load module: <code>openrefine/3.4.1</code>
* With <code>StdEnv/2018.3</code>, load module: <code>openrefine/3.3</code>
* With <code>StdEnv/2018.3</code>, load module: <code>openrefine/3.3</code>


<!--T:52-->
<!--T:52-->
This ''OpenRefine'' launcher will open or reopen an OpenRefine interface in a new Web browser tab:
This <i>OpenRefine</i> launcher will open or reopen an OpenRefine interface in a new Web browser tab:
* It is possible to reopen an active OpenRefine session after the Web browser tab was closed
* It is possible to reopen an active OpenRefine session after the Web browser tab was closed
* The OpenRefine session will end when the JupyterLab session will end
* The OpenRefine session will end when the JupyterLab session will end
Line 216: Line 216:
<!--T:54-->
<!--T:54-->
[[File:JupyterLab_Launcher_RStudio.png|thumb|RStudio launcher button]]
[[File:JupyterLab_Launcher_RStudio.png|thumb|RStudio launcher button]]
To enable the ''RStudio'' application launcher in <code>StdEnv/2020</code>, load the module: <code>rstudio-server</code>
To enable the <i>RStudio</i> application launcher in <code>StdEnv/2020</code>, load the module: <code>rstudio-server</code>


<!--T:55-->
<!--T:55-->
Line 224: Line 224:


<!--T:56-->
<!--T:56-->
This ''RStudio'' launcher will open or reopen an RStudio interface in a new Web browser tab:
This <i>RStudio</i> launcher will open or reopen an RStudio interface in a new Web browser tab:
* It is possible to reopen an active RStudio session after the Web browser tab was closed
* It is possible to reopen an active RStudio session after the Web browser tab was closed
* The RStudio session will end when the JupyterLab session will end
* The RStudio session will end when the JupyterLab session will end
Line 232: Line 232:
<!--T:58-->
<!--T:58-->
[[File:JupyterLab_Launcher_VSCode.png|thumb|VS Code launcher button]]
[[File:JupyterLab_Launcher_VSCode.png|thumb|VS Code launcher button]]
To enable the ''VS Code'' (Visual Studio Code) application launcher, a <code>code-server</code> module needs to be loaded. Depending on the software environment version, the latest version of VS Code should be loaded:
To enable the <i>VS Code</i> (Visual Studio Code) application launcher, a <code>code-server</code> module needs to be loaded. Depending on the software environment version, the latest version of VS Code should be loaded:
* With <code>StdEnv/2020</code>, load module: <code>code-server/3.5.0</code>
* With <code>StdEnv/2020</code>, load module: <code>code-server/3.5.0</code>
* With <code>StdEnv/2018.3</code>, load module: <code>code-server/3.4.1</code>
* With <code>StdEnv/2018.3</code>, load module: <code>code-server/3.4.1</code>


<!--T:59-->
<!--T:59-->
This ''VS Code'' launcher will open or reopen the VS Code interface in a new Web browser tab:
This <i>VS Code</i> launcher will open or reopen the VS Code interface in a new Web browser tab:
* For a new session, the ''VS Code'' session can take up to 3 minutes to complete its startup.
* For a new session, the <i>VS Code</i> session can take up to 3 minutes to complete its startup.
* It is possible to reopen an active VS Code session after the Web browser tab was closed
* It is possible to reopen an active VS Code session after the Web browser tab was closed
* The VS Code session will end when the JupyterLab session will end
* The VS Code session will end when the JupyterLab session will end
Line 246: Line 246:
<!--T:61-->
<!--T:61-->
[[File:JupyterLab_Launcher_Desktop.png|thumb|Desktop launcher button]]
[[File:JupyterLab_Launcher_Desktop.png|thumb|Desktop launcher button]]
This ''Desktop'' launcher will open or reopen a remote Linux desktop interface in a new Web browser tab:
This <i>Desktop</i> launcher will open or reopen a remote Linux desktop interface in a new Web browser tab:
* This is equivalent to running a [[VNC#Compute_Nodes|VNC server on a compute node]], then creating an [[SSH_tunnelling|SSH tunnel]] and finally using a [[VNC#Setup|VNC client]], but you need nothing of all this with JupyterLab!
* This is equivalent to running a [[VNC#Compute_Nodes|VNC server on a compute node]], then creating an [[SSH_tunnelling|SSH tunnel]] and finally using a [[VNC#Setup|VNC client]], but you need nothing of all this with JupyterLab!
* It is possible to reopen an active desktop session after the Web browser tab was closed
* It is possible to reopen an active desktop session after the Web browser tab was closed
rsnt_translations
56,426

edits