Science Score: 59.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 9 DOI reference(s) in README -
✓Academic publication links
Links to: wiley.com -
✓Committers with academic emails
10 of 53 committers (18.9%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (12.4%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
AMReX-based structured wind solver
Basic Info
- Host: GitHub
- Owner: Exawind
- License: other
- Language: C++
- Default Branch: main
- Homepage: https://exawind.github.io/amr-wind
- Size: 231 MB
Statistics
- Stars: 141
- Watchers: 16
- Forks: 99
- Open Issues: 18
- Releases: 45
Topics
Metadata Files
README.md
AMR-Wind
Documentation | Nightly test dashboard
AMR-Wind is a massively parallel, block-structured adaptive-mesh, incompressible flow solver for wind turbine and wind farm simulations. The codebase is a wind-focused fork of incflo. The solver is built on top of the AMReX library. AMReX library provides the mesh data structures, mesh adaptivity, as well as the linear solvers used for solving the governing equations. AMR-Wind is actively developed and maintained by a dedicated multi-institutional team from Lawrence Berkeley National Laboratory, National Renewable Energy Laboratory, and Sandia National Laboratories.
The primary applications for AMR-Wind are: performing large-eddy simulations (LES) of atmospheric boundary layer (ABL) flows, simulating wind farm turbine-wake interactions using actuator disk or actuator line models for turbines, and as a background solver when coupled with a near-body solver (e.g., Nalu-Wind) with overset methodology to perform blade-resolved simulations of multiple wind turbines within a wind farm. For offshore applications, the ability to model the air-sea interaction effects and its impact on the ABL characteristics is another focus for the code development effort. As with other codes in the Exawind ecosystem, AMR-wind shares the following objectives:
an open, well-documented implementation of the state-of-the-art computational models for modeling wind farm flow physics at various fidelities that are backed by a comprehensive verification and validation (V&V) process;
be capable of performing the highest-fidelity simulations of flow fields within wind farms; and
be able to leverage the high-performance leadership class computing facilities available at DOE national laboratories.
Part of the WETO Stack
AMR-Wind is primarily developed with the support of the U.S. Department of Energy and is part of the WETO Software Stack. For more information and other integrated modeling software, see: - Portfolio Overview - Entry Guide - High-Fidelity Modeling Workshop
References
To cite AMR-Wind and to learn more about the methodology, use the following journal article as well as the ExaWind reference:
``` @article{amrwind2025, author = {Kuhn, Michael B. and {Henry de Frahan}, Marc T. and Mohan, Prakash and Deskos, Georgios and Churchfield, Matthew and Cheung, Lawrence and Sharma, Ashesh and Almgren, Ann and Ananthan, Shreyas and Brazell, Michael J. and {Martinez-Tossas} Luis A. and Thedin, Regis and Rood, Jon and Sakievich, Philip and Vijayakumar, Ganesh and Zhang, Weiqun and Sprague, Michael A.}, title = {AMR-Wind: A performance-portable, high-fidelity flow solver for wind farm simulations}, journal = {Wind Energy}, volume = {28}, number = {5}, pages = {-}, doi = {10.1002/we.70010}, url = {https://onlinelibrary.wiley.com/doi/full/10.1002/we.70010}, eprint = {}, year = {2025} }
@article{exawind2024, author = {Sharma, Ashesh and Brazell, Michael J. and Vijayakumar, Ganesh and Ananthan, Shreyas and Cheung, Lawrence and deVelder, Nathaniel and {Henry de Frahan}, Marc T. and Matula, Neil and Mullowney, Paul and Rood, Jon and Sakievich, Philip and Almgren, Ann and Crozier, Paul S. and Sprague, Michael}, title = {ExaWind: Open-source CFD for hybrid-RANS/LES geometry-resolved wind turbine simulations in atmospheric flows}, journal = {Wind Energy}, volume = {27}, number = {3}, pages = {225-257}, doi = {10.1002/we.2886}, url = {https://onlinelibrary.wiley.com/doi/abs/10.1002/we.2886}, eprint = {https://onlinelibrary.wiley.com/doi/pdf/10.1002/we.2886}, year = {2024} } ```
Documentation
Documentation is available at https://exawind.github.io/amr-wind, which includes a walkthrough tutorial, a user manual, notes on theory, and tips for developers. We also provide a developer-focused API documentation at the same link. You can either browse the docs online by following the links, or you can generate them locally after downloading the code. Please follow the instructions in user manual to build documentation locally.
Compilation and usage
AMR-Wind is built upon the AMReX library.
A snapshot of the AMReX library is distributed along with the AMR-Wind source
code as a git-submodule. In addition to the AMReX library, you will require a
modern C++ compiler that supports the C++17 standard. Users wishing to execute
the code on high-performance computing (HPC) systems will also need MPI
libraries installed on their system. The code can also be compiled using MPI+X,
where X can be OpenMP for CPU shared memory parallelism,
CUDA to target NVIDIA GPUs, ROCM for AMD GPUs, or SyCL for Intel GPUs.
Contributing, reporting bugs, and requesting help
To report issues or bugs please create a new issue on GitHub.
We welcome contributions from the community in form of bug fixes, feature enhancements, documentation updates, etc. All contributions are processed through pull-requests on GitHub. Please refer to the coding guidelines as a reference for the best practices currently used to develop AMR-Wind.
To pass the code format checking, use this command with a new version of clang-format:
find amr-wind unit_tests \( -name "*.cpp" -o -name "*.H" -o -name "*.h" \) -exec clang-format -i {} +
Please acknowledge as a publication co-author any developer that has significantly contributed to implementing or improving specific capability that was used for that publication.
User discussion, feedback, and community support
The development team manages a mailing list for AMR-Wind users. Invites for quarterly user meetings, along with occasional announcements, are sent to this list. Quarterly meetings provide development updates and a forum for discussion and feedback. If you would like to join this mailing list, please send a request to amr-wind-maintainers@groups.nrel.gov, and we will be happy to add your email address. Our maintainers email is also available for direct inquiries about AMR-Wind, but the GitHub page (issues, discussions, pull requests) is preferred for the majority of questions.
Versioning and tags
AMR-Wind uses a type of semantic versioning to help users navigate different versions of the code, which are labeled with GitHub tags. These tagged versions are not exhaustive, and they adhere to the following convention. Given a version number MAJOR.MINOR.PATCH: 1. MAJOR version for changes to input file compatibility for key aspects of the solver, when a key model is changed to significantly affect results of simulations, when a major new capability is added 2. MINOR version for when a significant feature is added (in a backward compatible manner), accumulation of smaller features, or changes to input file compatibility for less central aspects of the solver (e.g., post-processing, forcing terms) 3. PATCH version for backward compatible bug fixes
License
AMR-Wind is licensed under BSD 3-clause license. Please see the LICENSE included in the source code repository for more details.
Owner
- Name: exawind
- Login: Exawind
- Kind: organization
- Repositories: 15
- Profile: https://github.com/Exawind
Organization for the ExaWind code suite, which provides a multi-fidelity modeling capability for wind turbines and wind farms.
GitHub Events
Total
- Create event: 56
- Commit comment event: 1
- Release event: 10
- Issues event: 183
- Watch event: 33
- Delete event: 46
- Issue comment event: 953
- Push event: 441
- Pull request review comment event: 385
- Pull request review event: 518
- Pull request event: 544
- Fork event: 13
Last Year
- Create event: 56
- Commit comment event: 1
- Release event: 10
- Issues event: 183
- Watch event: 33
- Delete event: 46
- Issue comment event: 953
- Push event: 441
- Pull request review comment event: 385
- Pull request review event: 518
- Pull request event: 544
- Fork event: 13
Committers
Last synced: 6 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| knutsvk | k****8@c****k | 510 |
| Shreyas Ananthan | s****s@u****u | 294 |
| Jon Rood | j****d@n****v | 266 |
| Ann Almgren | a****n@l****v | 234 |
| Marc T. Henry de Frahan | m****n@n****v | 224 |
| Michael B Kuhn | 3****n | 214 |
| Michael J. Brazell | m****l@g****m | 190 |
| Weiqun Zhang | w****g@l****v | 156 |
| Georgios (Yorgos) Deskos | g****v@g****m | 32 |
| prakash | 1****l | 29 |
| Michele Rosso | m****o@l****v | 27 |
| Tony Martinez | t****e@g****m | 25 |
| Ganesh Vijayakumar | g****m@g****m | 22 |
| psakievich | p****v@s****v | 17 |
| Harish | h****n@g****m | 12 |
| ashesh2512 | 3****2 | 11 |
| lawrenceccheung | 1****g | 11 |
| Mukul Dave | m****e@l****v | 9 |
| Diederik Beckers | b****k@g****m | 7 |
| Matteo Polimeno | 4****o | 7 |
| Roberto Porcu | r****u@l****v | 6 |
| Nate deVelder | n****d@s****v | 6 |
| dependabot[bot] | 4****] | 6 |
| Eliot Quon | e****n@n****v | 6 |
| Matt Churchfield | m****d@n****v | 5 |
| Max Katz | m****z@g****m | 5 |
| sbidadi9 | 9****9 | 5 |
| Ilker Topcuoglu | 1****u | 4 |
| PaulMullowney | 6****y | 3 |
| Alex Rybchuk | a****k@g****m | 2 |
| and 23 more... | ||
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 279
- Total pull requests: 1,915
- Average time to close issues: 3 months
- Average time to close pull requests: 13 days
- Total issue authors: 72
- Total pull request authors: 52
- Average comments per issue: 4.05
- Average comments per pull request: 1.21
- Merged pull requests: 1,449
- Bot issues: 1
- Bot pull requests: 194
Past Year
- Issues: 113
- Pull requests: 657
- Average time to close issues: 10 days
- Average time to close pull requests: 6 days
- Issue authors: 32
- Pull request authors: 19
- Average comments per issue: 3.29
- Average comments per pull request: 1.26
- Merged pull requests: 453
- Bot issues: 0
- Bot pull requests: 87
Top Authors
Issue Authors
- marchdf (31)
- lawrenceccheung (22)
- tonyinme (14)
- QB-Lin (13)
- rthedin (12)
- sayerhs (11)
- AsimUdel (10)
- ews-ffarella (9)
- rybchuk (9)
- michaeljbrazell (8)
- mbkuhn (7)
- AlexGuntner (7)
- hgopalan (7)
- May0048 (6)
- rd-contr (5)
Pull Request Authors
- marchdf (386)
- mbkuhn (358)
- jrood-nrel (265)
- dependabot[bot] (194)
- michaeljbrazell (151)
- sayerhs (142)
- moprak-nrel (58)
- hgopalan (44)
- gdeskos (43)
- tonyinme (36)
- gantech (24)
- mukul1992 (22)
- psakievich (19)
- lawrenceccheung (17)
- asalmgren (17)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 2
- Total downloads: unknown
-
Total dependent packages: 1
(may contain duplicates) -
Total dependent repositories: 0
(may contain duplicates) - Total versions: 45
- Total maintainers: 2
proxy.golang.org: github.com/exawind/amr-wind
- Documentation: https://pkg.go.dev/github.com/exawind/amr-wind#section-documentation
- License: other
-
Latest release: v3.6.0+incompatible
published 8 months ago
Rankings
spack.io: amr-wind
AMR-Wind is a massively parallel, block-structured adaptive-mesh, incompressible flow sover for wind turbine and wind farm simulations.
- Homepage: https://github.com/Exawind/amr-wind
- License: []
-
Latest release: main
published almost 4 years ago
Rankings
Maintainers (2)
Dependencies
- DoozyX/clang-format-lint-action v0.14 composite
- actions/checkout v3 composite
- advanced-security/filter-sarif v1 composite
- github/codeql-action/analyze v2 composite
- github/codeql-action/init v2 composite
- github/codeql-action/upload-sarif v2 composite
- styfle/cancel-workflow-action 0.6.0 composite
- JamesIves/github-pages-deploy-action releases/v3 composite
- actions/checkout v3 composite
- actions/setup-python v2 composite
- styfle/cancel-workflow-action 0.6.0 composite
- actions/checkout v3 composite
- actions/checkout v3 composite
- actions/upload-artifact v3 composite
- actions/stale v8 composite