udm-heat/model-definition.yml at main · OpenCLIM/udm-heat · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
kind: M
api_version: v1beta3
metadata:
  display_name: UDM-HEAT
  name: udm-heat
  summary: Tool for converting UDM outputs to 12Km RCM grid
  publisher: Newcastle University
  source_code: https://github.com/OpenCLIM/udm-heat
  description: >
    Convert UDM gridded 1km outputs to 12km RCM grid with SUM method.
  contact_point_name: Craig Robson
  contact_point_email: craig.robson1@ncl.ac.uk
spec:
  inputs:
    parameters:
      - name: calculate_new_population
        title: Calculate the new total population
        type: boolean
        description: Calculate the new population given where UDM has located new people through new dwellings.
        default: true
        required: true
      - name: demographic_breakdown
        title: Calculate population by demographic age band
        type: boolean
        description: Using the new total population calculate the number of people in the 4 demographic age bands based on ratios calculated from the SSPs.
        default: true
        required: true
      - name: new_dwelling_totals
        title: Calculate the total of new dwellings by type
        type: boolean
        description: Get the number of dwellings built for the 4 types built by UDM
        default: true
        required: true
      - name: dwelling_totals
        title: The total number of dwellings by type
        type: boolean
        description: Added the new dwellings to those existing in the base data
        default: true
        required: true
      - name: rcm_population_outputs
        title: Rasterise population outputs to the 12km RCM grid
        type: boolean
        description: Rasterise population outputs from geopackage to as .asc
        default: true
        required: true
      - name: include_northern_ireland
        title: Include population data for Northern Ireland
        type: boolean
        description: Include population values for Northern Ireland filling the gap from UDM which doesn't include NI data.
        default: true
        required: true
      - name: adjust_population_baseline
        title: Adjust baseline population
        type: boolean
        description: To account for potential errors in the baseline population data, adjust using the pre-calculated values
        default: true
        required: true

    dataslots:
      - name: Input data files
        description: A single, or set of, .asc files output from the UDM model
        path: inputs/layers
        required: false
        default:
          - b4b0dd3b-460b-40ef-85a1-2d1cb0d04518
      - name: Population
        description: UK SSP population csv file
        path: inputs/population
        required: false
        default:
          - 620e12d7-9f0c-480b-a348-cbf747a52cbc
          - a7e1b8b7-923c-43ee-a0c3-2565571a81ae
      - name: Population ratios
        description: Population ratios for four age bands (0-64, 65-74, 75-84, 85) based on the UK SSPs per LAD, year and SSP
        path: inputs/population_ratios
        required: false
        default:
          - 1f87a5da-125e-4128-9b54-23cd3670a1f7
      - name: Population baseline adjustment
        description: A raster containing population adjustment values
        path: inputs/population_adjustment
        required: false
        default:
          - 7e283881-b283-4c82-b473-0ac835b1da51
      - name: Zones
        description: A set of zones which match the SSP data, so Local Authority Areas, where the codes match those in the population and population ratios datasets
        path: inputs/zones
        required: false
        default:
          - 9433582f-22fa-420f-bdd8-c9c48ef7994a
      - name: Baseline housing data
        description: Baseline data for housing type counts across the UK
        path: inputs/base_house_types
        required: false
        default:
          - 21c4cd4b-7855-4efa-8e6c-41441c4c7452

  outputs:
    datasets:
      - name: outputs/*.asc
        type: folder
        description: path to processed data outputs