Difference between revisions of "UMEP Manual"

From UMEP
Jump to: navigation, search
(Processor)
(Post-Processor)
Line 12: Line 12:
  
 
=
 
=
 
==Post-Processor==
 
===Solar Radiation: SEBE (Visualisation)===
 
{|class="wikitable"
 
|-
 
|Contributor||Niklas Krave (Gothenburg)
 
|-
 
|Introduction||The '''SEBE (Visualisation)''' plugin can be used to visulise 3D output from model results generated by the SEBE plugin.
 
|-
 
| Location ||
 
The Shadow Generator is located at
 
* UMEP
 
** Post-Processor
 
*** Solar Radiation
 
**** SEBE (Visualisation)
 
|-
 
|Dialog box||
 
 
[[File:SEBEvisualisation.png| none|Dialog for the SEBE (Visualisation) plugin]]
 
|-
 
|Dialog sections ||
 
{|class="wikitable"
 
|-
 
|top ||Canvas for visualisation
 
|-
 
|bottom ||Input data and settings
 
|}
 
|-
 
|Select input folder||The directory where results from a previous model run in SEBE is located.
 
|-
 
|Area of visualisation || When this pushbutton is clicked, a recanglge can be drawn on the map canvas. This is the area that will be visulised.
 
|-
 
|Visulise|| When this button is clicked, the selected rectangular area will be visulised in the SEBE (visualisation) canvas at the top of the GUI.
 
|-
 
|Close||This closes the plugin.
 
|}
 
 
===Outdoor Thermal Comfort: SOLWEIG Analyzer===
 
{|class="wikitable"
 
|-
 
|Contributor||Fredrik Lindberg (Gothenburg)
 
|-
 
|Introduction||The '''SOLWEIG Analyzer''' plugin can be used to make basic analysis of model results generated by the SOLWEIG plugin.
 
|-
 
| Location ||
 
The SOLWEIG Analyzer is located at
 
* UMEP
 
** Post-Processor
 
*** Outdoor Thermal Comfort
 
**** SOLWEIG Analyzer
 
|-
 
|Dialog box||
 
 
[[File:SOLWEIGAnalyzer.png| none|Dialog for the SOLWEIG Analyzer plugin]]
 
|-
 
|Dialog sections ||
 
{|class="wikitable"
 
|-
 
|top ||Input data is specified
 
|-
 
|left ||Plotting of time series derived from Points of Interest during model calculations in SOLWEIG 
 
|-
 
|bottom ||Analysis of spatial results from model calculations in SOLWEIG
 
|}
 
|-
 
|Load model result||The directory where results from a previous model run in SOLWEIG is located.
 
|-
 
|Point of Interest data
 
|
 
{|class="wikitable"
 
|-
 
|POIs available||Here, a list of all available POI files are listed. Specify one of the POIs. If no variable is available, then no data if found in the Model output folder.
 
|-
 
|Variable||Specify one of the available variables to plot.
 
|-
 
|Add another POI / variable||Tick this in to add another variable in the plot.
 
|-
 
|Scatterplot||Tick this in to generate a scatterplot between the two variables specified above.
 
|-
 
|Plot||Plot the data selected above
 
|}
 
|-
 
|Spatial data
 
|
 
{|class="wikitable"
 
|-
 
|Variable to visualize||Select a listed variable to process. If no variable is available, then no data if found in the Model output folder.
 
|-
 
|Show animation||This produces a time-related animation of the selected variable scaled based on the settings to the left in the GUI.
 
|-
 
|Exclude building pixels||Tick this in to exclude building pixels using a building grid generated from the SOLWEIG run. The building grid must have the same extent and pixel resolution as the generated output maps in the model output folder.
 
|-
 
|Diurnal average||Tick this in to include all grids for the selected variable to derive a pixelwise average.
 
|-
 
|Daytime average||Tick this in to include all daytime grids for the selected variable to derive a pixelwise average.
 
|-
 
|Nightime average||Tick this in to include all nighttime grids for the selected variable to derive a pixelwise average.
 
|-
 
|Maximum||Tick this in to get the pixelwise maximum for the selected variable.
 
|-
 
|Minimum||Tick this in to get the pixelwise minimum for the selected variable.
 
|-
 
|Average of specific time of day||The average of the selected time of day for the variable selected is generated. If 'Not Specified' is highlighted, no grid will be generated.
 
|-
 
|Maximum of specific time of day||The maximum of the selected time of day for the variable selected is generated. If 'Not Specified' is highlighted, no grid will be generated.
 
|-
 
|Minimum of specific time of day||The minimum of the selected time of day for the variable selected is generated. If 'Not Specified' is highlighted, no grid will be generated.
 
|-
 
|T<sub>mrt</sub>: Percent of time above threshold (degC)||If T<sub>mrt</sub> is the selected variable, this box become active and calculates the percent of time that T<sub>mrt</sub> for each is above the threshold specified to the right.
 
|-
 
|T<sub>mrt</sub>: Percent of time below threshold (degC)||If T<sub>mrt</sub> is the selected variable, this box become active and calculates the percent of time that T<sub>mrt</sub> for each is below the threshold specified to the right.
 
|-
 
|Output folder||Directory where the results specified above will be saved.
 
|-
 
|Add analysis to map canvas||All analysis specified above will be added to the map canvas if this box is ticked in.
 
|-
 
|Generate||Starts the spatial processing/analysis.
 
|}
 
|-
 
|Close||This closes the plugin.
 
|}
 
 
===Urban Energy Balance: SUEWS Analyser===
 
