Skip to content

Commit 095c670

Browse files
committed
Improve read-me
1 parent 4c0286b commit 095c670

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ option.
6767

6868
For example, to run the minimal example extension, place the output
6969
website in the `vv_test` directory, and serve the output
70-
website you'd run this command:
70+
website you\'d run this command:
7171

7272
```bash
7373
$ livv -V config/example/example.yml -o vv_test -s
@@ -82,7 +82,7 @@ the YAML configuration files so that `livv` can find the required files.
8282
Likewise, you can also apply these analyses to any new model run[^2] by
8383
adjusting the paths to point to your model run.
8484

85-
## Running cases on PM-CPU
85+
## Running existing cases on PM-CPU
8686

8787
The `lex/run_livv.sh` script will run all the currently
8888
available analyses on pm-cpu for a particular case, e.g.:
@@ -100,7 +100,12 @@ $ cd lex
100100
$ sbatch run_lex_pm-cpu.sbatch
101101
```
102102

103-
## Performing post-processing on a single time series ELM h0 output
103+
## Running new cases on PM-CPU
104+
105+
### Generate a single timeseries file from ELM h0 outputs
106+
- `ncrcat -v topo,landfrac,QSNOFRZ,FSRND,FSRVD,FSDSVD,FSDSND,EFLX_LH_TOT,FIRA,FLDS,FSA,FSDS,FSH,QICE,QRUNOFF,QSNOMELT,QSOIL,RAIN,SNOW,TSA elm*h0*.nc -o ${CASE}.nc`
107+
108+
### Perform post-processing on a single time series ELM h0 output
104109
- Edit the `lex/lex/postproc/e3sm/postproc.sbatch` batch file to mach the new run
105110

106111
Key variables:
@@ -111,6 +116,8 @@ $ sbatch run_lex_pm-cpu.sbatch
111116
- Run the post-processing script:
112117
- `cd lex/lex/postproc/e3sm; sbatch postproc.sbatch`
113118

119+
**NB**: the `postproc.sbatch` script will create the configuration for your case (based on `OUTCASE` and `OUTDIR`), then run LIVVkit on it with `lex/run_livv.sh`
120+
114121
## Developing a custom extension
115122

116123
See the [LIVVkit documentation](https://livvkit.github.io/Docs/lex.html)

0 commit comments

Comments
 (0)