brightwind

A Python library aims to empower wind resource analysts and establish a common industry standard toolset.
https://github.com/brightwind-dev/brightwind

Category: Renewable Energy
Sub Category: Wind Energy

Last synced: about 16 hours ago
JSON representation

Repository metadata

Python library containing wind analysis functions

README.md


     __         _       __    __           _           __
    / /_  _____(_)___  / /_  / /__      __(_)___  ___ / /
   / __ \/ ___/ / __ \/ __ \/ __/ | /| / / / __ \/ __  /
  / /_/ / /  / / /_/ / / / / /_ | |/ |/ / / / / / /_/ /
 /_.___/_/  /_/\__, /_/ /_/\__/ |__/|__/_/_/ /_/\__,_/
              /____/

            A Python library primarily for wind resource assessments.


Brightwind is an open-source Python library for wind (and solar) resource analysis. It loads meteorological
timeseries data, runs common analyses — shear, long-term adjustments, correlations, distributions — and exports
results to formats used by wind analysis software such as WAsP.

📚 Full documentation, tutorials and API reference: https://brightwind-dev.github.io/brightwind-docs/


Installation

Install brightwind into its own environment to avoid dependency clashes. Pick whichever option suits you.

Option 1 — venv (quick way to try brightwind out)

Check Python is installed (3.9+ recommended):

python --version

If not, install it from python.org/downloads — on Windows, tick "Add
Python to PATH"
in the installer.

Then create an environment and install brightwind:

python -m venv brightwind_env
# Windows
brightwind_env\Scripts\activate
# macOS / Linux
source brightwind_env/bin/activate

pip install brightwind

Option 2 — conda

Common if you already use Anaconda or work primarily in Jupyter.
Anaconda bundles Python, pip and Jupyter in one
installer. From the Anaconda Prompt:

conda create --name brightwind_env python=3.11
conda activate brightwind_env
pip install brightwind

A step-by-step Windows install walkthrough is also available in the
tutorials.

Optional — parquet support

Reading .parquet files from BrightHub needs a parquet engine. Install the default (pyarrow):

pip install brightwind[parquet]

Or use fastparquet instead: pip install brightwind[parquet-fastparquet].


Quick start

Most analysts use brightwind from a Jupyter Notebook:

pip install jupyter
jupyter notebook
import brightwind as bw

data = bw.load_csv(bw.demo_datasets.demo_data)
bw.basic_stats(data)

For full examples — loading, plotting, shear, correlations, exporting — see the
tutorials and API reference.

demo_image_1
demo_image_2


Why open-source?

The brightwind library is open-source, making every step of an assessment transparent, auditable and reproducible. The full record of
adjustments to a dataset lives in a single file that internal reviewers, third parties and banks can inspect
directly — sharpening due diligence and removing the "black box" problem of proprietary tools.

The intent is a shared, validated toolkit that the wind and solar industry builds on together, rather than each
consultancy reinventing the same calculations behind closed doors.


Test datasets

Demo datasets are bundled with the library to demonstrate functions and exercise the test suite:

Dataset Source Notes
demo_data.csv BrightWind A modified 2-year met mast dataset in CSV and Campbell Scientific format.
MERRA-2_XX_2000-01-01_2017-06-30.csv NASA GES DISC 4 × MERRA-2 18-year datasets to complement the demo data for long-term analyses.
demo_cleaning_file.csv BrightWind Periods to clean out from the demo data.
windographer_flagging_log.txt BrightWind Same cleaning info as demo_cleaning_file.csv formatted as a Windographer flagging file.
demo_data_iea43_wra_data_model.json BrightWind A JSON file formatted to the IEA Wind Task 43 WRA Data Model standard, describing the mast configuration for the demo data.

Contributing

Brightwind welcomes contributions from across the wind and solar industry — analysts, engineers, researchers and
developers.


License

MIT — see LICENSE.txt.


Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 6 days ago

Total Commits: 1,417
Total Committers: 17
Avg Commits per committer: 83.353
Development Distribution Score (DDS): 0.627

Commits in past year: 57
Committers in past year: 8
Avg Commits per committer in past year: 7.125
Development Distribution Score (DDS) in past year: 0.719

