The coupled WRF-TEB (Meyer et al., 2020a) couples the single layer Town Energy Balance (TEB; Masson, 2000) software (Meyer et al., 2020b) to the Weather Research and Forecasting (WRF; Skamarock et al., 2019) software with CMake support (Riechert & Meyer, 2021).
WRF-TEB is built with WRF-CMake and TEB. Software releases are available from the WRF-TEB release page. For standard installation on Linux use:
cd wrf-teb
mkdir build && cd build
cmake -GNinja -DCMAKE_BUILD_TYPE=Release \
-DMODE=dmpar \
-DCMAKE_INSTALL_PREFIX=install ..
# https://ninja-build.org/
ninja install # -j <nproc>
Notes: the TEB software version is defined using the GIT_TAG
variable in external/teb/CMakeLists.txt
. To specify the location to TEB use the TEB_DIR
flag (e.g. -DTEB_DIR=path/to/teb/dir
). For a list of required software dependencies see doc/cmake/INSTALL.md#install-dependencies. For advanced build and install information see doc/cmake/INSTALL.md#build-and-install-wrf-cmake.
Standard WRF documentation applies. To run a case using WRF-TEB, enable TEB from the namelist.input
with sf_urban_physics = 4
and rename URBPARM_TEB.TBL
to URBPARM.TBL
. Make sure to change options and parameter values to match those for case study. See the namelist option page in TEB for more information.
Please cite WRF-TEB and WRF-CMake with the following DOIs:
- WRF-TEB: https://doi.org/10.1029/2019MS001961
- WRF-CMake: https://doi.org/10.21105/joss.01468
Additional, version-specific DOIs are available on Zendo at https://doi.org/10.5281/zenodo.3898327 and https://doi.org/10.5281/zenodo.3403342 for WRF-TEB and WRF-CMake, respectively.
General WRF copyright and license applies for any files part of the original WRF distribution -- see the README file for more details.
WRF-CMake source files are licensed under the MIT license and marked as:
WRF-CMake (https://github.com/WRF-CMake/wrf).
Copyright <year> M. Riechert and D. Meyer. Licensed under the MIT License.
WRF-TEB source files are licensed under the MIT license and marked as:
WRF-TEB (https://github.com/teb-model/wrf-teb).
Copyright <year> D. Meyer. Licensed under the MIT License.