{|class="wikitable"
 
|-
 
|Contributor||Fredrik Lindberg (Gothenburg)
 
|-
 
|Introduction||The '''SUEWS Analyzer''' plugin can be used to make basic analysis of model results generated by the ''SUEWS Simple'' and ''SUEWS Advanced'' plugins.
 
|-
 
| Location ||
 
The SUEWS Analyzer is located at
 
* UMEP
 
** Post-Processor
 
*** Urban Energy Balance
 
**** SUEWS Analyzer
 
|-
 
|Dialog box||
 
 
[[File:SUEWSAnalyzer.png| none|Dialog for the SUEWS Analyzer plugin]]
 
|-
 
|Dialog sections ||
 
{|class="wikitable"
 
|-
 
|top ||Model results to be analyzer is specified.
 
|-
 
|left ||Plotting of time series derived from Points of Interest during model calculations in SUEWS 
 
|-
 
|bottom ||Analysis of spatial results from model calculations in SUEWS
 
|}
 
|-
 
|Load model result||A namelist (''RunControl.nml'') used for the model run should be specified. This can be located in the '''suewsmodel''' directory found as a sub-directory of the '''UMEP'''-plugin directory. Note that the namelist includes information on the last model run performed.
 
|-
 
|Point data
 
|
 
{|class="wikitable"
 
|-
 
|Grid||Here, a list of all available modeled grids are listed. Specify one of the grid IDs. If no grid is available, then no data if found in the model output folder.
 
|-
 
|Year to investigate||Specify one of the available years to plot.
 
|-
 
|Plot basic data||Tick this in to plot a summary of the most essential output variables.
 
|-
 
|Time Period (DOY)||Specify the time period to plot.
 
|-
 
|Variable||Specify one of the available variables to plot.
 
|-
 
|Include another variable||Tick this in to add another variable in the plot.
 
|-
 
|Grid||Here, a list of all available modeled grids are listed. Specify one of the grid IDs. If no grid is available, then no data if found in the model output folder.
 
|-
 
|Variable||Specify one of the available variables to plot.
 
|-
 
|Scatterplot||Tick this in to generate a scatterplot between the two variables specified above.
 
|-
 
|Plot||Plot the data selected above
 
|}
 
|-
 
|Spatial data
 
|
 
{|class="wikitable"
 
|-
 
|Variable to analyze||Select a listed variable to process. If no variable is available, then no data if found in the Model output folder.
 
|-
 
|Year to investigate||Specify one of the available years to plot.
 
|-
 
|Time Period (DOY)||Specify the time period to plot.
 
|-
 
|Average||Tick this in to derive a grid-wise average.
 
|-
 
|Maximum||Tick this in to derive a grid-wise maximum.
 
|-
 
|Minimum||Tick this in to derive a grid-wise minimum.
 
|-
 
|Median||Tick this in to derive a grid-wise median value.
 
|-
 
|IQR||Tick this in to derive a grid-wise interquartile range.
 
|-
 
|Diurnal||Tick this in to include diurnal (all) data.
 
|-
 
|Daytime||Tick this in to include daytime data.
 
|-
 
|Nightime||Tick this in to include nighttime data.
 
|-
 
|Vector polygon grid used in the SUEWS model||Specify the grid that was used to generate the input data to the SUEWS model run of interest.
 
|-
 
|ID||Specify the attribute ID used to generate the input data to the SUEWS model run of interest.
 
|-
 
|Add result to polygon grid||Tick this box to add the results in the attribute table of the grid specified.
 
|-
 
|Save of GeoTIFF||Tick this in to generate a raster grid from the analyze settings specified.
 
|-
 
|Irregular grid (not squared)||Tick this in if a grid is irregular i.e. not squared and aligned north to south.
 
|-
 
|Pixel resolution (m)||When a irregular grid is used, a pixel resolution in meters must be specified.
 
|-
 
|Output filename||Name of the GeoTIFF to be saved.
 
|-
 
|Add analysis to map canvas||All analysis specified above will be added to the map canvas if this box is ticked in.
 
|-
 
|Generate||Starts the spatial processing/analysis.
 
|}
 
|-
 
|Close||This closes the plugin.
 
|}
 
 
=== Benchmark System===
 
