Skip to content

Commit

Permalink
update quickstart instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
TeaganKing committed Dec 7, 2023
1 parent 11b7675 commit cd65b16
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
directory to your local machine and look at `index.html` in a web browser.

0 comments on commit cd65b16

Please sign in to comment.