Skip to content

Commit

Permalink
Improve paper (#96)
Browse files Browse the repository at this point in the history
  • Loading branch information
scls19fr committed Aug 20, 2018
1 parent b23303f commit 35544d6
Show file tree
Hide file tree
Showing 7 changed files with 49 additions and 20 deletions.
File renamed without changes.
69 changes: 49 additions & 20 deletions paper.md → paper/paper.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,24 +35,38 @@ A wind rose can also be used to describe visually air quality.
Windrose is a Python library to manage wind data, draw windrose
(also known as a polar rose plot), draw probability density function and fit Weibull distribution

Writing technical reports on pollution exposure
and wind distributions analyzes, by mixing local pollution measures and meteorologic informations from various sources like Meteo-France was initial use case for developing this library.

It is also used by some contributors for teaching purpose (especially data analysis)
![Map overlay](screenshots/overlay.png)

Some others contributors are using it to make figures for wind plant optimization study.

Some academics use it to track lightning strikes during high intensity storms.
They are using it to visualize the motion of the storm based on the relative position of the lightning from one strike to the next.

It's using Matplotlib as a backend.

Data can be passed using Numpy array or using Pandas DataFrame.

# Install

## Requirements

- matplotlib http://matplotlib.org/
- numpy http://www.numpy.org/
- and naturally python https://www.python.org/ :-P

Option libraries:

- Pandas http://pandas.pydata.org/ (to feed plot functions easily)
- Scipy http://www.scipy.org/ (to fit data with Weibull distribution)
- ffmpeg https://www.ffmpeg.org/ (to output video)
- click http://click.pocoo.org/ (for command line interface tools)

## Install latest release version via pip

A package is available and can be downloaded from PyPi and installed using:

```bash
Expand All @@ -76,48 +90,63 @@ $ python setup.py install

Bar plot is the most common plot

-![Windrose (bar) example](docs/screenshots/bar.png)
-![Windrose (bar) example](screenshots/bar.png)

Plotting contour plot is also possible

-![Windrose (contourf-contour) example](docs/screenshots/contourf-contour.png)
-![Windrose (contourf-contour) example](screenshots/contourf-contour.png)

Several windroses can be plotted using subplots to provide a plot per year with for example subplots per month

-![Windrose subplots](docs/screenshots/subplots.png)
-![Windrose subplots](screenshots/subplots.png)

Probability density function (pdf) can be plotted. and fitting Weibull distribution can be achieved thanks to Scipy.
Probability density function (pdf) can be plotted. Fitting Weibull distribution can be achieved thanks to Scipy.
The Weibull distribution is used in weather forecasting and the wind power industry to describe wind speed distributions, as the natural distribution often matches the Weibull shape

-![pdf example](docs/screenshots/pdf.png)
-![pdf example](screenshots/pdf.png)

# More advanced usages

Full documentation of library is available at http://windrose.readthedocs.io/

# Community guidelines

You can help to develop this library.

## Code of Conduct

If you are using Python Windrose and want to interact with developers, others users...
we encourage you to follow our [code of conduct](https://github.com/python-windrose/windrose/blob/master/CODE_OF_CONDUCT.md).

## Contributing

If you discover issues, have ideas for improvements or new features, please report them.
[CONTRIBUTING.md](https://github.com/python-windrose/windrose/blob/master/CONTRIBUTING.md) explains
how to contribute to this project.

## List of contributors and/or notable users
* Lionel Roubeyrie - LIMAIR - https://github.com/LionelR
* Sébastien Celles - Université de Poitiers - IUT de Poitiers - https://github.com/scls19fr
* Julian Quick - National Renewable Energy Laboratory, Golden, CO - https://github.com/kilojoules
* Ivan Ogasawara - https://github.com/xmnlab
* Samuël Weber - Institut des Géosciences de l'Environnement, Grenoble, France, https://github.com/weber-s
* Bruno Ruas De Pinho - https://github.com/brunorpinho
* Fabien Maussion - Research Centre for Climate at the University of Innsbruck - https://github.com/fmaussion
* Filipe Fernandes - Research Software Engineer contractor for SECOORA/IOOS - https://github.com/ocefpaf
* daniclaar - Baum lab Applied ecology for impacted oceans - University of Victoria, BC, Canada - https://github.com/daniclaar
* James McCann - Ramboll - https://github.com/mccannjb
* Brian Blaylock - University of Utah Department of Atmospheric Sciences - https://github.com/blaylockbk
* Daniel Garver - United States Environmental Protection Agency - https://www.epa.gov/
* Ryan Brown - United States Environmental Protection Agency - https://www.epa.gov/

- Lionel Roubeyrie - LIMAIR - https://github.com/LionelR
- Sébastien Celles - Université de Poitiers - IUT de Poitiers - https://github.com/scls19fr
- Julian Quick - National Renewable Energy Laboratory, Golden, CO - https://github.com/kilojoules
- Ivan Ogasawara - https://github.com/xmnlab
- Samuël Weber - Institut des Géosciences de l'Environnement, Grenoble, France, https://github.com/weber-s
- Bruno Ruas De Pinho - https://github.com/brunorpinho
- Fabien Maussion - Research Centre for Climate at the University of Innsbruck - https://github.com/fmaussion
- Filipe Fernandes - Research Software Engineer contractor for SECOORA/IOOS - https://github.com/ocefpaf
- daniclaar - Baum lab Applied ecology for impacted oceans - University of Victoria, BC, Canada - https://github.com/daniclaar
- James McCann - Ramboll - https://github.com/mccannjb
- Brian Blaylock - University of Utah Department of Atmospheric Sciences - https://github.com/blaylockbk
- Daniel Garver - United States Environmental Protection Agency - https://www.epa.gov/
- Ryan Brown - United States Environmental Protection Agency - https://www.epa.gov/

# Future

Windrose is still an evolving library which still need care from its users and developers.
* Map overlay is a feature that could help some users.
* A better API for video exporting could be an interesting improvement.

- Map overlay is a feature that could help some users.
- A better API for video exporting could be an interesting improvement.
- Add the capability to make wind roses based on the Weibull shape and scale factors could be considered.
- Make windroses from an histogram table rather than from two arrays of wind speed and wind direction is also a requested feature.

# References
Binary file added paper/screenshots/bar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added paper/screenshots/contourf-contour.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added paper/screenshots/overlay.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added paper/screenshots/pdf.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added paper/screenshots/subplots.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 35544d6

Please sign in to comment.