Skip to content

Commit

Permalink
Merge pull request #111 from TeaganKing/ipykernel_fix
Browse files Browse the repository at this point in the history
Update README.md to include fix for ipykernel issue
  • Loading branch information
mnlevy1981 authored Jul 3, 2024
2 parents df6c683 + f504b67 commit 7be9606
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,14 @@ $ cupid-build # Will build HTML from Jupyter Book
After the last step is finished, you can use Jupyter to view generated notebooks in `${CUPID_ROOT}/examples/coupled-model/computed_notebooks/quick-run`
or you can view `${CUPID_ROOT}/examples/coupled-model/computed_notebooks/quick-run/_build/html/index.html` in a web browser.

Notes:

1. Occasionally users report the following error the first time they run CUPiD: `Environment cupid-analysis specified for <YOUR-NOTEBOOK>.ipynb could not be found`. The fix for this is the following:
``` bash
$ conda activate cupid-analysis
(cupid-analysis) $ python -m ipykernel install --user --name=cupid-analysis
```

Furthermore, to clear the `computed_notebooks` folder which was generated by the `cupid-run` and `cupid-build` commands, you can run the following command:

``` bash
Expand Down

0 comments on commit 7be9606

Please sign in to comment.