|
1 | 1 | # QuickCompare @ NERSC |
2 | 2 |
|
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). |
4 | 6 |
|
5 | | -[ Click on the image to go to the login page](https://jupyter.nersc.gov/hub/login) |
| 7 | +Once connected, |
6 | 8 |
|
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 | +  |
8 | 14 |
|
9 | | - |
| 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. |
10 | 18 |
|
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. |
13 | 20 |
|
14 | | - |
15 | | - |
16 | | -Once you picked your target location and allocation, you will have to wait for the service to start. |
17 | | - |
18 | | - |
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 | + <!--  --> |
29 | 24 |
|
30 | 25 | :::danger FIXME - image |
31 | 26 | ::: |
32 | 27 |
|
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 | + <!--  --> |
35 | 32 |
|
36 | 33 | :::danger FIXME - image |
37 | 34 | ::: |
38 | 35 |
|
39 | | -Finally select the fields you want to load and inspect. |
| 36 | +- **Need to talk about two-sim or multi-sim comparisons** |
40 | 37 |
|
41 | 38 | :::danger FIXME - image |
42 | 39 | ::: |
43 | 40 |
|
| 41 | +- Finally, select the variables you want to load and inspect. |
| 42 | + <!--  --> |
44 | 43 |
|
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. |
46 | 57 |
|
47 | 58 |  |
| 59 | +::: |
0 commit comments