wind-up

A tool to assess yield uplift of wind turbines.
https://github.com/resgroup/wind-up

Category: Renewable Energy
Sub Category: Wind Energy

Last synced: about 17 hours ago
JSON representation

Repository metadata

A tool to assess yield uplift of wind turbines

README.md

wind-up

A tool to assess yield uplift of wind turbines

image
image
image
Lint & Format: Ruff
Typing: mypy
lint-and-test

Getting Started

See examples folder for example analysis using the wind-up package. smarteole_example.ipynb is a good place to start.

The wind-up package can be installed using any Python environment manager. Examples using uv and pip are shown below:

Using uv

# Install the wind-up package in an existing project
uv add res-wind-up

# Or create a new project and install the wind-up package
uv init my-project
cd my-project
uv add res-wind-up

Using pip

# create and activate a virtual environment, if needed
python -m venv .venv
source .venv/Scripts/activate  # or .venv/bin/activate on linux or ".venv/Scripts/activate" in Windows command prompt
# install the wind-up package in the virtual environment
pip install res-wind-up # alternatively clone the repo, navigate to the wind-up folder and run "pip install ."

Note that the package is named wind_up (with an underscore) in Python code. For example to print the version of the installed package use the following code snippet:

import wind_up
print(wind_up.__version__)

Contributing

To start making changes fork the repository or make a new branch from main. Note main is protected;
if a commit fails to push and you want to undo it try git reset origin/main --hard

The development environment should be created and managed using uv. To create the environment:

uv sync --extra dev

To run the formatting, linting and testing:

uv run poe all # or all-fast to skip slow tests

Or simply

poe all # or all-fast to skip slow tests

if you have activated the virtual environment.

License

See LICENSE.txt

Contact

Alex.Clerc@res-group.com


Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 3 days ago

Total Commits: 236
Total Committers: 6
Avg Commits per committer: 39.333
Development Distribution Score (DDS): 0.106

Commits in past year: 20
Committers in past year: 3
Avg Commits per committer in past year: 6.667
Development Distribution Score (DDS) in past year: 0.45

Name Email Commits
Alex Clerc a****c@r****m 211
Samuel Northover-Naylor 5****r 18
Gabriele Calvo g****7@g****m 3
paulf81 p****g@n****v 2
dependabot[bot] 4****] 1
Gorkem Kacar 1****t 1

Committer domains:


Issue and Pull Request metadata

Last synced: 5 days ago

Total issues: 22
Total pull requests: 52
Average time to close issues: about 2 months
Average time to close pull requests: 6 days
Total issue authors: 3
Total pull request authors: 8
Average comments per issue: 0.18
Average comments per pull request: 0.35
Merged pull request: 32
Bot issues: 0
Bot pull requests: 1

Past year issues: 8
Past year pull requests: 19
Past year average time to close issues: 18 days
Past year average time to close pull requests: 6 days
Past year issue authors: 3
Past year pull request authors: 4
Past year average comments per issue: 0.13
Past year average comments per pull request: 0.16
Past year merged pull request: 11
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/resgroup/wind-up

Top Issue Authors

  • aclerc (13)
  • samuelwnaylor (8)
  • n-n-s (1)

Top Pull Request Authors

  • aclerc (22)
  • samuelwnaylor (19)
  • gabrielecalvo (3)
  • YousifKilano (2)
  • izofat (2)
  • paulf81 (2)
  • delta006 (1)
  • dependabot[bot] (1)

Top Issue Labels

  • enhancement (7)
  • good first issue (5)
  • bug (4)

Top Pull Request Labels

  • dependencies (1)

Package metadata

pypi.org: res-wind-up

A tool to assess yield uplift of wind turbines

  • Homepage: https://github.com/resgroup/wind-up
  • Documentation: https://res-wind-up.readthedocs.io/
  • Licenses: BSD 3-Clause License Copyright (c) 2024, RENEWABLE ENERGY SYSTEMS LIMITED, all rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  • Latest release: 0.4.7 (published 15 days ago)
  • Last Synced: 2026-03-23T02:03:22.663Z (3 days ago)
  • Versions: 19
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 1,161 Last month
  • Rankings:
    • Dependent packages count: 10.671%
    • Average: 35.383%
    • Dependent repos count: 60.094%
  • Maintainers (1)

Dependencies

.github/workflows/lint-and-test.yaml actions
  • actions/cache v4 composite
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
.github/workflows/pypi-publish.yaml actions
  • actions/checkout v4 composite
  • actions/download-artifact v4 composite
  • actions/setup-python v5 composite
  • actions/upload-artifact v4 composite
  • pypa/gh-action-pypi-publish release/v1 composite
pyproject.toml pypi
  • geographiclib *
  • matplotlib *
  • pandas >= 2.0.0
  • pyarrow *
  • pydantic >= 2.0.0
  • python-dotenv *
  • pyyaml *
  • requests *
  • ruptures *
  • scipy *
  • seaborn *
  • tabulate *
  • toml *
  • tqdm *
  • utm *

Score: 12.69980500834997