Skip to content

Commit 2886cd1

Browse files
committed
website: update info on installation at NERSC
1 parent cf50c7d commit 2886cd1

3 files changed

Lines changed: 59 additions & 40 deletions

File tree

docs/.vitepress/config.mjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export default defineConfig({
2929
text: "At NERSC",
3030
items: [
3131
{ text: "Quickstart", link: "/nersc/index" },
32-
{ text: "(not-yet-)Public Installation", link: "/nersc/public_installation" },
32+
{ text: "Public Installation", link: "/nersc/public_installation" },
3333
{ text: "User's Installation", link: "/nersc/users_installation" },
3434
],
3535
},

docs/nersc/index.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# The QuickView tool family at NERSC
22

3+
![NERSC logo](/logos/nersc.png)
34
Our tools have been installed at NERSC,
45
the [National Energy Research Scientific Computing Center](https://www.nersc.gov/),
56
and are continually updated there.
@@ -24,12 +25,12 @@ on separate pages:
2425

2526
- **QuickView version 2** can be launched using the following command:
2627
```
27-
/global/cfs/projectdirs/m4359/tools/quickview2
28+
/global/common/software/m4359/quickview2
2829
```
2930

3031
- **QuickCompare** can be launched using the following command:
3132
```
32-
/global/cfs/projectdirs/m4359/tools/quickcompare
33+
/global/common/software/m4359/quickcompare
3334
```
3435

3536
- After a few seconds, the terminal window will provide a URL.
@@ -81,7 +82,7 @@ Also see below for a recap of the steps (clicks).
8182

8283

8384

84-
## For NERSC users who have not used JupyterHub
85+
## Tips for NERSC users who have not used JupyterHub
8586

8687
Please see
8788
[this section of NERSC's documentation](https://docs.nersc.gov/beginner-guide/#keypad-entry-log-in-using-jupyter),
@@ -90,7 +91,7 @@ to learn about the service.
9091

9192
Alternatively, follow our step-by-step description [here](./jupyter_at_nersc.md)
9293

93-
## If you do not yet have any user account at NERSC
94+
## Information for users who do not yet have an account at NERSC
9495

9596
Information on [this page](https://docs.nersc.gov/accounts/#obtaining-an-account)
9697
can help you get started.

docs/nersc/public_installation.md

Lines changed: 53 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,74 +1,92 @@
1-
# NERSC setup explained
1+
# Developers' Installation at NERSC
22

33
The QuickView family of tools are Python packages.
4-
We have installed them and have been frequently updating them under
5-
NERSC project m4359 associated with the SciDAC project that
6-
has been funding our development.
4+
They have been installed and are frequently updated at NERSC under project m4359.
75

8-
We are working on making the installation publicly accessible by
9-
all NERSC users. In the meantime, NERSC users can use the following
10-
commands to access QuickView and QuickCompare, instead.
6+
NERSC users who would like to **use** the developers' installation
7+
can start a terminal (shell) window through NERSC's JupyterHub
8+
(see step-by-step guide [here](./jupyter_at_nersc))
9+
and then use the following commands to start QuickView and QuickCompare,
10+
respectively.
1111

1212
```
13-
/global/cfs/projectdirs/m4359/tools/quickview2
13+
/global/common/software/m4359/quickview2
1414
```
1515

1616
```
17-
/global/cfs/projectdirs/m4359/tools/quickcompare
17+
/global/common/software/m4359/quickcompare
1818
```
1919

20-
If you want to have your own installation at a location of your choices,
21-
please take a look at [this page](./users_installation.md).
20+
For installing the tools at a location of the user's choice,
21+
an example is provided on [this page](./users_installation.md).
2222

23-
::: danger The rest of this page will be updated after we consolidate
24-
QuickView and QuickCompare into one environment.
25-
:::
23+
The remainder of this page documents how the developers' installation was done.
2624

27-
## Create custom conda environments
2825

29-
Create a directory for all the conda environments we aim to enable for our users.
26+
## Setting default permissions
3027

31-
```sh
32-
mkdir -p /global/common/software/m4359/conda-envs
28+
To allow any developer in project m4359 to install, uninstall, or update
29+
and to allow all NERSC users to use the installtion, we set the default permission using
30+
```
31+
umask 002
3332
```
3433

35-
Then for each project we will create an environment inside that directory.
34+
## One-time action: creating custom conda environment
35+
3636

3737
```sh
38+
mkdir -p /global/common/software/m4359/conda-envs
39+
3840
module load conda
39-
conda create --prefix /global/common/software/m4359/conda-envs/e3sm-quickview python=3.13
41+
conda create --prefix /global/common/software/m4359/conda-envs/quickview-family python=3.13
42+
```
43+
44+
## First installation
45+
4046
```
47+
conda activate /global/common/software/m4359/conda-envs/quickview-family
48+
conda install conda-forge::e3sm-quickview
49+
conda install conda-forge::e3sm_compareview
50+
```
51+
52+
## Updating to newer versions
4153

42-
After that you can activate such environment and install the application like QuickView
54+
Different members of the QuickView tool family are versioned separately.
55+
The current (newest) version numbers are summarized in the table at the beginning
56+
of [this page](../guides/install_and_lauch).
57+
The following commands were used to update QuickView to version 2.1.1
58+
and QuickCompare to version 1.3.5.
4359

4460
```sh
45-
conda activate /global/common/software/m4359/conda-envs/e3sm-quickview
46-
conda install e3sm-quickview
61+
module load conda
62+
conda activate /global/common/software/m4359/conda-envs/quickview-family
63+
64+
conda install "e3sm-quickview>=2.1.2"
65+
conda install "e3sm_compareview>=1.3.5"
4766
```
4867

49-
## Executable Shortcut
68+
## Shortcuts to the executables
5069

51-
Inside `/global/common/software/m4359/` you can create shell script that will provide a shortcut for starting each application.
70+
The commands listed at the beginning of this page are in fact scripts
71+
with the following contents. These scripts were created to allow
72+
the users to start any tool in the QuickView family using a single command.
5273

53-
For example, we've created `/global/common/software/m4359/quickview` with the following content
74+
`/global/common/software/m4359/quickview2` is a script with the following contents
5475

5576
```sh
5677
#!/usr/bin/env bash
5778

5879
module load conda
59-
conda activate /global/common/software/m4359/conda-envs/e3sm-quickview
80+
conda activate /global/common/software/m4359/conda-envs/quickview-family
6081
quickview -p 0
6182
```
6283

63-
And to make that file executable, you can run `chmod +x /global/common/software/m4359/quickview` to streamline its usage.
64-
65-
## Updating an application
66-
67-
In order to update a given application you will need to find the version you want to install and then run something like:
84+
Similarly, `/global/common/software/m4359/quickcompare` is a script with the following contents
6885

6986
```sh
70-
module load conda
71-
conda activate /global/common/software/m4359/conda-envs/e3sm-quickview
87+
#!/usr/bin/env bash
7288

73-
conda install "e3sm-quickview>=1.3.3" # <== fix version
89+
module load conda
90+
conda activate /global/common/software/m4359/conda-envs/quickview-family
91+
quickcompare -p 0
7492
```

0 commit comments

Comments
 (0)