From 4cdb53d38be034428ecc6b0d79275a252e458a8c Mon Sep 17 00:00:00 2001 From: Teagan Date: Thu, 7 Dec 2023 14:05:33 -0700 Subject: [PATCH] only pip -e install nbscuid if needed --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f792b3f..cbaf3e5 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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