Skip to content

Commit 8f2b107

Browse files
committed
Updating to pip installation.
1 parent b15d00b commit 8f2b107

File tree

1 file changed

+4
-11
lines changed

1 file changed

+4
-11
lines changed

README.md

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
## PomPy - *p*uff-based *o*dour plume *m*odel in *Py*thon
22

3+
[![PyPI version](https://badge.fury.io/py/pompy.svg)](https://badge.fury.io/py/pompy)
34
[![Documentation Status](https://readthedocs.org/projects/pompy-docs/badge/?version=latest)](https://pompy-docs.readthedocs.io/en/latest/?badge=latest)
45

56
PomPy is a NumPy based implementation of the puff-based odour plume model described in
@@ -13,24 +14,16 @@ An example simulated concentration field generated by the package is shown below
1314

1415
![Plume model animation](plume.gif "Plume model animation example.")
1516

16-
### What is this repository for?
17-
1817
PomPy allows simulation of dynamic 2D odour concentration fields which show some of the key characteristics of real chemical plumes in turbulent flows including short term intermittency, diffusive effects and longer term variations in spatial extent and location, while being cheaper to run than a full fluid dynamics simulation.
1918

2019
### Installation and requirements
2120

22-
PomPy requires a Python 2.7 or newer environment. For usage of the `pompy.models` and `pompy.processors` modules [NumPy](http://www.numpy.org/) and [SciPy](https://scipy.org/scipylib/index.html) are required. For the demonstrations in the `pompy.demos` module [Matplotlib](https://matplotlib.org/) is also required. The [`requirements.txt`](requirements.txt) file lists versions of NumPy, SciPy and Matplotlib known to work with PomPy. A [Jupyter](https://matplotlib.org/) notebook server installation will also be required to run the example notebooks locally.
23-
24-
To install PomPy in the current Python environment run
25-
26-
```
27-
python setup.py install
28-
```
21+
PomPy requires a Python 2.7 or newer environment. For usage of the `pompy.models` and `pompy.processors` modules [NumPy](http://www.numpy.org/) and [SciPy](https://scipy.org/scipylib/index.html) are required. For the demonstrations in the `pompy.demos` module [Matplotlib](https://matplotlib.org/) is also required. The [`requirements.txt`](requirements.txt) file lists versions of NumPy, SciPy and Matplotlib known to work with PomPy. A [Jupyter](https://matplotlib.org/) notebook server installation will also be required to run the example notebooks locally.
2922

30-
and to install the Python requirements using pip run
23+
To install the package run
3124

3225
```
33-
pip install -r requirements.txt
26+
pip install pompy
3427
```
3528

3629
### Documentation

0 commit comments

Comments
 (0)