Name Email Commits
stephenholleran s****n@b****m 528
BiancaMorandi b****i@g****m 352
Inder s****5@g****m 303
Luke Cunningham l****n@t****e 112
rach185 r****l@b****m 36
olivia-bentley o****y@b****m 27
AndyBrightWind 4****d 16
r-molins-mrp 9****p 11
Sara 1****r 11
ShaneBrightWind 3****d 9
dancasey-ie i****o@d****e 4
shwetajoshi601 s****1@g****m 3
Ilirmc I****c 1
Rowan Molony r****y@m****m 1
abohara t****2@g****m 1
amralaa95 a****3@g****m 1
rm-mol 9****l 1

Committer domains:


Issue and Pull Request metadata

Last synced: 6 days ago

Total issues: 336
Total pull requests: 290
Average time to close issues: 7 months
Average time to close pull requests: 27 days
Total issue authors: 23
Total pull request authors: 16
Average comments per issue: 1.96
Average comments per pull request: 0.75
Merged pull request: 235
Bot issues: 0
Bot pull requests: 0

Past year issues: 55
Past year pull requests: 40
Past year average time to close issues: about 2 months
Past year average time to close pull requests: 12 days
Past year issue authors: 6
Past year pull request authors: 8
Past year average comments per issue: 0.78
Past year average comments per pull request: 0.85
Past year merged pull request: 22
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/brightwind-dev/brightwind

Top Issue Authors

  • stephenholleran (125)
  • BiancaMorandi (98)
  • ShaneBrightWind (22)
  • sararafter (15)
  • dancasey-ie (14)
  • rach185 (11)
  • AndyBrightWind (11)
  • inder-preet-kakkar (8)
  • lucunnin (7)
  • olivia-bentley (6)
  • Ilirmc (5)
  • geekwg (2)
  • py-jv (2)
  • MichaelK01 (1)
  • ChristopherStapleton (1)

Top Pull Request Authors

  • stephenholleran (88)
  • BiancaMorandi (56)
  • olivia-bentley (39)
  • inder-preet-kakkar (27)
  • lucunnin (18)
  • rach185 (12)
  • sararafter (11)
  • AndyBrightWind (11)
  • r-molins-mrp (10)
  • dancasey-ie (4)
  • ShaneBrightWind (4)
  • Ilirmc (3)
  • amralaa95 (3)
  • rm-mol (2)
  • abohara (1)

Top Issue Labels

  • bug (97)
  • enhancement (87)
  • function improvement (72)
  • documentation (23)
  • breaking change (13)
  • v3.0.0 (11)
  • v2.4.0 (10)
  • tutorial (7)
  • good first issue (4)
  • question (4)

Top Pull Request Labels

  • bug (53)
  • enhancement (30)
  • function improvement (18)
  • v2.4.0 (7)
  • good first issue (2)
  • breaking change (1)

Package metadata

pypi.org: brightwind

Scripts for wind resource data processing.

  • Homepage: https://github.com/brightwind-dev/brightwind.git
  • Documentation: https://brightwind.readthedocs.io/
  • Licenses: MIT
  • Latest release: 2.7.0 (published 10 days ago)
  • Last Synced: 2026-05-18T13:25:15.480Z (6 days ago)
  • Versions: 16
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 666 Last month
  • Rankings:
    • Dependent packages count: 7.306%
    • Forks count: 9.37%
    • Stargazers count: 10.454%
    • Average: 15.295%
    • Dependent repos count: 22.077%
    • Downloads: 27.265%
  • Maintainers (1)

Dependencies

requirements.txt pypi
  • boto3 >=1.9.66
  • gmaps >=0.9.0
  • ipython >=7.4.0
  • ipywidgets >=7.4.2
  • matplotlib >=3.0.3
  • numpy >=1.16.4
  • pandas >=0.24.0,<=0.25.3
  • pytest >=4.1.0
  • python-dateutil >=2.8.0
  • requests >=2.20.0
  • scikit-learn >=0.19.1
  • scipy >=0.19.1
  • six >=1.12.0
setup.py pypi
  • boto3 >=1.9.66
  • gmaps >=0.9.0
  • ipython >=7.4.0
  • ipywidgets >=7.4.2
  • matplotlib >=3.0.3
  • numpy >=1.16.4
  • pandas >=0.24.0,
  • pytest >=
  • python-dateutil >=2.8.0
  • requests >=2.20.0
  • scikit-learn >=0.19.1
  • scipy >=0.19.1
  • six >=
.github/workflows/tests.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite

Score: 14.502287491516377