Skip to content

Commit 7e41e8e

Browse files
committed
Separating out projection description and updating naming.
1 parent 46fb6fb commit 7e41e8e

23 files changed

+192
-86
lines changed
5.78 KB
Binary file not shown.
377 Bytes
Binary file not shown.

docs/_build/doctrees/index.doctree

-148 Bytes
Binary file not shown.
25 Bytes
Binary file not shown.
150 Bytes
Binary file not shown.
65 Bytes
Binary file not shown.
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
PomPy is a NumPy based implementation of the puff-based odour plume model described in
2+
3+
Farrell, J.A., Murlis, J., Long, X., Li, W. and Cardé, R.T., 2002.
4+
Filament-based atmospheric dispersion model to achieve short time-scale
5+
structure of odor plumes. *Environmental fluid mechanics*, 2(1-2), pp.143-169.
6+
`Index page (springer.com) <https://link.springer.com/article/10.1023/A:1016283702837>`_ \:\:
7+
`PDF (semanticscholar.org) <https://pdfs.semanticscholar.org/7197/d905b0d6e8cd490f78a893fc266af9a4d901.pdf>`_
8+
9+
What is PomPy for?
10+
--------------------
11+
12+
PomPy allows simulation of dynamic 2D odour concentration fields which show some
13+
of the key characteristics of real chemical plumes in turbulent flows including short
14+
term intermittency, diffusive effects and longer term variations in spatial extent and
15+
location, while being cheaper to run than a full fluid dynamics simulation.

docs/_build/html/_sources/index.rst.txt

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,7 @@
1-
`pompy` - puff-based odour plume model in Python
1+
PomPy - puff-based odour plume model in Python
22
================================================
33

4-
`pompy` is a NumPy based implementation of the puff-based odour plume model described in
5-
6-
Farrell, J.A., Murlis, J., Long, X., Li, W. and Cardé, R.T., 2002.
7-
Filament-based atmospheric dispersion model to achieve short time-scale
8-
structure of odor plumes. *Environmental fluid mechanics*, 2(1-2), pp.143-169.
9-
`springer.com <https://link.springer.com/article/10.1023%2FA%3A1016283702837#page-1/>`_
10-
11-
What is `pompy` for?
12-
--------------------
13-
14-
`pompy` allows simulation of dynamic 2D odour concentration fields which show some
15-
of the key characteristics of real chemical plumes in turbulent flows including short
16-
term intermittency, diffusive effects and longer term variations in spatial extent and
17-
location, while being cheaper to run than a full fluid dynamics simulation.
4+
.. include:: description.rst
185

196
An example simulated concentration field generated by the package is shown below
207

@@ -27,7 +14,7 @@ API documentation
2714
-----------------
2815

2916
.. toctree::
30-
:maxdepth: 3
17+
:maxdepth: 2
3118

3219
pompy.models.rst
3320
pompy.processors.rst

docs/_build/html/_sources/pompy.demos.rst.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
`demos` module
2-
==============
1+
`pompy.demos` module
2+
====================
33

44
.. automodule:: pompy.demos
55
:members:

docs/_build/html/_sources/pompy.models.rst.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
`models` module
2-
===============
1+
`pompy.models` module
2+
=====================
33

44
.. automodule:: pompy.models
55
:members:

0 commit comments

Comments
 (0)