A curated list of open technology projects to sustain a stable climate, energy supply, biodiversity and natural resources.

WOMBAT

Windfarm Operations & Maintenance cost-Benefit Analysis Tool.
https://github.com/wisdem/wombat

Category: Renewable Energy
Sub Category: Wind Energy

Keywords

operations-maintenance python3 simpy simulation wind-energy

Keywords from Contributors

wind energy-system-model

Last synced: about 1 hour ago
JSON representation

Repository metadata

Windfarm Operations & Maintenance cost-Benefit Analysis Tool

README.md

WOMBAT: Windfarm Operations & Maintenance cost-Benefit Analysis Tool

DOI 10.2172/1894867
PyPI version
codecov
Apache 2.0
Binder
Jupyter Book

Pre-commit
Black
isort

This library provides a tool to simulate the operation and maintenance phase (O&M) of
distributed, land-based, and offshore windfarms using a discrete event simultaion
framework.

WOMBAT is written around the SimPy discrete
event simulation framework. Additionally, this is supported using a flexible and modular
object-oriented code base, which enables the modeling of arbitrarily large (or small)
windfarms with as many or as few failure and maintenance tasks that can be encoded.

Please note that this is still heavily under development, so you may find some functionality
to be incomplete at the current moment, but rest assured the functionality is expanding.
With that said, it would be greatly appreciated for issues or PRs to be submitted for
any improvements at all, from fixing typos (guaranteed to be a few) to features to
testing.