{|class="wikitable"
 
|-
 
|Contributors ||
 
Ting Sun (Reading), Sue Grimmond (Reading)
 
|-
 
|Overview||
 
'''Note''': the current version runs in a command-line interface (CLI) driven by Python and the GUI-based version is under construction.
 
 
The Benchmark System for SUEWS (BSS) can be used with SUEWS to assess the model performance between different configurations and model generations. BSS is written in Python and shipped with an example namelist and an MS Excel spreadsheet for header lookup between different SUEWS versions.
 
 
|-
 
| Location ||
 
The SUEWS Analyzer is located at
 
* UMEP
 
** Post-Processor
 
*** Benchmark
 
 
|-
 
|Benchmark results||
 
Two types of metrics are provided:
 
[[File:BSS-result.png| thumb|alt=Alt text |Figure 1: BSS results for (a) the overall performance and (b) a specific statistics (e.g., RMSE)]]
 
* overall performance score: a score between 0 and 100 with larger score denoting better overall performance
 
* specific statistics: a range of statistics, including Mean absolute error (MAE), root mean square error (RMSE), standard deviation (Std), etc., to indicate detailed performance in specific variables.
 
 
The users can use the overall performance score to get the performance overview of all configurations (Fig. 1a) and specific statistics to examine the performance details (Fig. 1b).
 
 
|-
 
|Usage||
 
[[File:BSS-file-layout.png| thumb|Figure 2: Required file organisation by BSS.]]
 
To use BSS, in addition to the mandatory BSS files (i.e., Benchmark_SUEWS.py, benchmark.nml and head-2016to2017.xlsx), the SUEWS output results are required to be placed in a separate folder (e.g., “input”) that contains the sub-folders of results produced by different configurations.
 
A sample layout of the BSS test case refers to Fig. 2. It must be noted that the output files to be benchmarked should be of consistent temporal organisation (i.e., identical length and resolution) while the headers of different files are not necessarily to be identical as BSS will handle the header inconsistency automatically. Besides, two sub-folders, "base" and "ref", which contain the baseline results to be tested against and reference results to be compared with, respectively, must exist otherwise the BSS will stop.
 
 
When the SUEWS output files are prepared, the namelist (i.e., benchmark.nml) needs to be set for the benchmarking. The benchmark namelist is fairly self-explanatory and consists two sections, "file" and "benchmark", to play with. One tip is about the variable list (i.e., var_list): if one non-string value is set (e.g., 123, 3.2, etc.), all valid variables will be included in the benchmarking. Then the user can execute the Benchmark_SUEWS.py script and a PDF file with benchmark results will be generated (e.g., benchmark.pdf in Fig. 2).
 
|-
 
|Namelist: benchmark.nml||
 
The benchmark namelist is fairly self-explanatory and consists two sections, "file" and "benchmark", to play with.
 
 
One tip is about the variable list (i.e., var_list): if one non-string value is set (e.g., 123, 3.2, etc.), all valid variables will be included in the benchmarking.
 
 
A sample namelist is as follows:
 
 
&file
 
  input_dir = 'input'
 
  output_pdf = 'benchmark'
 
/
 
&benchmark
 
  list_var='QN' 'QS' 'QE' 'QH'
 
  list_metric='MAE' 'MBE' 'RMSE'
 
  method_score=1 ! not used yet
 
/
 
 
 
|}
 
 
 
 
  
 
==People Involved & Acknowledgements==
 
==People Involved & Acknowledgements==

Revision as of 14:51, 11 July 2018

New manual Homepage

