Skip to content

Commit e311226

Browse files
committed
website: work on step-by-step guides
1 parent 4546dfe commit e311226

7 files changed

Lines changed: 63 additions & 44 deletions

docs/.vitepress/config.mjs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ export default defineConfig({
3535
{
3636
text: "Step-by-step Guides",
3737
items: [
38+
{ text: "JupyterHub", link: "/nersc/jupyter_at_nersc" },
3839
{ text: "QuickView", link: "/nersc/perlmutter-run-quickview" },
3940
{
4041
text: "QuickCompare",

docs/nersc/jupyter_at_nersc.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Using JupyterHub to log in to NERSC
2+
3+
To use the QuickView family of tools at NERSC, you first need to login to JupyterHub using
4+
[this link](https://jupyter.nersc.gov/hub/login), which will bring you to a page like the screenshot below.
5+
6+
![JupyterHub login](./login/login-00.png)
7+
8+
Once you've enter your __login__ and __password__ you will need to fill an OTP (One Time Password).
9+
10+
![](./login/login-01.png)
11+
12+
After that, you will be presented with a list of options for where you would like to run your application.
13+
For the QuickView family, it is better to have hardware with a GPU to allow interactive rendering.
14+
15+
![](./login/login-02.png)
16+
17+
Once you picked your target location and allocation, you will have to wait for some seconds for the service to start.
18+
19+
![](./login/login-03.png)
20+
64.8 KB
Loading
Lines changed: 42 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,46 @@
11
# QuickView @ NERSC
22

3-
To use QuickView at NERSC, you first need to login
4-
5-
[![](./login/login-00.png) Click on the image to go to the login page](https://jupyter.nersc.gov/hub/login)
6-
7-
Once you've enter your __login__ and __password__ you will need to feel a OTP.
8-
9-
![](./login/login-01.png)
10-
11-
At that point you will presented with a list of options on where you would like to run your application.
12-
For QuickView it is better to have hardware with a GPU to allow interactive rendering.
13-
14-
![](./login/login-02.png)
15-
16-
Once you picked your target location and allocation, you will have to wait for the service to start.
17-
18-
![](./login/login-03.png)
19-
20-
## QuickView
21-
22-
Once connected, you should start the terminal from the Launcher options of JupyterHub. Then you should go to the directory that contains the data you would like to see. While that step is optional, it may save you some navigation time with the application UI.
23-
24-
Once ready, you should start the application by running:
25-
26-
```sh
27-
/global/common/software/m4359/quickview
28-
```
29-
30-
31-
32-
![](./quickview/quickview-00.png)
33-
34-
Click on the link provided by the application execution.
35-
Then in the new graphical interface showing in the new browser tab, select the files you aim to load.
36-
37-
![](./quickview/quickview-01.png)
38-
39-
Finally select the fields you want to load and inspect.
40-
41-
![](./quickview/quickview-02.png)
42-
43-
44-
## Release resources
45-
46-
Can be access in the Menu `File > Hub Control Panel`
3+
To use QuickView at NERSC to directly access and analyze data files there,
4+
users need to first connect to NERSC using JupyterHub, as described
5+
[on this page](/guides/nersc/jupyter_at_nersc.md).
6+
7+
Once connected,
8+
9+
- Start a Terminal from the Launcher options of JupyterHub.
10+
You will likely need to scroll down in the Launcher in order to
11+
see the "Other" section and the Terminal icon there, as shown in the screenshot below.
12+
Click on the Terminal icon, and the Launcher window should turn into a shell.
13+
!["Other" section of JupyterHub Launcher window](/guides/nersc/jupyter_launcher_terminal.png)
14+
15+
- *Optional but recommended*: in the shell, use the `cd` command to go to
16+
the directory where your data files are located (or a directory closer to the data files than your home directory).
17+
While that step is optional, it may save you quick some clicks later in the graphical UI.
18+
19+
- Starting **QuickView** using the command `/global/common/software/m4359/quickview` in the shell.
20+
21+
- After a few seconds, the Terminal window will provide a URL, similar to the screenshot below.
22+
A click on the URL will bring up the graphical UI in a separate brower window or tab.
23+
![](./quickview/quickview-terminal-with-url.png)
24+
25+
- The graphical UI will prompt you to choose connectivity and simulation files, see example below.
26+
Double click your connecitivity file and then the simulation file, then
27+
click on the blue "Load Files" button in the bottom-right corner
28+
![](./quickview/quickview-file-loading.png)
29+
30+
- Finally select the variables you want to load and inspect.
31+
![](./quickview/quickview-variable-selection.png)
32+
33+
::: warning Reminder: Shut down the server when you are done.
34+
After finishing your analysis, please remember to shut down the connection to your selected
35+
server (node) to stop the charging of hours to your project's allocation.
36+
This is explained at the end of
37+
[this video](https://docs.nersc.gov/beginner-guide/#keypad-entry-log-in-using-jupyter),
38+
and below is a recap of the steps (clicks):
39+
- go to the JupytherHub window/tab in your browser,
40+
- click `File` in the top-left corner,
41+
- scroll down and choose `Hub Control Panel`,
42+
- in the Control Panel brought up in a new browser tab/window, click on the red "stop" button
43+
for the server to be shut down. An example is shown in the screenshot below.
4744

4845
![](./login/login-04.png)
46+
:::
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)