From cd65b162118b600fa643ac84424245f3df56c00e Mon Sep 17 00:00:00 2001 From: Teagan Date: Thu, 7 Dec 2023 13:16:43 -0700 Subject: [PATCH] update quickstart instructions --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6e6fa77..f792b3f 100644 --- a/README.md +++ b/README.md @@ -44,12 +44,13 @@ CUPiD currently provides two examples for generating diagnostics. To test the package out, try to run `examples/adf-mom6`: ``` -$ cd 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 ``` After the last step is finished, you can use Jupyter to view generated notebooks in `${CUPID_ROOT}/examples/adf-mom6/computed_notebooks/adf-quick-run` or you can copy the entire `${CUPID_ROOT}/examples/adf-mom6/computed_notebooks/adf-quick-run/_build/html` -directory to your local machine and look at `index.html` in a web browser. \ No newline at end of file +directory to your local machine and look at `index.html` in a web browser.