https://umep-docs.readthedocs.io/en/latest/

UMEP: How to Cite

Please use the reference below when UMEP is used:

Lindberg F, Grimmond CSB, Gabey A, Huang B, Kent CW, Sun T, Theeuwes N, Järvi L, Ward H, Capel-Timms I, Chang YY, Jonsson P, Krave N, Liu D, Meyer D, Olofson F, Tan JG, Wästberg D, Xue L, Zhang Z (2017) Urban Multi-scale Environmental Predictor (UMEP) - An integrated tool for city-based climate services.  Environmental Modelling and Software https://doi.org/10.1016/j.envsoft.2017.09.020

The manual should be cited as:

Lindberg F, Grimmond CSB, A Gabey, L Jarvi, CW Kent, N Krave, T Sun, N Wallenberg, HC Ward (2017) Urban Multi-scale Environmental Predictor (UMEP) Manual. http://urban-climate.net/umep/UMEP_Manual University of Reading UK, University of Gothenburg Sweden, SIMS China

=

=

People Involved & Acknowledgements

Group Institution & Support Acknowledged Team
Sue Grimmond University of Reading, UK
Met Office/Newton Fund CSSP - China
NERC TRUC NERC ClearfLo
EPSRC LoHCool EPSRC PhD Studentships
EUf7 Bridge EUf7 emBRACE
H2020 UrbanFluxes NERC Case Studentship
Christoph W. Kent
Helen Ward
Ting Sun
Izzy Capel-Timms
Andy Gabey
Bei HUANG
Fredrik Lindberg University of Gothenburg, Sweden
H2020 UrbanFluxes
FORMAS Climplan
Frans Olofsson
Niklas Krave
Shiho Onomura
Leena Järvi University of Helsinki, Finland
Maj and Tor Nessling foundation
Academy of Finland
EUf7 Bridge
Tom Kokkonen
Jian Guo Tan Shanghai Institute of Meteorological Sciences, SMS, CMA, China
Yuan Yong Chang
Dongwei Liu
XY Ao

Tutorials

To help users getting started with UMEP, the community is working on setting up tutorials and instructions for different parts of the UMEP tool. The following gives what are available and planned.

Topic Parts of UMEP Name Application
Source Area Footprint Pre-Processor Footprint Interpretation of eddy covariance flux source areas
Urban energy balance Processor Introduction to SUEWS Energy, water and radiation fluxes
Urban energy balance Pre-Processor and Processor SUEWS Advanced Energy, water and radiation fluxes
Potential solar energy production on building envelopes Processor and Post-Processor SEBE Amount of solar energy received on building facets
Outdoor thermal comfort Pre-Processor and Processor Introduction to SOLWEIG Mean radiation temperature modelling in complex urban settings
Anthropogenic heat Processor GQF Anthropogenic heat modelling for the greater London area using GQF (uses the GreaterQF methodology)
Anthropogenic heat Processor LQF Anthropogenic heat modelling in London using LQF (uses the LUCY methodology)

How to Contribute

UMEP is an an open source tool that we are keen to get others inputs and contributions. There are two main ways to contribute:

  1. Submit comments or issues to the repository
  2. Participate in Coding or adding new features.
  3. Create new tutorials for the UMEP-plugin.

Reporting a Bug

  • As a good citizen of the open source community please report bugs. If it is a UMEP plugin related issue - report this to the https://bitbucket.org/fredrik_ucg/umep/issues UMEP plugin. You can see if your bug is already reported. In order for the UMEP team to solve your issue as easy as fast as possible, please provide a full description of the problem including steps to repeat it. The more info given, the easier it is for us to solve your issues.
  • Please have a look at Known Issues and FAQ (found below) before submitting an issue to the repository.
  • A bug may also be caused by QGIS. By reporting bugs (and also maybe helping out to solve them) is essential to the open source community. At [www.qgis.org www.qgis.org] you can find out more on what you can do to get involved.
  • QGIS: how to report a QGIS issue: http://qgis.org/en/site/getinvolved/development/index.html#qgis-bugreporting.

