ERF is built upon the AMReX software framework for massively parallel block-structured applications.
| Regression Tests |  |
See Getting Started for instructions as to how to clone the ERF and AMReX codes, and for how to build and run an ERF example. Minimum requirements for system software are also given there.
Documentation of the ERF theory and implementation is available here .
In addition, there is doxygen documentation of the ERF Code available here
See CONTRIBUTING.md for how to contribute to ERF development.
The development of the Energy Research and Forecasting (ERF) code is funded by the Wind Energy Technologies Office (WETO), part of the U.S. Department of Energy (DOE)'s Office of Energy Efficiency & Renewable Energy (EERE).
The developers of ERF acknowledge and thank the developers of the AMReX-based PeleC , FHDeX and AMR-Wind codes. In the spirit of open source code development, the ERF project has ported sections of code from each of these projects rather than writing them from scratch. ERF is built on the AMReX library.
ERF Copyright (c) 2022, The Regents of the University of California, through Lawrence Berkeley National Laboratory, National Renewable Energy Laboratory, Lawrence Livermore National Laboratory and Argonne National Laboratory (subject to receipt of any required approvals from the U.S. Dept. of Energy). All rights reserved.
If you have questions about your rights to use or distribute this software, please contact Berkeley Lab's Innovation & Partnerships Office at [email protected].
NOTICE. This Software was developed under funding from the U.S. Department of Energy and the U.S. Government consequently retains certain rights. As such, the U.S. Government has been granted for itself and others acting on its behalf a paid-up, nonexclusive, irrevocable, worldwide license in the Software to reproduce, distribute copies to the public, prepare derivative works, and perform publicly and display publicly, and to permit other to do so.
The license for ERF can be found in the LICENSE.md file.
To cite ERF, please use 
@article{ERF_JOSS,
title = {ERF: Energy Research and Forecasting},
journal = {Journal of Open Source Software}
author = {Ann Almgren and Aaron Lattanzi and Riyaz Haque and Pankaj Jha and Branko Kosovic and Jeffrey Mirocha and Bruce Perry and Eliot Quon and Michael Sanders and David Wiersema and Donald Willcox and Xingqiu Yuan and Weiqun Zhang},
doi = {10.21105/joss.05202},
url = {https://doi.org/10.21105/joss.05202},
year = {2023},
publisher = {The Open Journal of Open Source Software},
volume = {8},
number = {87},
pages = {5202},
}