Skip to content

Commit

Permalink
correct narrative on examples
Browse files Browse the repository at this point in the history
  • Loading branch information
slayoo authored Feb 8, 2024
1 parent accea4a commit 29fb3b8
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,9 +86,9 @@ Running the tests shipped with the package requires additional packages listed i

## Examples (Jupyter notebooks reproducing results from literature):

PyMPDATA examples are hosted in a separate repository and constitute
the [``PyMPDATA_examples``](https://github.com/open-atmos/PyMPDATA-examples) package.
The examples have additional dependencies listed in [``PyMPDATA_examples`` package ``setup.py``](https://github.com/open-atmos/PyMPDATA-examples/blob/main/setup.py) file.
PyMPDATA examples are bundled with PyMPDATA and located in the `examples` subfolder.
They constitute a separate [``PyMPDATA_examples``](https://pypi.org/p/PyMPDATA-examples) Python package which is also available at PyPI.
The examples have additional dependencies listed in [``PyMPDATA_examples`` package ``setup.py``](https://github.com/open-atmos/PyMPDATA/blob/main/examples/setup.py) file.
Running the examples requires the ``PyMPDATA_examples`` package to be installed.
Since the examples package includes Jupyter notebooks (and their execution requires write access), the suggested install and launch steps are:
```
Expand Down

0 comments on commit 29fb3b8

Please sign in to comment.