Known Issues

  • QGIS (27/September/2017) had an issue using gdal which causes QGIS to create a minidump when the software is closed. This issue has now been fixed (issue #13061). Other issues found should be reported to our repository.
  • UMEP plugin is not compatible with matplotlib versions 2.x. Use instead 1.5.x. (23/August/2017)
  • Mac users might have issue pointing at non-existing directories. Work around is to manually create directories before starting any UMEP-process.
  • Only use standard English alpha-numeric characters (e.g. no space, å, % etc.)
  • Issues has been reported using .sdat rasters. GeoTiff are recommended.

FAQ (Frequently Asked Questions)

Question Answer
How do I upgrade the plugin? When a new LTR version is released it will be available from the repository. In QGIS to check for updates, go to Plugins>Manage and Install Plugins....

If the UMEP plugin is in bold, a new version is available. On how to upgrade to the development version, see Getting started.

How do I uninstall the plugin? Go to Plugins>Manage and Install Plugins.... Locate the UMEP plugin and click Uninstall.
How do I install other python packages (e.g. pandas) as well as other libraries not included in the Desktop Express Install of QGIS? Follow the instruction from this link.
MY new raster is just black after using e.g. the Wall Height and Aspect plugin. What is wrong? Probably nothing. Is is just QGIS that scales the a loaded raster by excluding outliers and if you have large areas with e.g. zeros (which you have in the resulting raster from this plugin) it looks like there is only zeros in your new raster. Go to properties of your new raster layers and reclassify your values that should visualized.
Can the UMEP-plugin be used when Nodata-values are present in the input rasters? Yes, it can but we strongly recommend you to reclassify Nodata values to e.g. 0 before using them in UMEP. Here is a forum discussion that can help: https://gis.stackexchange.com/questions/12418/redefining-nodata-value-into-zero-in-qgis
Why is UMEP having problems saving output files? Check that your path contains only English characters. For Mac users: the UMEP graphical interface will occasionally want to create a folder instead of selecting a folder. In this case in Save As: write the folder name you would like to save your output, press Save, when it asks “...folder name...” already exists. Do you want to replace it? press Replace.
How is frontal area index calculated in Image Morphometric Parameters plugins? Our method is only using one line through the center of the grid for each wind direction. This is because we rotate the DSM and hence it is only the center line that includes height information. We do this since we are using a pure raster-based approach and if we were to instead rotate the search direction vector we would end up with different lengths for each wind direction. If you want to investigate a certain wind direction I suggest that you use a section of wind directions; e.g. 45 degrees.
How do I report a bug? Report it at the repository
What can UMEP do? Tool Architecture provides an overview
Who has developed this? People involved in development
What are the development guidelines? http://urban-climate.net/umep/DevelopmentGuidelines
How can I uninstall QGIS?
Uninstall.png

Uninstalling QGIS on a Windows PC is not done via the Control Panel as most other software. To uninstall completely, start the OSGeo4W setup (found in your start menu) and choose Advanced install. Continue until you come up to the window where you can add, remove and upgrade the different packages in your QGIS installation. Click on the small wheel with two arrows next to Desktop until Uninstall is seen. This removes shortcuts and most of the files related to QGIS. However, not all OSGeo products are removed. IF you want remove everything, open your File Explorer and remove the folder manually where you installed the OSGEO products (usually under C:\OSGeo4W64).

How do I ask other questions? There is an email list. Or you can ask them at the repository

Abbreviations

Acronym Defintion Comments
CDSM Canopy Digital Surface Model A vegetation raster grid where vegetation heights is given in meter above ground level. Pixels with no vegetation should be zero.
CRS Coordinate Reference System
CRU Climatic Research Unit
DEM Digtial Elevation Model Here, same definition as DTM.
DSM Digital Surface Model A raster grid including both buildings and ground given in meter above sea level.
DTM Digtial Terrain Model A raster grid including only ground heights given in meter above sea level.
ECMWF European Centre for Medium-Range Weather Forecasts
GIS Geographical Information System
LCZ Local Climate Zone
LST Local Standard Time
LTR Long term release
LUCY Large scale Urban Consumption of energy model
m agl metres above ground level
m asl metres above sea level
OTF On the Fly Used in QGIS when different geodatasets with different coordinate systems are projected in the same automatically.
QF Anthropogenic heat flux
SEBE Solar Energy on Building Envelopes
SOLWEIG Solar and longwave environmental irradiance geometry model
SUEWS Surface urban energy and water balance scheme
SVF Sky View Factor
TDSM Trunk zone Digital Surface Model A raster grid specifying the height up to the buttom of a vegetation canopy in meter above ground level. Pixels with no trunk height should be zero.
UMEP Urban Multi-scale Environmental Predictor
WFDEI WATCH Forcing Data methodology applied to ERA-Interim data
WUDAPT The World Urban Database and Access Portal Tools