Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merging into proposed_changes to prepare for merging into main #80

Merged
merged 7 commits into from
Oct 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
49 changes: 49 additions & 0 deletions docs/source/user_guide/software.rst
Original file line number Diff line number Diff line change
Expand Up @@ -378,4 +378,53 @@ You can use the ``library()`` command to view all your user and system-installed
tools Tools for Package Development
utils The R Utils Package

.. _jupyterlab:

Launching a JupyterLab Session
--------------------------------

Launch a JupyterLab session in a web browser with the following steps.

#. Log in to ``ng-login01``. (Replace ``username`` with your Nightingale username in **both** places.)

.. code-block:: terminal

ssh -J username@ngale-bastion-1.ncsa.illinois.edu username@ng-login01

#. On the login node, run the following commands:

.. code-block:: terminal

module load anaconda3/2024.02 ng_scripts/0.4

.. code-block:: terminal

ng_jupyter_lab_tunnel.bash

Take note of the URL at the end of the output of the ``.bash`` command, you will use this URL **step 4**.

#. Leave your first terminal open, and open a **second terminal** on your local machine. In the **second terminal**, run the following command and complete the login prompts. (Replace ``username`` with your Nightingale username in **both** places.)

.. code-block:: terminal

ssh -J username@ngale-bastion-1.ncsa.illinois.edu -L 13000:localhost:13000 username@ng-login01.ngale.internal.ncsa.edu

You may get a prompt similar to: "Are you sure you want to continue connecting (yes/no/[fingerprint])?". Respond with ``yes`` and complete any additional password prompts.

#. Open a web browser on your local machine and paste the URL from **step 2** into the web browser.

A JupyterLab session will launch in the web browser.

.. figure:: images/software/jupyterlab-url-terminal.jpg
:alt: Example terminal windows logged into Nightingale with the output URL highlighted.
:width: 1000

.. figure:: images/software/jupyterlab-url-browser.jpg
:alt: Web browser showing example output URL.
:width: 1000

.. figure:: images/software/jupyterlab.png
:alt: JupyterLab session opened in a web browser.
:width: 1000

|