Skip to main content

[![Documentation Status](https://readthedocs.org/projects/windrose/badge/?version=latest)](http://windrose.readthedocs.io/en/latest/?badge=latest) [![Latest Version](https://img.shields.io/pypi/v/windrose.svg)](https://pypi.python.org/pypi/windrose/) [![Supported Python versions](https://img.shields.io/pypi/pyversions/windrose.svg)](https://pypi.python.org/pypi/windrose/) [![Wheel format](https://img.shields.io/pypi/wheel/windrose.svg)](https://pypi.python.org/pypi/windrose/) [![License](https://img.shields.io/pypi/l/windrose.svg)](https://pypi.python.org/pypi/windrose/) [![Development Status](https://img.shields.io/pypi/status/windrose.svg)](https://pypi.python.org/pypi/windrose/) [![Downloads monthly](https://img.shields.io/pypi/dm/windrose.svg)](https://pypi.python.org/pypi/windrose/) [![Requirements Status](https://requires.io/github/python-windrose/windrose/requirements.svg?branch=master)](https://requires.io/github/python-windrose/windrose/requirements/?branch=master) [![Code Health](https://landscape.io/github/python-windrose/windrose/master/landscape.svg?style=flat)](https://landscape.io/github/python-windrose/windrose/master) [![Codacy Badge](https://www.codacy.com/project/badge/fff3df3be0754829925202cdd6495ce7)](https://www.codacy.com/app/s-celles/windrose_2) [![Build Status](https://travis-ci.org/python-windrose/windrose.svg)](https://travis-ci.org/python-windrose/windrose) [![DOI](https://zenodo.org/badge/37549137.svg)](https://zenodo.org/badge/latestdoi/37549137) [![Research software impact](http://depsy.org/api/package/pypi/windrose/badge.svg)](http://depsy.org/package/python/windrose)

# Windrose

A [wind rose](https://en.wikipedia.org/wiki/Wind_rose) is a graphic tool used by meteorologists to give a succinct view of how wind speed and direction are typically distributed at a particular location. It can also be used to describe air quality pollution sources. The wind rose tool uses Matplotlib as a backend. Data can be passed to the package using Numpy arrays or a Pandas DataFrame.

Windrose is a Python library to manage wind data, draw windroses (also known as polar rose plots), and fit Weibull probability density functions.

The initial use case of this library was for a technical report concerning pollution exposure and wind distributions analyzes. Data from local pollution measures and meteorologic informations from various sources like Meteo-France were used to generate a pollution source wind rose.

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

Some others contributors have used it to make figures for a [wind power plant control optimization study](https://www.nrel.gov/docs/fy17osti/68185.pdf).

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

## Install

### Requirements

Option libraries:

### Install latest release version via pip

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

`bash $ pip install windrose `

### Install latest development version

`bash $ pip install git+https://github.com/python-windrose/windrose `

or

`bash $ git clone https://github.com/python-windrose/windrose $ python setup.py install `

## Examples

The bar plot wind rose is the most common plot

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

Contour plots are also possible

-![Windrose (contourf-contour) example](docs/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)

Probability density functions may be plotted. Fitting Weibull distribution is enabled by Scipy. The Weibull distribution is used in weather forecasting and the wind power industry to describe wind speed distributions, as the natural distribution of wind speeds often matches the Weibull shape

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

## Documentation [![Documentation Status](https://readthedocs.org/projects/windrose/badge/?version=latest)](http://windrose.readthedocs.io/en/latest/?badge=latest) 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 https://github.com/python-windrose/windrose/blob/master/CONTRIBUTORS.md

Metadata

Release files for windrose 1.6.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for windrose 1.6.4
File Size Uploaded
windrose-1.6.4.tar.gz 14.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for windrose 1.6.4
File Interpreter ABI Platform
windrose-1.6.4-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 25.3 kB

Release files / windrose-1.6.4.tar.gz

Download URL windrose-1.6.4.tar.gz
Size 14.1 kB
Tags Source
SHA-256 checksum
How to use checksums
540b3dcb8a0cb62e549e1e82019e591c30f04e9794b21a5a456f1c9adff433cb
BLAKE2b-256 checksum
How to use checksums
70084e0a1ad755a7e12d18c7a4d6b23ce20a8935e5188ed7ff6bb881a5f90bd4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via Python-urllib/3.6

Release files / windrose-1.6.4-py2.py3-none-any.whl

Download URL windrose-1.6.4-py2.py3-none-any.whl
Size 11.3 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
a4a4d0030f5839cbf0897287c45bc486ca257e8ace344b9c0e4c6c89ee0abe18
BLAKE2b-256 checksum
How to use checksums
6a904c54b26c09121ed994ac9c8b9eba76f8496ecb574ebc469e70b3afe13ae3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via Python-urllib/3.6

Release history Release notifications | RSS feed

1.10.0

2 release files

1.9.2

2 release files

1.9.1

2 release files

1.9.0

2 release files

1.8.1

2 release files

1.8.0

2 release files

1.7.0

2 release files

1.6.8

2 release files

1.6.7

2 release files

1.6.5

2 release files

This release

1.6.4 This release

2 release files

1.6.3

2 release files

1.6.2

2 release files

1.6.1

2 release files

1.6

2 release files

1.5

2 release files

1.4

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page