11# Installing your own copy of the QuickView tool family at NERSC
22
33The steps described below follow the same logic as documented on
4- [ this page] ( ./installation_at_nersc .md ) ,
4+ [ this page] ( ./public_installation .md ) ,
55expect that
66
77- the tools are installed to a different path, ` /global/cfs/projectdirs/m4359/tools/ ` ,
88 which we refer to as ` ${pathRoot} ` in the following, and
9- - the environment is named ` quickview-env ` ,
10- which we refer to as ` ${envName} `
9+ - the conda environment is named ` quickview-env ` ,
10+ which we refer to as ` ${envName} ` below.
11+
12+ ::: warning Note!
13+ Please ** use a login node for the installation** . After that,
14+ the tools can be used on login nodes or other types of nodes
15+ via the same commands/shortcuts.
16+ :::
1117
1218## Create a ` conda ` environment
1319
14- Create a directory for the conda environment:
20+ Create a directory for the conda environment needed for installing our tools :
1521``` sh
1622mkdir -p ${pathRoot} /conda-envs
1723```
@@ -22,7 +28,7 @@ module load conda
2228conda create --prefix ${pathRoot} /conda-envs/${envName} python=3.13
2329```
2430
25- ## Activate the environment and install tools in the family
31+ ## Activate the environment and install our tools
2632
2733Install QuickView
2834``` sh
@@ -36,7 +42,9 @@ conda install conda-forge::e3sm_compareview
3642
3743## Using the installed apps
3844
39- At this point, the user should be able to use the following commands to launch the individual tools:
45+ At this point, the user should be able to use the following commands to launch
46+ the individual tools, assuming the conda environment has been activated.
47+ (But read the [ next section] ( #recommended:-executable-shortcuts ) if you expect to use the tools often.)
4048
4149QuickView:
4250```
@@ -47,14 +55,14 @@ QuickCompare:
4755quickcompare -p 0
4856```
4957
50- ## Recommended: executable Shortcuts
58+ ## Recommended: executable shortcuts
5159
5260Since the conda environment and tools are installed in custom paths, it will
53- be useful to create shortcuts so that the apps can be lauched using short commands.
61+ be useful to create shortcuts so that the apps can be lauched using very short 1-line commands.
5462
55- ### Set up, step 1
63+ ### Setup step 1
5664
57- We can create a script ` ${pathRoot}/quickview ` with the following content
65+ We can create a script ` ${pathRoot}/quickview2 ` with the following contents:
5866``` sh
5967#! /usr/bin/env bash
6068
@@ -63,14 +71,14 @@ envName="quickview-env"
6371
6472module load conda
6573conda activate ${pathRoot} /conda-envs/${envName}
66- quickview -p 0 --fast
74+ quickview -p 0
6775```
6876And to make the shortcut executable, we do
69- ```
70- chmod +x ${pathRoot}/quickview
77+ ``` sh
78+ chmod +x ${pathRoot} /quickview2
7179```
7280
73- Similarily, we create a script` ${pathRoot}/quickcompare ` with the following content
81+ Similarily, we create a script` ${pathRoot}/quickcompare ` with the following contents:
7482``` sh
7583#! /usr/bin/env bash
7684
@@ -82,33 +90,43 @@ conda activate ${pathRoot}/conda-envs/${envName}
8290quickcompare -p 0
8391```
8492And to make the shortcut executable, we do
85- ```
93+ ``` sh
8694chmod +x ${pathRoot} /quickcompare
8795```
8896
89- ### Set up, step 2
97+ ### Setup step 2
9098
91- In the ` .bashrc ` or ` .cshrc ` file in your home directory, add
92- ```
93- alias quickv='/global/cfs/projectdirs/m4359/tools/quickview '
99+ In the ` .bashrc ` or ` .cshrc ` file in your home directory, add something like
100+ ``` sh
101+ alias quickv=' /global/cfs/projectdirs/m4359/tools/quickview2 '
94102alias quickc=' /global/cfs/projectdirs/m4359/tools/quickcompare'
95103```
96104### Using the apps through shortcuts
97105
98106After the two setup steps have been completed, the user should be able
99- to launch the tools by symply typing ` quickv ` or ` quickc `
107+ to launch the tools by simply typing ` quickv ` or ` quickc `
100108in a terminal window in the JupyterHub.
101109Again, the same commands can be used regardless of whether the terminal
102110window is connected to a login node or a shared GPU node etc.
103111
104112
105113## Updating an application
106114
107- In order to update a given application you will need to find the version you want to install and then run something like:
115+ In order to update the tools to the newest available versions on conda-forge
116+ (see links in the summary table on [ this page] ( /guides/install_and_launch.md ) ,
117+ you will need to find the versions you want to install and then run something like
118+ the following.
108119
109120``` sh
121+ pathRoot=" /global/cfs/projectdirs/m4359/tools/"
122+ envName=" quickview-env"
123+
124+ quickview_version_new=" 2.1.1"
125+ quickcomp_version_new=" 1.3.4"
126+
110127module load conda
111- conda activate /global/common/software/m4359/ conda-envs/e3sm-quickview
128+ conda activate ${pathRoot} / conda-envs/${envName}
112129
113- conda install " e3sm-quickview>=1.3.3" # <== fix version
130+ conda install " e3sm-quickview>=${quickview_version_new} "
131+ conda install " e3sm_compareview>=${quickcomp_version_new} "
114132```
0 commit comments