nalu-wind
Solver for wind farm simulations targeting exascale computational platforms
Science Score: 36.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
-
○Academic publication links
-
✓Committers with academic emails
8 of 72 committers (11.1%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (13.1%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
Solver for wind farm simulations targeting exascale computational platforms
Basic Info
- Host: GitHub
- Owner: Exawind
- License: other
- Language: C
- Default Branch: master
- Homepage: https://exawind.github.io/nalu-wind/
- Size: 48.2 MB
Statistics
- Stars: 140
- Watchers: 24
- Forks: 92
- Open Issues: 28
- Releases: 8
Topics
Metadata Files
README.md
Nalu-Wind
Documentation | Nightly test dashboard
Nalu-Wind is a generalized, unstructured, massively parallel, incompressible flow solver for wind turbine and wind farm simulations. The codebase is a wind-focused fork of NaluCFD; NaluCFD is developed and maintained by Sandia National Laboratories. Nalu-Wind is being actively developed and maintained by a dedicated, multi-institutional team from National Renewable Energy Laboratory, Sandia National Laboratories, and Univ. of Texas Austin.
Nalu-Wind is developed as an open-source code with 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 flowfields within wind farms; and
be able to leverage the high-performance leadership class computating facilities available at DOE national laboratories.
We hope that this community developed model will be used by research laboratories, academia, and industry to develop the next-generation of wind farm technologies. We welcome the wind energy community to use Nalu-Wind in their research. When disseminating technical work that includes Nalu-Wind simulations please reference the following citation:
Sprague, M. A., Ananthan, S., Vijayakumar, G., Robinson, M., "ExaWind: A multifidelity
modeling and simulation environment for wind energy", NAWEA/WindTech 2019 Conference,
Amherst, MA, 2019.
Part of the WETO Stack
Nalu-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
Documentation
Documentation is available online at https://exawind.github.io/nalu-wind/ and is split into the following sections:
Theory manual: This section provides a detailed overview of the supported equation sets, the discretization and time-integration schemes, turbulence models available, etc.
Verification manual: This section documents the results from verification studies of the spatial and temporal schemes available in Nalu-Wind.
User manual: The user manual contains detailed instructions on building the code, along with the required third-party libraries (TPLs) and usage.
All documentation is maintained alongside the source code within the git repository and automatically deployed to a github-hosted website upon new commits.
Compilation and usage
Nalu-Wind is primarily built upon the packages provided by the Trilinos project, which in turn depends on several third-party libraries (MPI, HDF5, NetCDF, parallel NetCDF), and YAML-CPP. In addition, it has the following optional dependencies: hypre, TIOGA, and OpenFAST. Detailed build instructions are available in the user manual. We recommend using Spack package manager to install Nalu-Wind on your system.
Testing and quality assurance
Nalu-Wind comes with a comprehensive unit test and regression test suite that
exercise almost all major components of the code. The master branch is
compiled and run through a regression test suite with different compilers
(GCC, LLVM/Clang, and
Intel) on Linux and MacOS
operating systems, against both the master and develop branches of
Trilinos. Tests are performed both using
flat MPI and hybrid MPI-GPU hardware configurations. The results of the nightly
testing are publicly available on CDash
dashboard.
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 follow our contributing guidelines when submitting pull-requests.
To pass the formatting check, use this with a new version of clang-format:
find nalu.C unit_tests.C ./include ./src ./unit_tests \( -name "*.cpp" -o -name "*.H" -o -name "*.h" -o -name "*.C" \) -exec clang-format -i {} +
License
Nalu-Wind is licensed under BSD 3-clause license. Please see the LICENSE included in the source code repository for more details.
Acknowledgements
Nalu-Wind is currently being developed with funding from Department of Energy's (DOE) Office of Science Exascale Computing Project (ECP) and Energy Efficiency and Renewable Energy (EERE) Wind Energy Technology Office (WETO). Please see authors file for a list of contributors to Nalu-Wind.
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: 11
- Release event: 4
- Issues event: 27
- Watch event: 15
- Delete event: 7
- Issue comment event: 117
- Push event: 80
- Pull request review comment event: 12
- Pull request review event: 55
- Pull request event: 80
- Fork event: 11
Last Year
- Create event: 11
- Release event: 4
- Issues event: 27
- Watch event: 15
- Delete event: 7
- Issue comment event: 117
- Push event: 80
- Pull request review comment event: 12
- Pull request review event: 55
- Pull request event: 80
- Fork event: 11
Committers
Last synced: 6 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Shreyas Ananthan | s****s@u****u | 429 |
| Jon Rood | j****d@n****v | 395 |
| Stefan P. Domino | s****n@s****v | 393 |
| Alan Williams | w****m@s****v | 193 |
| Robert C. Knaus | r****s@s****v | 158 |
| psakievich | p****v@s****v | 136 |
| James Overfelt | j****f@s****v | 133 |
| Marc T. Henry de Frahan | m****n@n****v | 94 |
| Ganesh Vijayakumar | g****r@n****v | 71 |
| Nalu It | n****t@N****l | 54 |
| Shreyas Ananthan | s****n@n****v | 39 |
| PaulMullowney | 6****y | 37 |
| ashesh2512 | 3****2 | 25 |
| mbarone81 | m****e@s****v | 15 |
| lawrenceccheung | c****l@g****m | 13 |
| Timothy Smith | 5****4 | 12 |
| Tony Martinez | t****e@g****m | 11 |
| Luc Berger-Vergiat | l****e@s****v | 9 |
| Jeremy Melvin | j****n@g****m | 9 |
| Johnathan Vo | j****o@s****v | 8 |
| Michael B Kuhn | 3****n | 8 |
| Wyatt Horne | 6****e | 8 |
| Philip Sakievich | p****v@s****v | 7 |
| ddement | d****t@g****u | 7 |
| Tim Neumann | n****m@f****e | 6 |
| Matt Churchfield | m****d@n****v | 6 |
| Thomas J. Otahal | t****a@s****v | 5 |
| Jonathan Hu | j****u@s****v | 5 |
| Dong Hun Lee | 5****4 | 5 |
| djglaze | 4****e | 5 |
| and 42 more... | ||
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 334
- Total pull requests: 1,144
- Average time to close issues: 5 months
- Average time to close pull requests: 14 days
- Total issue authors: 50
- Total pull request authors: 49
- Average comments per issue: 5.05
- Average comments per pull request: 1.33
- Merged pull requests: 1,003
- Bot issues: 0
- Bot pull requests: 2
Past Year
- Issues: 19
- Pull requests: 134
- Average time to close issues: 10 days
- Average time to close pull requests: 4 days
- Issue authors: 10
- Pull request authors: 13
- Average comments per issue: 4.05
- Average comments per pull request: 0.7
- Merged pull requests: 111
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- sayerhs (79)
- jrood-nrel (34)
- tchatte3 (28)
- psakievich (24)
- tasmith4 (20)
- marchdf (18)
- jhux2 (15)
- lucbv (13)
- PaulMullowney (9)
- Z0907Q (8)
- neumantm (7)
- DeeDiveT (6)
- ndevelder (5)
- lawrenceccheung (5)
- ashesh2512 (5)
Pull Request Authors
- sayerhs (178)
- jrood-nrel (163)
- psakievich (155)
- overfelt (101)
- marchdf (88)
- alanw0 (87)
- rcknaus (85)
- PaulMullowney (47)
- ashesh2512 (26)
- mbkuhn (23)
- wjhorne (19)
- tasmith4 (17)
- gantech (17)
- lawrenceccheung (14)
- lucbv (9)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 2
- Total downloads: unknown
-
Total dependent packages: 0
(may contain duplicates) -
Total dependent repositories: 0
(may contain duplicates) - Total versions: 22
proxy.golang.org: github.com/exawind/nalu-wind
- Documentation: https://pkg.go.dev/github.com/exawind/nalu-wind#section-documentation
- License: other
-
Latest release: v2.4.0+incompatible
published 7 months ago
Rankings
proxy.golang.org: github.com/Exawind/nalu-wind
- Documentation: https://pkg.go.dev/github.com/Exawind/nalu-wind#section-documentation
- License: other
-
Latest release: v2.4.0+incompatible
published 7 months ago
Rankings
Dependencies
- DoozyX/clang-format-lint-action v0.13 composite
- actions/checkout v3 composite
- styfle/cancel-workflow-action 0.6.0 composite
- Pygments ==2.7.4
- Sphinx ==2.1.2
- breathe ==4.13.1
- docutils ==0.14
- pyparsing ==2.4.2
- sphinxcontrib-bibtex ==0.4.2