udm-setup/model-definition.yml at main · geospatialncl/udm-setup · 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
kind: M
api_version: v1beta2
metadata:
  display_name: UDM-Setup
  name: udm-setup
  summary: Accepts user inputs and data to structure inputs for UDM model
  publisher: Newcastle University
  description: >
    Final stage UDM pre-processing model that accepts user inputs and converts into a UDM expected input.
spec:
  inputs:
    parameters:
      - name: constraints
        title: Constraints
        description: Seperated string for UDM constraint layers. Name of layer and a treshold value (% of the cell covered which prevents the cell from being used). e.g greenbelt:0.5;sssi:20;
        type: string
        required: false
        default: 'None'

      - name: current_development
        title: Current development layer (constraint)
        type: string
        description: String for UDM current development layer, including threshold for % coverage at which cell is considered developed.
        default: 'None'
        required: true

      - name: attractors
        title: Attractors (for future development)
        type: string
        description: String for attractor layers, semi-colan separated. Include layer name, layer weight and polarity flag. e.g. roads:0.4:0;
        default: 'None'
        required: true

      - name: density_from_raster
        title: Density from raster
        type: integer
        description: Derive density from current development and initial population (set as 0) or provide a density raster (set as 1)
        default: 0
        required: true

      - name: people_per_dwelling
        title: People per dwelling
        type: number
        description: Conversion factor from people per cell to dwellings per cell
        default: 2.5
        required: true

      - name: coverage_threshold
        title: Coverage threshold
        type: number
        description: The threshold for percentage coverage for the combined constraint layers. All above threshold cannot be developed
        default: 50.0
        required: true

      - name: minimum_development_area
        title: Minimum development area
        type: number
        description: Minimum number of raster cells within a zone required for a development area
        default: 4
        required: true

      - name: maximum_plot_size
        title: Maximum plot size
        type: number
        description: Maximum number of cells developed around most suitable cell in zone in each iteration of development spreading algorithm
        default: 4
        required: true

      - name: extra_parameters
        title: Extra parameters or used options to record
        type: string
        description: Option to record any extra parameters to be associated with the UDM run. These aren't used by the UDM model but are recorded in the metadata. Entries should take the form "PARAMETER NAME:PARAMETER VALUE;PARAMETER NAME:PARAMETER VALUE"
        default: ""
        required: false

      - name: OUTPUT_TITLE
        title: Title for output
        type: string
        description: The title of the dataset when saved to DAFNI from UDM
        default: 'UDM output'
        required: true

      - name: OUTPUT_DESCRIPTION
        title: Description for output
        type: string
        description: Description for the output datset from UDM when saved on to DAFNI
        default: 'Results from a UDM model run'
        required: true

  outputs:
    datasets:
      - name: outputs/*
        type: folder
        description: path to processed data outputs
      - name: outputs/*
        type: Text
        description: log file