Rosely 0.0.1

Documentation

Coming soon.

Installation

Rosely’s dependencies are Python 3.4+, NumPy, pandas, and Plotly.

You may install the dependencies using the conda virtual environment (recommended), the environment file can be downloaded here and installed and activated by

conda env create -f environment.yml
conda activate rosely

Once activated install with PIP:

pip install rosely

Quick start

Given arbitrary time series data that contains wind speed and direction (degrees) Rosely can quickly produce wind statistics and interactive windrose diagrams once the data is loaded into a pandas.DataFrame.

This example uses the provided example CSV containing meterological data.

>>> import pandas as pd
>>> from rosely import WindRose
>>> df = pd.read_csv('path/to/example_data.csv')
>>> # make a WindRose object from the dataframe with "ws" and "wd" columns
>>> WR = WindRose(df)
>>> WR.plot(
>>>     template='seaborn', colors='Plotly3',
>>>     title='Twitchell Island, California'
>>> )

The resulting windrose diagram saved as a png (download this file for an interactive example):

Details and examples of plot customization, output options, and windrose calculation options can be found in the online documentation.