README.md 2.74 KB
Newer Older
simon_desktop's avatar
simon_desktop committed
1
2
3
4
## DRUM Model

The initial pass at the DRUM model.

5
6
A description of the model's functionality and code structure is presented in the PDF report found at docs/latex_doc/report/drum-model.pdf

Simon Alderton's avatar
Simon Alderton committed
7
The following notes give a summary of how the input data is produced.
8

Simon Alderton's avatar
Simon Alderton committed
9
10
11

## Input Data

12
13
14
15
16
17
18
19
20
21
22
23
The model has the following input data requirements (a static version is held in the data/init_raw_data/ directory):
* osm_buildings (point locations of buildings in the study sites, from OpenStreetMaps).
* strataa (point locations of buildings from STRATAA census).
* study_polygons (polygons of the study sites).
* swarmdb (a copy of the SWARM database).
* worldpop (summary of world population information for the study sites).

Methods to produce these inputs are described below.

### OSM buildings

Raw OSM data was extracted for Malawi using the OSM API (using the OSMnx Python package). A copy of this raw data is in the following location:
Simon Alderton's avatar
Simon Alderton committed
24
* misc/input_data_processing/osm_buildings/osm_api_buildings_sites_raw/
25
26

Buildings were then filtered, areas calculated, and converted to point geometries using the following script:
Simon Alderton's avatar
Simon Alderton committed
27
* misc/input_data_processing/osm_buildings/process_osm_buildings.py
28

Simon Alderton's avatar
Simon Alderton committed
29
The filtered data that is output from this script is saved in the following location:
Simon Alderton's avatar
Simon Alderton committed
30
* misc/input_data_processing/osm_buildings/osm_api_buildings_sites_filter/
31
32
33
34
35

And the malawi_buildings_filter.gpkg used as an input to the DRUM model.

### STRATAA

Simon Alderton's avatar
Simon Alderton committed
36
Raw copies of the STRATAA census data are stored here:
Simon Alderton's avatar
Simon Alderton committed
37
* misc/input_data_processing/STRATAA/original_data/
Simon Alderton's avatar
Simon Alderton committed
38

Simon Alderton's avatar
Simon Alderton committed
39
These are then processed by the following script, so that house locations can be generated:
Simon Alderton's avatar
Simon Alderton committed
40
* misc/input_data_processing/STRATAA/make_house_gpkg.py
Simon Alderton's avatar
Simon Alderton committed
41

Simon Alderton's avatar
Simon Alderton committed
42
And house locations in geopackage format output to the following location:
Simon Alderton's avatar
Simon Alderton committed
43
* misc/input_data_processing/shps/STRATAA/
Simon Alderton's avatar
Simon Alderton committed
44

45
(The  *_poly.gpkg files are used as inputs to the DRUM model).
Simon Alderton's avatar
Simon Alderton committed
46

47
### Study Polygons
Simon Alderton's avatar
Simon Alderton committed
48

49
Copies of the study site polygons can be found here:
Simon Alderton's avatar
Simon Alderton committed
50
* misc/input_data_processing/shps/polygons/study_polygons.gpkg
Simon Alderton's avatar
Simon Alderton committed
51

52
### SWARM Database
Simon Alderton's avatar
Simon Alderton committed
53

54
The version of the SWARM database in this repository is a copy taken from Barrie's SWARM repo on 21st Dec 2020.
Simon Alderton's avatar
Simon Alderton committed
55

56
### WorldPop Data
Simon Alderton's avatar
Simon Alderton committed
57

58
Summary information from WorldPop is processed using the following script:
Simon Alderton's avatar
Simon Alderton committed
59
* misc/input_data_processing/worldpop/worldpop_analysis.py
Simon Alderton's avatar
Simon Alderton committed
60

61
The population estimates for the study sites are output to 
Simon Alderton's avatar
Simon Alderton committed
62
* misc/input_data_processing/worldpop/world_pop_numbers.yml
Simon Alderton's avatar
Simon Alderton committed
63

Simon Alderton's avatar
Simon Alderton committed
64
These estimates are entered into the synthpop configuration file.
simon_desktop's avatar
simon_desktop committed
65

simon_desktop's avatar
simon_desktop committed
66

67
## Example outputs
simon_desktop's avatar
simon_desktop committed
68

Simon Alderton's avatar
Simon Alderton committed
69
70
Example output files from each stage of the DRUM model for the Chikwawa study site are provided in the following directory:
* misc/eg_outputs
simon_desktop's avatar
simon_desktop committed
71

Simon Alderton's avatar
Simon Alderton committed
72
The config files used to generate this set of outputs are provided in the same directory.