Package: brightwind
__         _       __    __           _           __
    / /_  _____(_)___  / /_  / /__      __(_)___  ___ / /
   / __ \/ ___/ / __ \/ __ \/ __/ | /| / / / __ \/ __  /
  / /_/ / /  / / /_/ / / / / /_ | |/ |/ / / / / / /_/ /
 /_.___/_/  /_/\__, /_/ /_/\__/ |__/|__/_/_/ /_/\__,_/
              /____/A Python library primarily for wind resource assessments.Brightwind is a Python library specifically built for wind analysis. It can load in wind speed, wind direction and
other metrological timeseries data. There are various plots you can use to understand this data and to find any
potential issues. You can perform many common functions to the data such as shear and long-term adjustments. The
resulting adjusted data is then outputted as a frequency distribution tab file which can be used in wind analysis
software such as WAsP.This library can also be used for solar resource analysis.InstallationYou can use pip from the command line to install the library.C:\Users\Stephen> pip install brightwindIt is advisable to use a separate environment to avoid any dependency clashes with other libraries such as Pandas, Numpy
or Matplotlib you may already have installed.For those that do not have Python installed and are just getting started, we recommend installing Anaconda. Anaconda is
a Python distribution for scientific computing and so provides everything you need, Python, pip and Jupyter Notebook
along with libraries such as Pandas, Numpy and Matplotlib. Datacamp provide a good tutorial forinstalling
Anaconda on Windowsto get started.Once Anaconda is installed, you can use theAnaconda Promptto run the above command linepip install brightwind.
Or first useAnaconda Navigatorto create an environment.DocumentationDocumentation on how to get setup and use the library can be found athttps://brightwind-dev.github.io/brightwind-docs/Example usage of the brightwind library is shown below using Jupyter Notebook. Jupyter Notebook is a powerful way to
immediately see the results of code you have written.FeaturesThe library provides wind analysts with easy to use tools for working with
meteorological data. It supports loading of meteorological data, averaging,
filtering, plotting, correlations, shear analysis, long term adjustments, etc.
The library can then export a resulting long term adjusted tab file to be used in
other wind analysis software.BenefitsThe key benefits to an open-source library is that it provides complete transparency
and traceability. Anyone in the industry can review any part of the code and suggest changes,
thus creating a standardised, validated toolkit for the industry.By default, during an assessment every manipulation or adjustment made to the wind data is
contained in a single file. This can easily be reviewed and checked by internal reviewers or,
as the underlying code is open-sourced, there is no reason why this file cannot be sent to
3rd parties for review thus increasing the effectiveness of a banks due diligence.LicenseThe library is licensed under the MIT license.Test datasetsA test dataset is included in this repository and is used to demonstrate function and test functions in the code.
Other files and datasets are also included to complement this demo dataset. These are outlined below:DatasetSourceNotesdemo_data.csvBrightWindA modified 2 year met mast dataset in csv and Campbell Scientific format.MERRA-2_XX_2000-01-01_2017-06-30.csvNASAGES DISC4 x MERRA-2 18-yr datasets to complement the demo data for long term analyses.demo_cleaning_file.csvBrightWindA file containing information on what periods to clean out from the demo data.windographer_flagging_log.txtBrightWindThe same cleaning info as found in 'demo_cleaning_file.csv' formatted as a Windographer flagging file.demo_data_iea43_wra_data_model.jsonBrightWindA JSON file formatted according to the IEA Wind Task 43WRA Data Modelstandard which describes the mast configuration for the demo data.ContributingIf you wish to be involved or find out more please contactstephen@brightwindanalysis.com.More information can be found in thecontributing.mdsection of the website.