Skip to content

Commit cd4d217

Browse files
committed
website: start to revise info about NERSC
1 parent 28562d2 commit cd4d217

5 files changed

Lines changed: 50 additions & 4 deletions

File tree

docs/.vitepress/config.mjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ export default defineConfig({
1818
{ text: "News", link: "/news" },
1919
{ text: "Gallery", link: "/gallery/" },
2020
{ text: "User's Guide", link: "/guides/reminders" },
21-
{ text: "At NERSC", link: "/nersc/login" },
21+
{ text: "At NERSC", link: "/nersc/index" },
2222
{ text: "Repo", link: "https://github.com/Kitware/QuickView" },
2323
{ text: "Bugs and Requests", link: "https://github.com/Kitware/QuickView/issues" },
2424
],

docs/guides/install_and_launch.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Instal and launch
1+
# Install and launch
22

33
All tools of the **QuickView** family are available as
44
**conda** packages as well as **pre-compiled desktop bundles**

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ hero:
1111
actions:
1212
- theme: brand
1313
text: Installation
14-
link: /guides/installation
14+
link: /guides/install_and_launch
1515
- theme: brand
1616
text: User's Guide
1717
link: /guides/reminders
1818
- theme: brand
1919
text: Using it at NERSC
20-
link: /nersc/
20+
link: /nersc/index
2121

2222
features:
2323
- title: Purpose

docs/nersc/index.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# The QuickView tool family at NERSC
2+
3+
Our tools have been installed at NERSC,
4+
the National Energy Research Scientific Computing Center,
5+
and are continually updated there.
6+
Below are instructions for users who would like to use our installations.
7+
8+
User's who would like to understand how our installation was done
9+
or how to have their own installation are referred to [this page](installation_at_nersc.md).
10+
11+
## Quickstart for users familiar with JupyterHub
12+
13+
- Login to [JupytherHub](https://jupyter.nersc.gov/hub/login) and start a terminal window.
14+
- Optional but recommended: in the terminal, use the `cd` command to go to the directory where your data files are located.
15+
- QuickView version 2 can be launched using the following command:
16+
```
17+
/global/common/software/m4359/quickview2
18+
```
19+
- QuickCompare can be launched using the following command:
20+
```
21+
/global/common/software/m4359/quickcompare
22+
```
23+
- After a few seconds, the Terminal window will say "Use URL below to connect to the application:"
24+
and shows a URL starting with `https://`.
25+
A click on the URS will bring up the graphical UI in a brower window.
26+
27+
::: tip Tip: Choosing a server for your analysis session
28+
JupyterHub's control panel allows users to choose from serveral different types of resources
29+
for their computing and analyais needs, including, e.g., login node, shared GPU node,
30+
exclusive nodes, etc. Since login nodes are shared by users and hence can get very busy
31+
or run into memory constraints, we recommend that users choose a shared GPU node
32+
or an exclusive node and user our tools there.
33+
34+
Regardless of which type of node is chosen, the same commands (as listed above)
35+
are used to launch our tools in the QuickView family.
36+
:::
37+
38+
## For NERSC user's who have not used JupyterHub
39+
40+
Please visit [NERSC's Jupyter documentation](https://docs.nersc.gov/services/jupyter/)
41+
to learn how to use the JupyterHub service.
42+
43+
## If you do not yet have any user account at NERSC
44+
45+
Please visit [this page](https://docs.nersc.gov/accounts/#obtaining-an-account)
46+
to understand how to get started.
File renamed without changes.

0 commit comments

Comments
 (0)