Skip to content

Commit

Permalink
only pip -e install nbscuid if needed
Browse files Browse the repository at this point in the history
  • Loading branch information
TeaganKing committed Dec 7, 2023
1 parent cd65b16 commit 4cdb53d
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,17 @@ Then build the necessary conda environments with

```
$ conda env create -f nbscuid/dev-environment.yml
$ 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:

```
$ 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.
Expand All @@ -45,7 +53,6 @@ To test the package out, try to run `examples/adf-mom6`:

```
$ conda activate nbscuid-dev
$ pip install -e . # installs nbscuid
$ cd examples/adf-mom6
$ nbscuid-run config.yml
$ nbscuid-build config.yml # Will build HTML from Jupyter Book
Expand Down

0 comments on commit 4cdb53d

Please sign in to comment.