Skip to content

Commit

Permalink
adding mention of PyMPDATA-examples to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
slayoo authored Jun 20, 2021
1 parent f7a84d1 commit a6fb129
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,20 @@ To install PyMPDATA, one may use: ``pip install --pre git+https://github.com/atm

Running the tests shipped with the package requires additional packages listed in the
[test-time-requirements.txt](https://github.com/atmos-cloud-sim-uj/PyMPDATA/blob/master/test-time-requirements.txt) file.

## Examples/Demos:

PyMPDATA examples listed below are hosted in a separate repository and constitute
the [``PyMPDATA_examples``](https://github.com/atmos-cloud-sim-uj/PyMPDATA-examples) package.
The examples have additional dependencies listed in [``PyMPDATA_examples`` package ``setup.py``](https://github.com/atmos-cloud-sim-uj/PyMPDATA-examples/blob/main/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:
```
git clone https://github.com/atmos-cloud-sim-uj/PyMPDATA-examples.git
cd PyMPDATA-examples
pip install -e .
jupyter-notebook
```

## Examples:

https://mybinder.org/v2/gh/atmos-cloud-sim-uj/PySDM-examples.git/main?urlpath=lab/tree/PySDM_examples/Arabas_and_Shima_2017/fig_5.ipynb

Expand Down

0 comments on commit a6fb129

Please sign in to comment.