New GDE feature: updated documentation

GDE_check_tiles_vs_visual_CSVs.py

@@ -27,8 +27,11 @@ This code reads the visual CSV output by cell and the corresponding GDE tiles HD
 and compares the number of buildings, cost and number of people in each cell according
 to each of the two. An output CSV file collects the discrepancies found, if any.
 
-Note that the code goes through each cell ID in the CSV output and attemps to open the
-corresponding HDF5 file. No check is carried out to see if there is any HDF5 file wi
+The code goes through each cell ID in the CSV output and attemps to open the
+corresponding HDF5 file. It outputs an error if the HDF5 file is not found. The code also
+reads the list of all HDF5 files in the indicated directory and checks if there are any
+HDF5 files that are not in the CSV file, writing a warning to the output file if that
+is the case.
 """
 
 import datetime

docs/02_Execution.md

@@ -24,8 +24,11 @@ The order in which the scripts in the present repository need to be run to produ
 8. If the OpenQuake input files for the SERA model distributed onto a grid are desired (i.e. not GDE, just SERA), run `SERA_create_OQ_input_files.py` with the desired distribution method.
 9. If a CSV summarising the number of buildings, dwellings, people and costs by cell according to the SERA model is desired (i.e. not GDE, just SERA), run  `SERA_create_visual_output_of_grid_model_full_files.py` with the desired distribution method.
 10. Run `OBM_buildings_per_cell.py` with the desired distribution method.
-11. Run `GDE_gather_SERA_and_OBM.py` with the desired distribution method. The output is a series of CSV files that serve as input for damage/risk calculations to be run in OpenQuake (https://github.com/gem/oq-engine), a CSV file that summarises results per cell and contains the geometry of the cells so that it can all be visualised with a GIS, and a CSV file that summarises results per adminstrative unit and contains the geometry of the administrative boundaries so that it can all be visualised with a GIS.
-
+11. Run `GDE_gather_SERA_and_OBM.py` with the desired distribution method. The output is:
+    a. a series of CSV files that serve as input for damage/risk calculations to be run in OpenQuake (https://github.com/gem/oq-engine);
+    b. a CSV file that summarises results per cell and contains the geometry of the cells so that it can all be visualised with a GIS;
+    c. a CSV file that summarises results per adminstrative unit and contains the geometry of the administrative boundaries so that it can all be visualised with a GIS;
+    d. a series of HDF5 files (one per cell) that contain the final GDE model.
 
 ## Testing Scripts
 
@@ -41,6 +44,7 @@ The order in which the scripts in the present repository need to be run to produ
 
 - The script `GDE_check_OQ_input_files.py` can be run after step 11 above. It prints to screen some summary values of the files and checks that the asset ID values are all unique. 
 
+- The script `GDE_check_tiles_vs_visual_CSVs.py` can be run after step 11 above. It reads the visual CSV output by cell and the corresponding GDE tiles HDF5 files and compares the number of buildings, cost and number of people in each cell according to each of the two. An output CSV file collects the discrepancies found, if any.
 
 ## Other Scripts
 

docs/guide_to_use_of_config_file.csv

@@ -26,3 +26,4 @@ SERA_testing_mapping_admin_units_to_cells_qualitycontrol,Y,Y,N,Y,N,N,N,N
 SERA_testing_rebuilding_exposure_from_cells_alternative_01,Y,Y,N,Y,N,N,N,N
 SERA_testing_rebuilding_exposure_from_cells_alternative_02,Y,Y,N,N,N,N,N,N
 SERA_testing_rebuilding_exposure_from_cells_alternative_03,Y,Y,N,N,N,N,N,N
+GDE_check_tiles_vs_visual_CSVs,Y,Y,N,N,N,N,N,N