If you use this library please cite our NREL Technical Report:

   @techreport{hammond2022wombat,
      title = {Windfarm Operations and Maintenance cost-Benefit Analysis Tool (WOMBAT)},
      author = {Hammond, Rob and Cooperman, Aubryn},
      abstractNote = {This report provides technical documentation and background on the newly-developed Wind Operations and Maintenance cost-Benefit Analysis Tool (WOMBAT) software. WOMBAT is an open-source model that can be used to obtain cost estimates for operations and maintenance of land-based or offshore wind power plants. The software was designed to be flexible and modular to allow for implementation of new strategies and technological innovations for wind plant maintenance. WOMBAT uses a process-based simulation approach to model day-to-day operations, repairs, and weather conditions. High-level outputs from WOMBAT, including time-based availability and annual operating costs, are found to agree with published results from other models.},
      doi = {10.2172/1894867},
      url = {https://www.osti.gov/biblio/1894867},
      place = {United States},
      year = {2022},
      month = {10},
      institution = {National Renewable Energy Lab. (NREL)},
   }

WOMBAT in Action

There a few Jupyter notebooks to get users up and running with WOMBAT in the examples/
folder, but here are a few highlights:

Note
In v0.6 the results will diverge significantly under certain modeling conditions from
past versions due to substantial model upgrades on the backend and new/updated
features to better specify how repairs are managed.

  • Dinwoodie, et al. replication for wombat can be found in the
    examples folder <https://github.com/WISDEM/WOMBAT/blob/main/examples/dinwoodie_validation.ipynb>_.
  • IEA Task 26
    validation exercise <https://github.com/WISDEM/WOMBAT/blob/main/examples/iea_26_validation.ipynb>_.
  • Presentations: slides <https://github.com/WISDEM/WOMBAT/blob/main/presentation_material/>_.

Setup

Requirements

  • Python 3.9 through 3.12

Environment Setup

Download the latest version of Miniconda
for the appropriate OS. Follow the remaining
steps
for the appropriate OS version.

Using conda, create a new virtual environment:

conda create -n <environment_name> python=3.11
conda activate <environment_name>
conda install -c anaconda pip

# activate the environment
conda activate <environment_name>

# to deactivate
conda deactivate

Installation

Once in your desired environment, WOMBAT can be installed from PyPI via pip install
or from source.

Pip

This option is best for those working with the latest release, or including WOMBAT as
a tool in a workflow without the desire to modify the source code.

pip install wombat

From Source

This option is ideal for users that wish to work with the examples, modify the source
code, and/or contribute back to the project.

Install it directly into an activated virtual environment:

git clone https://github.com/WISDEM/WOMBAT.git
cd wombat
python setup.py install

# Alternatively:
pip install .

Usage

After installation, the package can imported:

python
import wombat
wombat.__version__

For further usage, please see the documentation site at https://wisdem.github.io/WOMBAT.

Requirements for Contributing to WOMBAT

Code Contributions

Code contributors should note that there is both an additional dependency suite for
running the tests and enabling the pre-commit workflow to automatically standardize the
core code formatting principles. In short, the following steps should be taken, but be
sure to read the
contributor's guide

git clone https://github.com/WISDEM/WOMBAT.git
cd wombat

# Install the additional dependencies for running the tests and automatic code formatting
pip install -e '.[dev]'

# Enable the pre-commit workflow for automatic code formatting
pre-commit install

# ... contributions and commits ...

# Run the tests and ensure they all pass
pytest tests

Basic pre-commit issues that users might encounter and their remedies:

  • For any failed run, changes may have been either automatically applied or require
    further edits from the contributor. In either case, after changes have been made,
    contributors will have to rerun git add <the changed files> and
    git commit -m <the commit message> to restart the pre-commit workflow with the
    applied changes. Once all checks pass, the commit is safe to be pushed.
  • isort, black, or simple file checks failed, but made changes
    • rerun the add and commit processes as needed until the changes satisfy the checks
  • ruff failed:
    • Address the errors and rerun the add and commit processes
  • mypy has type errors that seem incorrect
    • Double check the typing is in fact as correct as it seems it should be and rerun the
      add and commit processes
    • If mypy simply seems confused with seemingly correct types, the following statement
      can be added above the mypy error:
      assert isinstance(<variable of concern>, <the type you think mypy should be registering>)
    • If that's still not working, but you are definitely sure the types are correct,
      simply add a # type ignore comment at the end of the line. Sometimes mypy struggles
      with complex scenarios, or especially with certain attrs conventions.

Documentation Contributions

git clone https://github.com/WISDEM/WOMBAT.git
cd wombat
pip install -e '.[docs]'

Build the site

Note
You may want to change the "execute_notebooks" parameter in the docs/_config.yaml
file to "off" unless you're updating the coded examples, or they will be run every
time you build the site.

jupyter-book build docs

View the results: docs/_build/html/index.html

Code and Documentation Contributions

git clone https://github.com/WISDEM/WOMBAT.git
cd wombat
pip install -e '.[all]'

Dependencies

Standard dependencies:

  • attrs>=21
  • numpy>=1.21
  • scipy>=1.8
  • pandas>=2
  • polars>=0.17
  • pyarrow>=10
  • jupyterlab>=3
  • simpy>=4.0.1
  • pyyaml>=6
  • geopy>=2.3
  • networkx>=2.7
  • matplotlib>=3.3
  • types-attrs>=19
  • types-typed-ast>=1.5
  • types-PyYAML>=6
  • types-python-dateutil>=2.8

Optional "dev" dependencies:

  • pre-commit>=2.20
  • isort>=5.10
  • pytest>=7
  • pytest-cov>=4
  • mypy==0.991
  • ruff>=0.2
  • pyupgrade

Optional "docs" dependencies:

  • jupyter-book>=0.15
  • myst-nb>=0.16
  • myst-parser>=0.17
  • linkify-it-py>=2
  • sphinx-autodoc-typehints
  • sphinxcontrib-autoyaml
  • sphinxcontrib-bibtex>=2.4
  • sphinxcontrib-spelling>=7

Citation (citation.bib)

@techreport{hammond2022wombat,
    title = {Windfarm Operations and Maintenance cost-Benefit Analysis Tool (WOMBAT)},
    author = {Hammond, Rob and Cooperman, Aubryn},
    abstractNote = {This report provides technical documentation and background on the newly-developed Wind Operations and Maintenance cost-Benefit Analysis Tool (WOMBAT) software. WOMBAT is an open-source model that can be used to obtain cost estimates for operations and maintenance of land-based or offshore wind power plants. The software was designed to be flexible and modular to allow for implementation of new strategies and technological innovations for wind plant maintenance. WOMBAT uses a process-based simulation approach to model day-to-day operations, repairs, and weather conditions. High-level outputs from WOMBAT, including time-based availability and annual operating costs, are found to agree with published results from other models.},
    doi = {10.2172/1894867},
    url = {https://www.osti.gov/biblio/1894867},
    place = {United States},
    year = {2022},
    month = {10},
    institution = {National Renewable Energy Lab. (NREL)},
}

Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 5 days ago

Total Commits: 253
Total Committers: 7
Avg Commits per committer: 36.143
Development Distribution Score (DDS): 0.209

Commits in past year: 34
Committers in past year: 2
Avg Commits per committer in past year: 17.0
Development Distribution Score (DDS) in past year: 0.029

Name Email Commits
Rob Hammond 1****2 200
Hammond, Robert R****d@n****v 38
Rob r****d@n****v 8
pre-commit-ci[bot] 6****] 3
Garrett Barter g****r@n****v 2
David Österberg d****t@g****m 1
Daniel Mulas Hernando 1****s 1

Committer domains:


Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 31
Total pull requests: 160
Average time to close issues: 6 months
Average time to close pull requests: 5 days
Total issue authors: 6
Total pull request authors: 6
Average comments per issue: 1.19
Average comments per pull request: 0.34
Merged pull request: 157
Bot issues: 0
Bot pull requests: 4

Past year issues: 4
Past year pull requests: 43
Past year average time to close issues: 4 months
Past year average time to close pull requests: about 16 hours
Past year issue authors: 2
Past year pull request authors: 3
Past year average comments per issue: 4.5
Past year average comments per pull request: 0.12
Past year merged pull request: 43
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/wisdem/wombat

Top Issue Authors

  • RHammond2 (21)
  • hrnorton (3)
  • amcooperman (2)
  • Filip-OWF (2)
  • akey7 (2)
  • johnwang0576 (1)

Top Pull Request Authors

  • RHammond2 (152)
  • pre-commit-ci[bot] (4)
  • davidosterberg (1)
  • dmulas (1)
  • mdinkla (1)
  • akey7 (1)

Top Issue Labels

  • feature request (16)
  • bug (9)
  • enhancement (4)
  • complete-awaiting-release (4)
  • in progress (1)

Top Pull Request Labels

  • bug (55)
  • enhancement (50)
  • documentation (28)

Package metadata

pypi.org: wombat

Windfarm operations and maintenance cost-benefit analysis tool

  • Homepage:
  • Documentation: https://wombat.readthedocs.io/
  • Licenses: Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
  • Latest release: 0.10.3 (published 3 days ago)
  • Last Synced: 2025-04-27T13:04:41.590Z (about 1 hour ago)
  • Versions: 28
  • Dependent Packages: 1
  • Dependent Repositories: 1
  • Downloads: 1,252 Last month
  • Docker Downloads: 1,716
  • Rankings:
    • Dependent packages count: 7.373%
    • Average: 15.709%
    • Downloads: 15.931%
    • Stargazers count: 16.05%
    • Forks count: 16.958%
    • Dependent repos count: 22.233%
  • Maintainers (1)

Dependencies

.github/workflows/ci-tests.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • codecov/codecov-action v1 composite
.github/workflows/gh_pages.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • peaceiris/actions-gh-pages v3.6.1 composite
.github/workflows/python-publish-test.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • pypa/gh-action-pypi-publish release/v1 composite
.github/workflows/python-publish.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • pypa/gh-action-pypi-publish release/v1 composite
pyproject.toml pypi

Score: 13.553818467537187