@@ -11,7 +11,7 @@ LEX was first described in Evans, et al., 2019[^1]
1111
1212## Dependencies
1313
14- The Python dependencies are listed in ` pyproject.toml ` , but
14+ The Python dependencies are listed in requirements * .txt but
1515this suite depends on a set of reanalysis and observational datasets,
1616which are part of E3SM-Diags, available on several DOE supported
1717machines, including Perlmutter at NERSC, and Chrysalis at ANL\' s LCRC.
@@ -22,7 +22,18 @@ planned to support other machines.
2222## Environment setup
2323
2424For setting up an environment to which lex and dependencies will be
25- installed, conda and Python virtualenv are documented here.
25+ installed, conda and Python virtualenv are documented here. ** NB** this
26+ will only currently work on NERSC's Perlmutter, the environment should be
27+ created there.
28+
29+ ### Conda environment
30+ ``` 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.
36+ ```
2637
2738### Python virtualenv
2839``` bash
@@ -36,23 +47,14 @@ installed, conda and Python virtualenv are documented here.
3647This will create a virtual environment at ` lex/.env ` , and install the
3748LEX package as editable with all its Python requirements to run.
3849
39- ### Conda environment
40- ``` bash
41- git clone https://github.com/LIVVkit/lex.git
42- cd lex
43- {conda, mamba} create -n lex_env python --file requirements.txt
44- {conda, mamba} activate lex_env
45- lex_env pip install -e .
46- ```
47-
4850### Other available environment management solutions
4951Not documented here, but also available for environment management
5052- [ uv] ( https://docs.astral.sh/uv/ )
5153- [ pixi] ( https://pixi.sh/latest/ )
5254
5355## Basic usage
5456
55- Within the [ lex/config] {.title-ref} directory there are templates for
57+ Within the ` lex/config ` directory there are templates for
5658ELM r05 and r025 resolutions, as well as pre-existing configurations for
5759several current runs.
5860
@@ -61,7 +63,7 @@ interface) to any of these extensions via the the `-V/--validate`
6163option.
6264
6365For example, to run the minimal example extension, place the output
64- website in the [ vv_test] {.title-ref} directory, and serve the output
66+ website in the ` vv_test ` directory, and serve the output
6567website you\' d run this command:
6668
6769``` bash
0 commit comments