Release 4.0.1 (#30)

Bump version and fix notation for tutorials and readme.

.travis.yml

@@ -1,4 +1,4 @@
-# TEB version 4.0.0 (https://github.com/teb-model/teb).
+# TEB version 4.0.1 (https://github.com/teb-model/teb).
 # Copyright 2018 D. Meyer. Licensed under CeCILL version 2.1.
 
 git:

CMakeLists.txt

@@ -1,4 +1,4 @@
-# TEB version 4.0.0 (https://github.com/teb-model/teb).
+# TEB version 4.0.1 (https://github.com/teb-model/teb).
 # Copyright 2018 D. Meyer. Licensed under CeCILL version 2.1.
 
 cmake_minimum_required(VERSION 3.1)

README.md

@@ -69,7 +69,7 @@ The code browser is available at [https://teb-model.github.io/teb](https://teb-m
 
 ## Example application
 
-To get started with TEB, see [`examples/CAPITOUL/README.md`](examples/CAPITOUL/README.md). The folder contains a simple tutorial in [Jupyter Notebook](https://jupyter.org/) to estimate the buildings' energy demand for cooling using TEB and data and parameters from the CAPITOUL (Canopy and Aerosol Particles Interactions in TOulouse Urban Layer; [Masson et al., 2008](https://doi.org/10.1007/s00703-008-0289-4)) campaign.
+To get started with TEB, see [`examples/CAPITOUL/README.md`](examples/CAPITOUL/README.md). The folder contains a simple tutorial in [Jupyter Notebook](https://jupyter.org/) to estimate the buildings' power demand for cooling using TEB and data and parameters from the CAPITOUL (Canopy and Aerosol Particles Interactions in TOulouse Urban Layer; [Masson et al., 2008](https://doi.org/10.1007/s00703-008-0289-4)) campaign.
 
 
 ## Testing

ThirdPartyNotices.txt

@@ -1,4 +1,4 @@
-TEB version 4.0.0 (https://github.com/teb-model/teb).
+TEB version 4.0.1 (https://github.com/teb-model/teb).
 
 THIRD-PARTY SOFTWARE NOTICES AND INFORMATION.
 Do Not Translate or Localize.

docs/software-docs.md

@@ -60,9 +60,9 @@ The following files are produced by the TEB `driver`.
 
 | Name         | Description                                      | Unit  |
 | ------------ | ------------------------------------------------ | ----- |
-| RN_TOWN.txt  | Surface net radiative flux density               | W/m²  |
-| H_TOWN.txt   | Surface turbulent sensible heat flux density     | W/m²  |
-| LE_TOWN.txt  | Surface turbulent latent heat flux density       | W/m²  |
+| RN_TOWN.txt  | Net all-wave radiation flux density              | W/m²  |
+| H_TOWN.txt   | Turbulent sensible heat flux density             | W/m²  |
+| LE_TOWN.txt  | Turbulent latent heat flux density               | W/m²  |
 | P_CANYON.txt | Pressure at road level                           | Pa    |
 | Q_CANYON.txt | Specific humidity at half building height        | kg/kg |
 | T_CANYON.txt | Dry-bulb air temperature at half building height | K     |
@@ -76,17 +76,17 @@ The following files are produced by the TEB `driver`.
 
 If building energy model option is activated (`CBEM = "BEM"`) in `input.nml`, the following outputs will also be present in W/m² of buildings ground surface  (not by m² of floor).
 
-| Name          | Description           | Unit          |
-| ------------- | --------------------- | ------------- |
-| HVAC_COOL.txt | Cooling Energy Demand | W/m² building |
-| HVAC_HEAT.txt | Heating Energy Demand | W/m² building |
+| Name          | Description          | Unit          |
+| ------------- | -------------------- | ------------- |
+| HVAC_COOL.txt | Cooling power demand | W/m² building |
+| HVAC_HEAT.txt | Heating power demand | W/m² building |
 
 If the solar panel option is activated (`LSOLAR_PANEL = .TRUE.`) in `input.nml`, the following outputs will also be present in W/m² panel.
 
-| Name                | Description                                  | Unit       |
-| ------------------- | -------------------------------------------- | ---------- |
-| THER_PROD_PANEL.txt | Thermal energy production of solar panels    | W/m² panel |
-| PHOT_PROD_PANEL.txt | Electrical energy production of solar panels | W/m² panel |
+| Name                | Description                                 | Unit       |
+| ------------------- | ------------------------------------------- | ---------- |
+| THER_PROD_PANEL.txt | Thermal power production of solar panels    | W/m² panel |
+| PHOT_PROD_PANEL.txt | Electrical power production of solar panels | W/m² panel |
 
 
 ## How to run TEB

external/CMakeLists.txt

@@ -1,4 +1,4 @@
-# TEB version 4.0.0 (https://github.com/teb-model/teb).
+# TEB version 4.0.1 (https://github.com/teb-model/teb).
 # Copyright 2018 D. Meyer. Licensed under CeCILL version 2.1.
 
 add_subdirectory(minimal-dx)

external/minimal-dx/CMakeLists.txt

@@ -1,11 +1,11 @@
-# TEB version 4.0.0 (https://github.com/teb-model/teb).
+# TEB version 4.0.1 (https://github.com/teb-model/teb).
 # Copyright 2018 D. Meyer. Licensed under CeCILL version 2.1.
 
 include(ExternalProject)
 
 ExternalProject_Add(minimaldx-project
     GIT_REPOSITORY https://github.com/dmey/minimal-dx.git
-    GIT_TAG 0.1.3
+    GIT_TAG 0.1.4
     CMAKE_ARGS
         -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}
         -DCMAKE_Fortran_COMPILER=${CMAKE_Fortran_COMPILER}

src/driver/modd_wrf_teb_driver.F90

@@ -1,4 +1,4 @@
-! TEB version 4.0.0 (https://github.com/teb-model/teb).
+! TEB version 4.0.1 (https://github.com/teb-model/teb).
 ! Copyright 2018 D. Meyer. Licensed under CeCILL version 2.1.
 
 MODULE MODD_WRF_TEB_DRIVER

tests/test.py

@@ -1,4 +1,4 @@
-# TEB version 4.0.0 (https://github.com/teb-model/teb).
+# TEB version 4.0.1 (https://github.com/teb-model/teb).
 # Copyright 2018 D. Meyer. Licensed under CeCILL version 2.1.
 
 import sys

tools/common_names.py

@@ -1,4 +1,4 @@
-# TEB version 4.0.0 (https://github.com/teb-model/teb).
+# TEB version 4.0.1 (https://github.com/teb-model/teb).
 # Copyright 2018 D. Meyer. Licensed under CeCILL version 2.1.
 
 standard_quantity_names = {
@@ -11,34 +11,34 @@
         "symbol": "T"
     },
     "Relative humidity": {
-        "unit": "%",
+        "unit": "\%",
         "symbol": "\\rm RH"
     },
-    "Total sky shortwave radiation flux density": {
+    "Downwelling shortwave radiation flux density": {
         "unit": "\\rm W\ m^{-2}",
-        "symbol": "S⇊"
+        "symbol": "S^{\\downarrow}"
     },
-    "Sky diffuse shortwave radiation flux density": {
+    "Downwelling diffuse shortwave radiation flux density": {
         "unit": "\\rm W\ m^{-2}",
-        "symbol": "S⇓"
+        "symbol": "S^{\\downarrow\\Downarrow}"
     },
-    "Sky direct shortwave radiation flux density": {
+    "Downwelling direct shortwave radiation flux density": {
         "unit": "\\rm W\ m^{-2}",
-        "symbol": "S↓"
+        "symbol": "S^{\\downarrow\\downarrow}"
     },
-    "Surface reflected shortwave radiation flux density": {
+    "Upwelling shortwave radiation flux density": {
         "unit": "\\rm W\ m^{-2}",
-        "symbol": "S↑"
+        "symbol": "S^{\\uparrow}"
     },
-    "Sky longwave radiation flux density": {
+    "Downwelling longwave radiation flux density": {
         "unit": "\\rm W\ m^{-2}",
-        "symbol": "L↓"
+        "symbol": "L^{\\downarrow}"
     },
-    "Surface longwave radiation flux density": {
+    "Upwelling longwave radiation flux density": {
         "unit": "\\rm W\ m^{-2}",
-        "symbol": "L↑"
+        "symbol": "L^{\\uparrow}"
     },
-    "Surface net radiative flux density": {
+    "Net all-wave radiation flux density": {
         "unit": "\\rm W\ m^{-2}",
         "symbol": "Q^*"
     },
@@ -58,33 +58,37 @@
         "unit": "\\rm g\ kg^{-1}",
         "symbol": "r"
     },
-    "Surface turbulent sensible heat flux density": {
+    "Turbulent sensible heat flux density": {
         "unit": "\\rm W\ m^{-2}",
-        "symbol": "H"
+        "symbol": "Q_H"
     },
-    "Surface turbulent latent heat flux density": {
+    "Turbulent latent heat flux density": {
         "unit": "\\rm W\ m^{-2}",
-        "symbol": "LE"
+        "symbol": "Q_E"
     },
-    "Rain rate": {
-        "unit": "\\rm mm\ h^{-1}",
-        "symbol": "RR"
+    "Rainfall rate": {
+        "unit": "\\rm kg\ m^{-2}\ s^{-1}",
+        "symbol": "\\rm RR"
+    },
+    "Snowfall rate": {
+        "unit": "\\rm kg\ m^{-2}\ s^{-1}",
+        "symbol": "\\rm SR"
     },
-    "Buildings\' energy demand for cooling": {
+    "Buildings\' power demand for cooling": {
         "unit": "\\rm W\ m^{-2}",
-        "symbol": "E_{\\rm cooling}"
+        "symbol": "Q_{\\rm cooling}"
     },
-    "Buildings\' energy demand for heating": {
+    "Buildings\' power demand for heating": {
         "unit": "\\rm W\ m^{-2}",
-        "symbol": "E_{\\rm heating}"
+        "symbol": "Q_{\\rm heating}"
     },
-    "Thermal energy production of solar panels on roofs": {
+    "Thermal power production of solar panels on roofs": {
         "unit": "\\rm W\ m^{-2}",
-        "symbol": "Q_{\\rm solar}"
+        "symbol": "Q_{\\rm thermal}"
     },
-    "Electrical energy production of solar panels on roofs": {
+    "Electrical power production of solar panels on roofs": {
         "unit": "\\rm W\ m^{-2}",
-        "symbol": "E_{\\rm solar}"
+        "symbol": "Q_{\\rm electrical}"
     },
     "Dry-bulb air temperature at half building height": {
         "unit": "\\rm K",
@@ -126,13 +130,13 @@
         "unit": "1",
         "symbol": "\\alpha"
     },
-    "Surface evaporative moisture flux density": {
+    "Evaporation mass flux density": {
         "unit": "\\rm kg\ m^{-2}\ s^{-1}",
         "symbol": "E"
     },
-    "Surface ground heat flux density": {
+    "Ground heat flux density": {
         "unit": "\\rm W\ m^{-2}",
-        "symbol": "G"
+        "symbol": "Q_G"
     },
     "Surface (skin) temperature": {
         "unit": "1",
@@ -155,14 +159,14 @@
 
 teb_quantity_names_inputs = {
     'CO2 concentration': 'CO2',
-    'Sky direct shortwave radiation flux density': 'DIR_SW',
+    'Downwelling direct shortwave radiation flux density': 'DIR_SW',
     'Wind direction': 'DIR',
-    'Sky longwave radiation flux density': 'LW',
+    'Downwelling longwave radiation flux density': 'LW',
     'Atmospheric pressure': 'PS',
     'Specific humidity': 'QA',
-    'Rain rate': 'RAIN',
-    'Sky diffuse shortwave radiation flux density': 'SCA_SW',
-    'Snow rate': 'SNOW',
+    'Rainfall rate': 'RAIN',
+    'Downwelling diffuse shortwave radiation flux density': 'SCA_SW',
+    'Snowfall rate': 'SNOW',
     'Dry-bulb air temperature': 'TA',
     'Wind speed': 'WIND'
 }
@@ -172,20 +176,20 @@
     'Canyon horizontal wind speed': 'U_CANYON',
     'Canyon specific humidity': 'Q_CANYON',
     'Canyon horizontal wind direction': 'DIR_CANYON',
-    'Buildings\' energy demand for cooling': 'HVAC_COOL',
-    'Buildings\' energy demand for heating': 'HVAC_HEAT',
-    'Surface net radiative flux density': 'RN_TOWN',
-    'Surface turbulent sensible heat flux density': 'H_TOWN',
-    'Surface turbulent latent heat flux density': 'LE_TOWN',
-    'Surface evaporative moisture flux density': 'EVAP_TOWN',
-    'Surface ground heat flux density': 'GFLUX_TOWN',
+    'Buildings\' power demand for cooling': 'HVAC_COOL',
+    'Buildings\' power demand for heating': 'HVAC_HEAT',
+    'Net all-wave radiation flux density': 'RN_TOWN',
+    'Turbulent sensible heat flux density': 'H_TOWN',
+    'Turbulent latent heat flux density': 'LE_TOWN',
+    'Evaporation mass flux density': 'EVAP_TOWN',
+    'Ground heat flux density': 'GFLUX_TOWN',
     'Specific humidity': 'Q_TOWN',
     'Surface friction velocity': 'USTAR_TOWN',
     'Surface albedo': 'ALB_TOWN',
     'Surface emissivity': 'EMIS_TOWN',
     'Surface (skin) temperature': 'TS_TOWN',
-    'Thermal energy production of solar panels on roofs': 'THER_PROD_PANEL',
-    'Electrical energy production of solar panels on roofs': 'PHOT_PROD_PANEL',
+    'Thermal power production of solar panels on roofs': 'THER_PROD_PANEL',
+    'Electrical power production of solar panels on roofs': 'PHOT_PROD_PANEL',
     'Canyon atmospheric pressure': 'P_CANYON',
     'Buildings\' internal dry-bulb air temperature': 'TI_BLD',
     'Road surface (skin) temperature': 'T_ROAD1',

tools/helpers.py

@@ -1,4 +1,4 @@
-# TEB version 4.0.0 (https://github.com/teb-model/teb).
+# TEB version 4.0.1 (https://github.com/teb-model/teb).
 # Copyright 2018 D. Meyer. Licensed under CeCILL version 2.1.
 
 import os