Started adding URock

UMEP-dev · Mar 23, 2023 · e6ba6f3 · e6ba6f3
1 parent 1bb5514
commit e6ba6f3
Show file tree

Hide file tree

Showing 7 changed files with 109 additions and 14 deletions.
diff --git a/docs/source/Introduction.rst b/docs/source/Introduction.rst
@@ -94,9 +94,9 @@ Pre-Processor
    * - `Spatial Data Downloader <SpatialDataDownloader>`
      - Plugin for retrieving geodata from online services suitable for various UMEP related tools (**deprecated**, see `FAQ` on how to retrieve data such population density).
    * - `DSM generator <DSMGenerator>`
-     - Creation/manipulation of a DSM based on user-specified building footprint vector data and/or `Open Street Map <http://www.openstreetmap.org>`__ data (if available) (PM).
+     - Creation/manipulation of a DSM based on user-specified building footprint vector data and/or `Open Street Map <http://www.openstreetmap.org>`__ data (if available) (P).
    * - `Tree generator <TreeGenerator>`
-     - Creation/manipulation of vegetation input data. (PM)
+     - Creation/manipulation of vegetation input data. (P)
    * - `LCZ Converter <LCZConverter>`
      - Conversion from Local Climate Zones (LCZs) in the WUDAPT database into SUEWS input data. (M)
 
@@ -107,9 +107,9 @@ Pre-Processor
    :header-rows: 0
 
    * - `Sky View Factor <SkyViewFactorCalculator>`
-     - Calculation of continuous maps of Sky View Factors (SVF) based on high resolution digital surface models (DSM). *Solar access, urban heat island* (PM)
+     - Calculation of continuous maps of Sky View Factors (SVF) based on high resolution digital surface models (DSM). *Solar access, urban heat island* (P)
    * - `Wall Height and Aspect <WallHeightandAspect>`
-     - Calculation of height and aspect of building walls based on a DSM. (PM)
+     - Calculation of height and aspect of building walls based on a DSM. (P)
 
 **Urban land cover**
 
@@ -158,6 +158,15 @@ Pre-Processor
      - Preprocessing and preparing input data for the Urban Weather Generator. *Urban heat island*  (UWG) (M)
    * - `UWG Reclassifier <UWGReclassifier>`
      - Tool to reclassify urban topologies into UWG building classes. *Urban heat island* (M)
+
+**Urban Wind fields**
+
+.. list-table::
+   :widths: 30 70
+   :header-rows: 0
+
+   * - `URock Prepare  <URockPrepare>`
+     - Tool to prepare spatial input data for the URock model. (P)
 
 Processor
 ~~~~~~~~~
@@ -198,19 +207,27 @@ Processor
    :header-rows: 0
 
    * - `Solar Energy on Building Envelopes (SEBE) <SEBE>`
-     - Solar irradiance on building roofs and walls in urban environments. *Economy and planning: Energy production, resource planning* (PM)
+     - Solar irradiance on building roofs and walls in urban environments. *Economy and planning: Energy production, resource planning* (P)
    * - `Daily Shadow Patterns <DailyShadowPattern>`
-     - Shadow patterns on a DSM and CDSM. *Economy and planning: Resource planning Human Health: Outdoor thermal comfort; Park planning* (PM)
+     - Shadow patterns on a DSM and CDSM. *Economy and planning: Resource planning Human Health: Outdoor thermal comfort; Park planning* (P)
 
 **Urban Heat Island**
 
 .. list-table::
    :widths: 30 70
    :header-rows: 0
 
-   * - `Urban Weather Generatore  <UWG>`
+   * - `Urban Weather Generator  <UWG>`
      - Model to calculate nocturnal urban heat island. *Urban heat island* (P)
+
+**Urban Wind fields**
 
+.. list-table::
+   :widths: 30 70
+   :header-rows: 0
+
+   * - `URock  <URock>`
+     - Semi-empirical model to estimate 3D wind fields in urban settings. Model is based on (Röckle 1990) *Thermal comfort; Urban outdoor planning; Wind loads*. (P)
 
 Post-Processor
 ~~~~~~~~~~~~~~
@@ -232,6 +249,8 @@ Post-Processor
 
    * - `SOLWEIG analyzer <SOLWEIGAnalyzer>`
      - Plugin for plotting, statistical analysis and post-processing of model results from SOLWEIG. (PM)
+   * - `Spatial TC <SpatialTC>`
+     - Plugin to produce maps of thermal comfort indices using output from SOLWIEG and URock. (P)
 
 
 **Urban Energy Balance**
@@ -262,6 +281,15 @@ Post-Processor
 
    * - `Benchmark System <Benchmark>`
      - For statistical analysis of model results, such as SUEWS. (M)
+
+**Urban Winds Fields**
+
+.. list-table::
+   :widths: 30 70
+   :header-rows: 0
+
+   * - `URock analyzer <URockAnalyzer>`
+     - Plugin for analyzing and vizualising URock resluts (P)
 
 .. _ToolApplications:
 

diff --git a/docs/source/OtherManuals/SOLWEIG.rst b/docs/source/OtherManuals/SOLWEIG.rst
@@ -3,7 +3,7 @@
 SOLWEIG Manual
 --------------
 
