|
1 | | -# NERSC setup explained |
| 1 | +# Developers' Installation at NERSC |
2 | 2 |
|
3 | 3 | 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. |
7 | 5 |
|
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. |
11 | 11 |
|
12 | 12 | ``` |
13 | | -/global/cfs/projectdirs/m4359/tools/quickview2 |
| 13 | +/global/common/software/m4359/quickview2 |
14 | 14 | ``` |
15 | 15 |
|
16 | 16 | ``` |
17 | | -/global/cfs/projectdirs/m4359/tools/quickcompare |
| 17 | +/global/common/software/m4359/quickcompare |
18 | 18 | ``` |
19 | 19 |
|
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). |
22 | 22 |
|
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. |
26 | 24 |
|
27 | | -## Create custom conda environments |
28 | 25 |
|
29 | | -Create a directory for all the conda environments we aim to enable for our users. |
| 26 | +## Setting default permissions |
30 | 27 |
|
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 |
33 | 32 | ``` |
34 | 33 |
|
35 | | -Then for each project we will create an environment inside that directory. |
| 34 | +## One-time action: creating custom conda environment |
| 35 | + |
36 | 36 |
|
37 | 37 | ```sh |
| 38 | +mkdir -p /global/common/software/m4359/conda-envs |
| 39 | + |
38 | 40 | 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 | + |
40 | 46 | ``` |
| 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 |
41 | 53 |
|
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. |
43 | 59 |
|
44 | 60 | ```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" |
47 | 66 | ``` |
48 | 67 |
|
49 | | -## Executable Shortcut |
| 68 | +## Shortcuts to the executables |
50 | 69 |
|
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. |
52 | 73 |
|
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 |
54 | 75 |
|
55 | 76 | ```sh |
56 | 77 | #!/usr/bin/env bash |
57 | 78 |
|
58 | 79 | 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 |
60 | 81 | quickview -p 0 |
61 | 82 | ``` |
62 | 83 |
|
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 |
68 | 85 |
|
69 | 86 | ```sh |
70 | | -module load conda |
71 | | -conda activate /global/common/software/m4359/conda-envs/e3sm-quickview |
| 87 | +#!/usr/bin/env bash |
72 | 88 |
|
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 |
74 | 92 | ``` |
0 commit comments