Skip to content

Commit fb209e5

Browse files
committed
website: minor edits
1 parent 7b647cc commit fb209e5

File tree

4 files changed

+24
-22
lines changed

4 files changed

+24
-22
lines changed

docs/guides/install_and_launch.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ and bundles can be found.
1515

1616
Users who would like to **use** our tools installed at NERSC can find information in
1717
[this quickstart guide](/nersc/index.md).
18-
1918
Users who would like to **install** their copy at NERSC can find an example
2019
[here](/nersc/users_installation.md).
2120
:::

docs/guides/simulation_data.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,10 @@ generated using EAMv2, v3, and intermediate versions towards v4
88

99
## The horizontal dimension
1010

11-
Starting from version 2, QuickView has been generalized to handle all NetCDF
12-
variables on `pg2` cubed-sphere meshes regardless of what name is used
13-
for the horizontal dimension (e.g., `ncol` in EAM files and
11+
Starting from version 2, the ParaView Reader used in the tools
12+
has been generalized to handle all NetCDF
13+
variables on `ne*pg2` cubed-sphere meshes regardless of what name is used
14+
for the horizontal dimension (e.g., `ncol` in EAM files or
1415
`lndgrid` in ELM files).
1516

1617
Furthermore, QuickView2 has been generalized to visualize all variables
@@ -32,4 +33,7 @@ If a variable has an attribute named `missing_value` or `_FillValue`, the value
3233
is converted to NaN and ignored in the calculation of global averages and for
3334
the visualization.
3435

35-
## File groups
36+
## File groups
37+
38+
:::danger FIXME - add contents
39+
:::

docs/nersc/index.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ on separate pages:
1414
- How to install your own copy at NERSC: see [this example](./users_installation.md).
1515
- How to install the tools on a laptop or desktop computer: see [this page](/guides/install_and_launch).
1616

17-
## Quickstart for users familiar with JupyterHub
17+
## Quickstart for NERSC users familiar with JupyterHub
1818

1919
- Login to [JupytherHub](https://jupyter.nersc.gov/hub/login) and start a terminal window.
2020

@@ -32,14 +32,13 @@ on separate pages:
3232
/global/common/software/m4359/quickcompare
3333
```
3434

35-
- After a few seconds, the terminal window will say "Use URL below to connect to the application:"
36-
and show a URL starting.
37-
A click on the URL will bring up the graphical UI in a brower window.
35+
- After a few seconds, the terminal window will say "Use URL below to connect to the application"
36+
and show a URL. A click on the URL will bring up the graphical UI in a brower window.
3837

3938
::: tip Tip 1: Choosing a server for your analysis session.
40-
JupyterHub's control panel offers to NERSC users serveral different types of resources (nodes)
41-
for their computing and analyais needs, including, e.g., login node, shared GPU node,
42-
exclusive nodes, as explained in [NERSC's documentation](https://docs.nersc.gov/services/jupyter/reference/).
39+
JupyterHub's control panel provides NERSC users access to serveral different types of resources (nodes),
40+
including, e.g., login node, shared GPU node, exclusive nodes, as explained in
41+
[NERSC's documentation](https://docs.nersc.gov/services/jupyter/reference/).
4342

4443
Since login nodes are shared by users and hence can get very busy or run into memory constraints,
4544
and since our tools can make use of GPUs for interactive rendering,
@@ -50,15 +49,15 @@ will be charged to your project's allocation.
5049
:::
5150

5251
::: tip Tip 2: The same executables work for all types of nodes.
53-
Regardless of which type of node is chosen, the same commands (as listed above)
54-
are used to launch our tools in the QuickView family.
52+
Regardless of which type of nodes a user choses in JupyterHub's control panel,
53+
the same commands (executables) are used to launch our tools in the QuickView family.
5554
:::
5655

5756
::: tip Tip 3: No need for manual `module load conda`.
58-
When one of the commands provided above is used to launch tools in the QuickView family,
59-
there is no need to manually apply `module load conda` or activate the environment
60-
that our tools are installed in. This is because the above-mentioned commands are
61-
in fact scripts that have included those steps.
57+
When the commands provided above are used to launch tools in the QuickView family,
58+
there is no need to manually apply `module load conda` or activate the conda environment
59+
in which the tools are installed. This is because the commands mentioned earlier
60+
on this page are in fact scripts that have included those steps.
6261
:::
6362

6463
::: warning ATTENTION: Shut down the server when you are done!

docs/nersc/users_installation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ conda install conda-forge::e3sm_compareview
4343

4444
At this point, the user should be able to use the following commands to launch
4545
the individual tools, assuming the conda environment has been activated.
46-
(But read the [next section](#recommended:-executable-shortcuts) if you expect to use the tools often.)
46+
(But read the [next section](#recommended-shortcuts) if you expect to use the tools often.)
4747

4848
QuickView:
4949
```
@@ -54,10 +54,10 @@ QuickCompare:
5454
quickcompare -p 0
5555
```
5656

57-
## Recommended: executable shortcuts
57+
## Recommended shortcuts
5858

5959
Since the conda environment and tools are installed in custom paths, it will
60-
be useful to create shortcuts so that the apps can be lauched using very short 1-line commands.
60+
be useful to create shortcuts so that the tools can be lauched using very short 1-line commands.
6161

6262
### Setup step 1
6363

@@ -100,7 +100,7 @@ In the `.bashrc` or `.cshrc` file in your home directory, add something like
100100
alias quickv='/global/cfs/projectdirs/m4359/tools/quickview2'
101101
alias quickc='/global/cfs/projectdirs/m4359/tools/quickcompare'
102102
```
103-
### Using the apps through shortcuts
103+
### Using the tools through shortcuts
104104

105105
After the two setup steps have been completed, the user should be able
106106
to launch the tools by simply typing `quickv` or `quickc`

0 commit comments

Comments
 (0)