-The current version of SOLWEIG is v2021a (released 19 March 2022).
+The current version of SOLWEIG is v2022a (released 10 December 2022).
 
 NEW in this version: see `Version History`_.
 

diff --git a/docs/source/UMEPforProcessing.rst b/docs/source/UMEPforProcessing.rst
@@ -125,6 +125,10 @@ Below you can see which tools that have been migrated to UMEP fro processing and
      - READY (only available via **UMEP for processing**)
    * - UWGAnalyzer
      - READY (only available via **UMEP for processing**)
+   * - SpatialTC
+     - READY (only available via **UMEP for processing**)
+   * - URock
+     - READY (only available via **UMEP for processing**)
 
 
 
diff --git a/docs/source/images/SpatialTC.jpg b/docs/source/images/SpatialTC.jpg
diff --git a/docs/source/post_processor/Outdoor Thermal Comfort Spatial TC.rst b/docs/source/post_processor/Outdoor Thermal Comfort Spatial TC.rst
@@ -0,0 +1,63 @@
+.. _SpatialTC:
+
+Outdoor Thermal Comfort: Spatial Thermal Comfort
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* Contributor
+   .. list-table::
+      :widths: 50 50
+      :header-rows: 1
+
+      * - Name
+        - Institution
+      * - Fredrik Lindberg
+        - Gothenburg
+
+* Introduction
+    The **Spatial TC** plugin can be used to make maps of thermal indicies making use of output from the `SOLWEIG <SOLWEIG>`-plugin and the `URock <URock>`-plugin. All prior tools need to be executed via the Processing toolbox in QGIS and no filenames and folder structures should be changed. The Meteorological forcing file should be the same as used when executing SOLWEIG. This file can be found in the output-folder from SOLWEIG (*metforcing.txt*).
+
+* Dialog box
+    .. figure:: /images/SpatialTC.jpg
+        :width: 100%
+        :align: center
+
+        Dailog for Spatial TC
+
+
+* Basic parameters
+   .. list-table::
+      :widths: 25 75
+      :header-rows: 0
+
+      * - Mean radiant temperature raster (SOLWEIG)
+        - A raster grid originating from a SOLWEIG run. Filename should not be changed (*Tmrt_YYYY_DOY_HHMMD.tif*).
+      * - Pedestrian wind speed raster
+        - A raster grid originating from a URock run.
+      * - Raster to exclude building pixels from analysis
+        - A raster grid originating from a SOLWEIG run. This is created if the tickbox specifying the building grid output is ticked in.
+      * - Input meteorological tile (.txt). Same as used for Tmrt map.
+        - Meterological forcing data used in the SOLWEIG run. This file can also be found in the output folder from a the SOLWEIG run executed via the Processing Toolbox in QGIS.
+      * - Thermal Index to map
+        - Here, a specific thermal index can be choosen. At the moment, PET is only available. More is coming!
+
+* Advanced Parameters
+   .. list-table::
+      :widths: 25 75
+      :header-rows: 0
+
+      * - Age (yy)
+        - Used to calculate PET.
+      * - Activity (W)
+        - Used to calculate PET.
+      * - Clothing (clo)
+        - Used to calculate PET.
+      * - Weight (kg)
+        - Used to calculate PET.
+      * - Height (cm)
+        - Used to calculate PET.
+      * - Sex
+        - Used to calculate PET.
+
+* Remarks
+    - The wind speed and direction columns found in the meteorological forcing data does not have to be the same used in URock. These column are used if PET or UTCI is calculated for Point of Interests (POI).
+    - All rasters used must have the same sixe. This can be accomplished by setting the URock output to be the same size as the SOLWEIG output.
diff --git a/...t_processor/Wind model URock Analyser.rst → ...ssor/Urban Wind Fields URock Analyzer.rst b/...t_processor/Wind model URock Analyser.rst → ...ssor/Urban Wind Fields URock Analyzer.rst
@@ -1,7 +1,7 @@
-.. _URockAnalyser:
+.. _URockAnalyzer:
 
-Wind model: URock Analyser
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Urban Wind Fields: URock Analyzer
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. note:: This plugin is still experimental. Please report any issues to our `code repository <https://github.com/UMEP-dev/UMEP>`__.
 

diff --git a/docs/source/processor/Wind model URock.rst b/docs/source/processor/Wind model URock.rst
@@ -1,7 +1,7 @@
 .. _URock:
 
-Wind model: URock
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Urban Wind Fields: URock
+~~~~~~~~~~~~~~~~~~~~~~~~
 * Contributor:
    .. list-table::
       :widths: 50 50
@@ -20,7 +20,7 @@ Wind model: URock
     The **URock** plugin can be used to calculate spatial variations of wind speed and wind direction in 3 dimensions using 2.5D building and vegetation data. The methodology originates from Röckle (1990), has been implemented in proprietary softwares such as QUIC-URB (Brown et al., 2013) or SkyHelios (Fröhlich and Matzarakis, 2018) and is further described in (Bernard et al., 2023 - not published). The current version of the model is 2023a.
 
 * Related Preprocessors
-   `MetPreprocessor`, `ERA5`, `VectorGenerator`
+   `MetPreprocessor`, `ERA5`, `URockPrepare`
 
 * Dialog box
    .. figure:: /images/URock_v2023a.png