From 29fb3b836f5dc730e49bc4dc2075ddc52a26c667 Mon Sep 17 00:00:00 2001 From: Sylwester Arabas Date: Thu, 8 Feb 2024 11:49:04 +0100 Subject: [PATCH] correct narrative on examples --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 61d02374..d2382aac 100644 --- a/README.md +++ b/README.md @@ -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: ```