Accessibility navigation

Enhanced software and platform for the Town Energy Balance (TEB) model

Meyer, D. ORCID:, Schoetter, R., Masson, V. and Grimmond, S. ORCID: (2020) Enhanced software and platform for the Town Energy Balance (TEB) model. Journal of Open Source Software, 5 (50). 2008. ISSN 2475-9066

Text (Open Access) - Published Version
· Available under License Creative Commons Attribution.
· Please see our End User Agreement before downloading.


It is advisable to refer to the publisher's version if you intend to cite from this work. See Guidance on citing.

To link to this item DOI: 10.21105/joss.02008


The Town Energy Balance (TEB) model (Masson, 2000) is a physically based single layer Urban Canopy Model (UCM) to calculate the urban surface energy balance at neighborhood scale assuming a simplified canyon geometry. It includes several capabilities (Table 1) that have been extensively evaluated offline with flux observations (Lemonsu, Grimmond, & Masson, 2004; Leroyer, Mailhot, Bélair, Lemonsu, & Strachan, 2010; Masson, Grimmond, & Oke, 2002; Pigeon, Moscicki, Voogt, & Masson, 2008) and online coupled to atmospheric models such as ALARO (Gerard, Piriou, Brožková, Geleyn, & Banciu, 2009) in ALARO-TEB (Hamdi, Degrauwe, & Termonia, 2012), the Global Environmental Multiscale (GEM; Côté et al. (1998)) in GEM-TEB (Lemonsu, Belair, & Mailhot, 2009), Meso-NH (Lac et al., 2018; Lafore et al., 1998) in TEB-MesoNH (Lemonsu & Masson, 2002), the Regional Atmospheric Modeling System (RAMS; Pielke et al. (1992)) in RAMS-TEB (Freitas, Rozoff, Cotton, & Dias, 2007), the Advanced Regional Prediction System (ARPS; Xue et al., (2000)) in ARPS-TEB (Rozoff, Cotton, & Adegoke, 2003), and the Weather Research and Forecasting (WRF; Skamarock et al. (2019)) in WRF-TEB (Meyer et al., 2020). Here, we present an enhanced software and platform for the TEB model to help scientists and practitioners wishing to use the TEB model in their research as a standalone software application or as a library in their own software. This includes several features such as crossplatform support for Windows, Linux, and macOS using CMake (Kitware Inc., 2020), static and dynamic library generation for integration with other software/models, namelist-based configuration, integration with MinimalDX (Meyer & Raustad, 2019) and PsychroLib (Meyer & Thevenard, 2019) to improve the modelling of air conditioners (AC) and psychrometric calculations respectively, a thin interface used in the coupling with WRF-CMake (Riechert & Meyer, 2019), helper functions for Python for pre- and post-processing inputs and outputs files, and a tutorial in Jupyter Notebook to allow users to quickly become familiar with the general TEB modeling workflow. In the new platform we implement testing at every code commit through continuous integration (CI) and automate the generation of documentation. The project is developed as a free, open source, community-driven project on GitHub ( to support existing and new model applications with enhanced functionality. We welcome contributions and encourage users to provide feedback, bug reports and feature requests, via GitHub’s issue system at

Item Type:Article
Divisions:Faculty of Science > School of Mathematical, Physical and Computational Sciences > Department of Meteorology
ID Code:91302


Downloads per month over past year

University Staff: Request a correction | Centaur Editors: Update this record

Page navigation