Skip to content

Commit db96c6b

Browse files
committed
website: draft page for QuickCompare at NERSC
1 parent 0ee189f commit db96c6b

3 files changed

Lines changed: 45 additions & 29 deletions

File tree

docs/nersc/jupyter_at_nersc.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
Contents on this page
2+
3+
[[toc]]
4+
15
# Using JupyterHub to log in to NERSC
26

37
To use the QuickView family of tools at NERSC, you first need to login to JupyterHub using
@@ -19,15 +23,15 @@ Hence, after you are done with the analysis, remember to
1923

2024
![](./login/login-02.png)
2125

22-
After clicking on one of the "start" buttons in the image above,
26+
After clicking on one of the "start" buttons,
2327
you will see something like the screenshot below and will
2428
likely have to wait for some seconds for the service to be ready.
2529

2630
![](./login/login-03.png)
2731

2832
# Shut down the server when you are done
2933

30-
::: warning Reminder: Shut down the server when you are done.
34+
::: warning IMPORTANT: Shut down the server when you are done!
3135
After finishing your analysis, please remember to shut down the connection to your selected
3236
server (node) to stop the charging of hours to your project's allocation.
3337
This is explained at the end of
Lines changed: 37 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,59 @@
11
# QuickCompare @ NERSC
22

3-
To use QuickCompare at NERSC, you first need to login
3+
To use QuickCompare 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](./jupyter_at_nersc.md).
46

5-
[![](./login/login-00.png) Click on the image to go to the login page](https://jupyter.nersc.gov/hub/login)
7+
Once connected,
68

7-
Once you've enter your __login__ and __password__ you will need to feel a OTP.
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](./jupyter_launcher_terminal.png)
814

9-
![](./login/login-01.png)
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.
1018

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.
19+
- Starting QuickCompare using the command `/global/common/software/m4359/quickcompare` in the shell.
1320

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-
## QuickCompare
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/quickcompare
28-
```
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) -->
2924

3025
:::danger FIXME - image
3126
:::
3227

33-
Click on the link provided by the application execution.
34-
Then in the new graphical interface showing in the new browser tab, select the files you aim to load.
28+
- The graphical UI will prompt you to choose connectivity and simulation files, see example below.
29+
Double click your connecitivity file and then the simulation files, then
30+
click on the blue "Load Files" button in the bottom-right corner
31+
<!-- ![](./quickview/quickview-file-loading.png) -->
3532

3633
:::danger FIXME - image
3734
:::
3835

39-
Finally select the fields you want to load and inspect.
36+
- **Need to talk about two-sim or multi-sim comparisons**
4037

4138
:::danger FIXME - image
4239
:::
4340

41+
- Finally, select the variables you want to load and inspect.
42+
<!-- ![](./quickview/quickview-variable-selection.png) -->
4443

45-
## Release resources
44+
## Shut down the server when you are done
45+
46+
::: warning IMPORTANT: Shut down the server when you are done.
47+
After finishing your analysis, please remember to shut down the connection to your selected
48+
server (node) to stop the charging of hours to your project's allocation.
49+
This is explained at the end of
50+
[this video](https://docs.nersc.gov/beginner-guide/#keypad-entry-log-in-using-jupyter),
51+
and below is a recap of the steps (clicks):
52+
- go to the JupytherHub window/tab in your browser,
53+
- click `File` in the top-left corner,
54+
- scroll down and choose `Hub Control Panel`,
55+
- in the Control Panel brought up in a new browser tab/window, click on the red "stop" button
56+
for the server to be shut down. An example is shown in the screenshot below.
4657

4758
![](./login/login-04.png)
59+
:::

docs/nersc/perlmutter-run-quickview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,12 @@ Once connected,
2727
click on the blue "Load Files" button in the bottom-right corner
2828
![](./quickview/quickview-file-loading.png)
2929

30-
- Finally select the variables you want to load and inspect.
30+
- Finally, select the variables you want to load and inspect.
3131
![](./quickview/quickview-variable-selection.png)
3232

3333
## Shut down the server when you are done
3434

35-
::: warning Reminder: Shut down the server when you are done.
35+
::: warning IMPORTANT: Shut down the server when you are done.
3636
After finishing your analysis, please remember to shut down the connection to your selected
3737
server (node) to stop the charging of hours to your project's allocation.
3838
This is explained at the end of

0 commit comments

Comments
 (0)