WRF-TEB (Meyer et al., 2020a) couples the single layer Town Energy Balance (TEB) model (Masson, 2000, and subsequent papers) model, software (Meyer et al., 2020b), to the Weather Research and Forecasting (WRF; Skamarock et al., 2019). The WRF-TEB software is available for download from version 4.1.5 at https://github.com/teb-model/wrf-teb.
The WRF-TEB software depends on the TEB model software library (Meyer et al., 2020b). Depending on the 'flavour' of WRF (software) you want to use (i.e. WRF or WRF-CMake), you may need to manually build the TEB model software library before attempting to build WRF on your system.
No additional steps are required to build WRF-TEB using WRF-CMake (Riechert and Meyer, 2010) as the TEB model software library is automatically downloaded and installed on your system at build time. To install, download (and extract) WRF-TEB from the WRF-TEB release page, then follow the standard installation instructions to build WRF-CMake from source.
To build WRF-TEB using the official WRF model (i.e. with Makefiles), first follow the standard TEB installation instructions to build the TEB model software library on your system.
Then, download (and extract) WRF-TEB from the WRF-TEB release page, set WRF_TEB=1 and TEB_PATH=/path/to/teb/build as environment variables before running ./configure. From here, configure and build WRF as per standard WRF build instructions. Please ensure that both TEB and WRF are compiled using the same compiler vendor and version (e.g. GNU 7.4.0), and compiler options (e.g. Release, REAL8 ) to avoid issues at compile/run-time. If you are using the standard WRF configure options, use -DUSE_REAL8=OFF when building the TEB model software library (i.e. cmake -DUSE_REAL8=OFF ..) as WRF defaults to 4 byte wide real.
Standard/general WRF documentation applies. To run a case using WRF-TEB, first enable TEB from the namelist.input file (i.e. sf_urban_physics = 4), then rename the URBPARM_TEB.TBL file to URBPARM.TBL. Make sure to change options and paramter values to match your case study. More information about the options avalable in TEB/WRF-TEB are documented in TEB model software library repository.
When using WRF-TEB, please cite the paper and software (with version) as follow:
| Model | Software and Version* |
|---|---|
| Meyer et al., 2020a | see Zenodo |
The corresponding reference list should be as follows:
Meyer, D., Schoetter, R., Riechert, M., Verrelle, A., Tewari, M., Dudhia, J., Masson, V., Reeuwijk, M., & Grimmond, S. (2020). WRF‐TEB: implementation and evaluation of the coupled Weather Research and Forecasting (WRF) and Town Energy Balance (TEB) model. Journal of Advances in Modeling Earth Systems. https://doi.org/10.1029/2019ms001961
*please make sure to cite the same version you are using with the correct DOI. For a list of all available versions see the list of versions on Zenodo.
Additional files provided in WRF-TEB are licensed under the MIT licence and indicated in the header of each source file with:
WRF-TEB (https://github.com/teb-model/wrf-teb).
Copyright <year> D. Meyer. Licensed under the MIT License.
Masson, V. (2000). A Physically-Based Scheme For The Urban Energy Budget In Atmospheric Models. Boundary-Layer Meteorology, 94(3), 357–397. https://doi.org/10.1023/a:1002463829265
Meyer, D., Schoetter, R., Riechert, M., Verrelle, A., Tewari, M., Dudhia, J., Masson, V., Reeuwijk, M., & Grimmond, S. (2020a). WRF‐TEB: implementation and evaluation of the coupled Weather Research and Forecasting (WRF) and Town Energy Balance (TEB) model. Journal of Advances in Modeling Earth Systems. https://doi.org/10.1029/2019ms001961
Meyer, D., Schoetter, R., Masson, V., & Grimmond, S. (2020b). Enhanced software and platform for the Town Energy Balance (TEB) model. Journal of Open Source Software, 5(50), 2008. https://doi.org/10.21105/joss.02008
Riechert, M., & Meyer, D. (2019). WRF-CMake: integrating CMake support into the Advanced Research WRF (ARW) modelling system. Journal of Open Source Software, 4(41), 1468. https://doi.org/10.21105/joss.01468
Skamarock, W. C., Klemp, J. B., Dudhia, J., Gill, D. O., Liu, Z., Berner, J., … Huang, X.-Y. (2019). A Description of the Advanced Research WRF Model Version 4. https://doi.org/10.5065/1DFH-6P97