From 02cb7f29b3f64d788d530155205a84f66d38b4b2 Mon Sep 17 00:00:00 2001 From: Matt Graham Date: Fri, 9 Nov 2018 16:43:29 +0800 Subject: [PATCH] Moving notebooks to subdirectory. --- .gitattributes | 2 ++ README.md | 2 +- Demonstrations.ipynb => notebooks/Demonstrations.ipynb | 0 .../Farrell et al. (2002) example.ipynb | 0 4 files changed, 3 insertions(+), 1 deletion(-) create mode 100644 .gitattributes rename Demonstrations.ipynb => notebooks/Demonstrations.ipynb (100%) rename Farrell et al. (2002) example.ipynb => notebooks/Farrell et al. (2002) example.ipynb (100%) diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..850fcff --- /dev/null +++ b/.gitattributes @@ -0,0 +1,2 @@ +docs/* linguist-vendored +notebooks/* linguist-vendored diff --git a/README.md b/README.md index 76a20aa..6c11da5 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ pip install pompy Documentation of the PomPy API is available at [Read the Docs](https://pompy-docs.readthedocs.io/en/latest/). -Two Jupyter notebooks showing examples of using the package are included in the repository root directory. The [`Farrell et al. (2002) example.ipynb`](Farrell%20et%20al.%20%282002%29%20example.ipynb) notebook file illustrates an example of using PomPy to generate an animation of an odour plume using the simulation parameters described in Farrell et al. (2002) and includes keys to match the symbols used to define the parameter in the paper with the relevant PomPy class attributes. The [`Demonstration.ipynb`](Demonstrations.ipynb) and accompanying module `pompy.demos` give several other examples of setting up plume models using PomPy and visualising the simulations. +Two Jupyter notebooks showing examples of using the package are included in the `notebooks` directory. The [`Farrell et al. (2002) example.ipynb`](notebooks/Farrell%20et%20al.%20%282002%29%20example.ipynb) notebook illustrates an example of using PomPy to generate an animation of an odour plume using the simulation parameters described in Farrell et al. (2002) and includes keys to match the symbols used to define the parameter in the paper with the relevant PomPy class attributes. The [`Demonstration.ipynb`](notebooks/Demonstrations.ipynb) notebook and accompanying module `pompy.demos` give several other examples of setting up plume models using PomPy and visualising the simulations. The below script will generate a 20 second MP4 animation (see above for animated GIF version) of a generated plume with model parameters consistent with those proposed in Farrell et al. (2002). diff --git a/Demonstrations.ipynb b/notebooks/Demonstrations.ipynb similarity index 100% rename from Demonstrations.ipynb rename to notebooks/Demonstrations.ipynb diff --git a/Farrell et al. (2002) example.ipynb b/notebooks/Farrell et al. (2002) example.ipynb similarity index 100% rename from Farrell et al. (2002) example.ipynb rename to notebooks/Farrell et al. (2002) example.ipynb