@@ -23,26 +23,26 @@ planned to support other machines.
2323
2424For setting up an environment to which lex and dependencies will be
2525installed, conda and Python virtualenv are documented here. ** NB** this
26- will only currently work on NERSC's Perlmutter, the environment should be
26+ will only currently work on NERSC's Perlmutter, the environment should be
2727created there.
2828
29- ### Conda environment
29+ ### Conda environment
3030``` bash
31- git clone https://github.com/LIVVkit/lex.git
32- cd lex
33- {conda, mamba} create -n lex_env python --file requirements.txt
34- {conda, mamba} activate lex_env
35- pip install -e . # Installs the lex module as an editable Python package to the lex_env environment.
31+ $ git clone https://github.com/LIVVkit/lex.git
32+ $ cd lex
33+ $ {conda, mamba} create -n lex_env python --file requirements.txt
34+ $ {conda, mamba} activate lex_env
35+ $ pip install -e . # Installs the lex module as an editable Python package to the lex_env environment.
3636```
3737
3838### Python virtualenv
3939``` bash
40- git clone https://github.com/LIVVkit/lex.git
41- cd lex python -m venv .env
42- source .env/bin/activate
43- pip install --upgrade pip # Needed if the system pip version < 21.3
44- pip install -e .
45- ```
40+ $ git clone https://github.com/LIVVkit/lex.git
41+ $ cd lex python -m venv .env
42+ $ source .env/bin/activate
43+ $ pip install --upgrade pip # Needed if the system pip version < 21.3
44+ $ pip install -e .
45+ ```
4646
4747This will create a virtual environment at ` lex/.env ` , and install the
4848LEX package as editable with all its Python requirements to run.
@@ -67,9 +67,9 @@ website in the `vv_test` directory, and serve the output
6767website you\' d run this command:
6868
6969``` bash
70- livv -V config/example/example.yml -o vv_test -s
70+ $ livv -V config/example/example.yml -o $SCRATCH / vv_test -s
7171```
72-
72+ This will create a directory in ` $SCRATCH ` called ` vv_test `
7373* Note:* All the extension configurations files assume you are working
7474from the top level ` lex ` directory. You * can* run any of these
7575extensions from any directory, but you will need to edit the paths in
@@ -83,22 +83,22 @@ adjusting the paths to point to your model run.
8383The ` lex/run_livv.sh ` script will run all the currently
8484available analyses on pm-cpu for a particular case, e.g.:
8585``` bash
86- cd lex
87- ./run_livv.sh v2.1.r025.IGERA5ELM_MLI-deep_firn_1980_2020
86+ $ cd $HOME / lex
87+ $ ./run_livv.sh v2.1.r025.IGERA5ELM_MLI-deep_firn_1980_2020
8888```
89- Will create a web output at ` /global/cfs/projectdirs/e3sm/www/${USER}/v2.1.r025.IGERA5ELM_MLI-deep_firn_1980_2020 ` ,
89+ Will create a web output at ` /global/cfs/projectdirs/e3sm/www/${USER}/v2.1.r025.IGERA5ELM_MLI-deep_firn_1980_2020 ` ,
9090viewable at https://portal.nersc.gov/project/e3sm/${USER}/v2.1.r025.IGERA5ELM_MLI-deep_firn_1980_2020
9191
9292The batch script provided will run all current cases on Perlmutter on a
93- compute node in parallel
93+ compute node in parallel
9494``` bash
95- cd lex
96- sbatch run_lex_pm-cpu.sbatch
95+ $ cd lex
96+ $ sbatch run_lex_pm-cpu.sbatch
9797```
9898
9999## Performing post-processing on a single time series ELM h0 output
100100- Edit the ` lex/lex/postproc/e3sm/postproc.sbatch ` batch file to mach the new run
101-
101+
102102 Key variables:
103103 - ` INDIR ` : Path which contains single output time series file
104104 - ` OUTCASE ` : Name of the new case which is the name of the netCDF file without extension (e.g. ` v2.1.r025.IGERA5ELM_MLI-deep_firn_1980_2020 ` )
@@ -137,8 +137,6 @@ Want to send us a private message?
137137
138138** Katherine J. Evans** :github: \@ kevans32
139139
140-
141-
142140[ ^ 1 ] : Evans, K.J., J.H. Kennedy, D. Lu, M.M. Forrester, S. Price, J. Fyke,
143141 A.R. Bennett, M.J. Hoffman, I. Tezaur, C.S. Zender, and M. Vizcaino
144142 (2019). LIVVkit 2.1: Automated and extensible ice sheet model
0 commit comments