Skip to content

Commit

Permalink
compacted notes on environment
Browse files Browse the repository at this point in the history
  • Loading branch information
TeaganKing committed Dec 7, 2023
1 parent 4cdb53d commit e95ed23
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,7 @@ CUPiD is a collaborative effort that unifies all CESM component diagnostics and
To install CUPiD, you need to check out the code and then set up a few environments.
The initial examples have hard-coded paths that require you to be on `casper`.

The code relies on submodules to install `manage_externals` and then uses `manage_externals` for one more package,
so the `git clone` process is a little more complicated than usual:
The code relies on submodules to install `manage_externals` and then uses `manage_externals` for one more package, so the `git clone` process is a little more complicated than usual:

```
$ git clone --recurse-submodules https://github.com/NCAR/CUPiD.git
Expand All @@ -35,17 +34,17 @@ $ which nbscuid-run
$ conda env create -f mom6-environment.yml
```

IF `which nbscuid-run` returned the error `which: no nbscuid-run in ($PATH)`, then please run the following:
Notes:

1. `conda` now defaults to using `mamba` to solve environments; the `mom6-environment.yml` environment is complicated, so older versions of `conda` should be updated (`conda update -n base conda`) or you should use `mamba` instead.

2. IF `which nbscuid-run` returned the error `which: no nbscuid-run in ($PATH)`, then please run the following:

```
$ conda activate nbscuid-dev
$ pip install -e . # installs nbscuid
```

Note that `conda` now defaults to using `mamba` to solve environments;
the `mom6-environment.yml` environment is complicated,
so older versions of `conda` should be updated (`conda update -n base conda`) or you should use `mamba` instead.

## Running

CUPiD currently provides two examples for generating diagnostics.
Expand Down

0 comments on commit e95ed23

Please sign in to comment.