Skip to content

Commit 202ae27

Browse files
committed
Update readme
1 parent b95968e commit 202ae27

File tree

2 files changed

+18
-13
lines changed

2 files changed

+18
-13
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,3 +134,6 @@ tags
134134

135135
# Visio autosave temporary files
136136
*.~vsd*
137+
# pixi environments
138+
.pixi/*
139+
!.pixi/config.toml

README.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -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
1515
this suite depends on a set of reanalysis and observational datasets,
1616
which are part of E3SM-Diags, available on several DOE supported
1717
machines, including Perlmutter at NERSC, and Chrysalis at ANL\'s LCRC.
@@ -22,7 +22,18 @@ planned to support other machines.
2222
## Environment setup
2323

2424
For 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.
3647
This will create a virtual environment at `lex/.env`, and install the
3748
LEX 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
4951
Not 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
5658
ELM r05 and r025 resolutions, as well as pre-existing configurations for
5759
several current runs.
5860

@@ -61,7 +63,7 @@ interface) to any of these extensions via the the `-V/--validate`
6163
option.
6264

6365
For 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
6567
website you\'d run this command:
6668

6769
```bash

0 commit comments

Comments
 (0)