Skip to content

Commit

Permalink
Moving notebooks to subdirectory.
Browse files Browse the repository at this point in the history
  • Loading branch information
matt-graham committed Nov 9, 2018
1 parent 8c2c7d9 commit 02cb7f2
Show file tree
Hide file tree
Showing 4 changed files with 3 additions and 1 deletion.
2 changes: 2 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
docs/* linguist-vendored
notebooks/* linguist-vendored
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
File renamed without changes.
File renamed without changes.

0 comments on commit 02cb7f2

Please sign in to comment.