FIRM2/model-definition.yml at main · nclwater/FIRM2 · 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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
kind: M
api_version: v1beta3
metadata:
  display_name: Flood Infrastructure Resilience Model
  name: firm
  summary: Agent based model for flood incidents
  publisher: Newcastle University
  description: >
    FIRM is an agent-based model that simulates how people and organisations respond to the effects
    of flood infrastructure failure before, during, and after extreme weather events. The model can
    be used to assess different strategies to minimise threats to lives and infrastructure during a
    flood incident.
  contact_point_name: Richard Dawson
  contact_point_email: richard.dawson@newcastle.ac.uk
  source_code: https://github.com/nclwater/FIRM2
  licence: https://www.gnu.org/licenses/#AGPL
  rights: Please cite https://doi.org/10.1007/s11069-011-9745-4.
  subject: Environment
  project_name: FIRM2
  project_url: https://www.dafni.ac.uk/firm-coe/
  funding: https://www.dafni.ac.uk/centre-of-excellence/

spec:
  inputs:
    parameters:
      - name: TOROIDAL
        title: Toroidal wrap
        description: Specify whether the map wraps toroidally at the edges
        type: boolean
        default: false
        required: false
      - name: TICKS
        title: Ticks
        description: The number of timesteps to run
        type: integer
        default: 86400
        min: 1
        required: false
      - name: CELL_SIZE
        title: Cell size
        description: Map cell size in metres
        type: integer
        default: 3
        min: 1
        required: false
      - name: CHANCE
        title: Chance
        description: TODO Need description here
        type: number
        default: 50
        min: 0
        max: 100
        required: false
      - name: APPLICATION_TITLE
        title: Application title
        description: The title of the application
        type: string
        default: "FIRM2"
        required: false
      - name: INPUT_DATA
        title: Input data path
        description: The input data path
        type: string
        default: "/data/inputs/"
        required: false
      - name: OUTPUT_DATA
        title: Output data path
        description: The output data path
        type: string
        default: "/data/outputs/"
        required: false
      - name: TERRAIN_DATA
        title: Terrain data filename
        description: Name of the JSON filename containing terrain data
        type: string
        default: "terrain.json"
        required: false
      - name: ROADS_DATA
        title: Road data filename
        description: Name of the JSON filename containing road data
        type: string
        default: "BNG_roads.json"
        required: false
      - name: ROAD_TYPES
        title: Road types filename
        description: Name of the JSON filename containing road types
        type: string
        default: "road_types.json"
        required: false
      - name: BUILDINGS_DATA
        title: Building data filename
        description: Name of the JSON filename containing building data
        type: string
        default: "buildings.json"
        required: false
      - name: DEFENCES_DATA
        title: Sea defences data filename
        description: Name of the JSON filename containing sea defence data
        type: string
        default: "defences.json"
        required: false
      - name: MODEL_PARAMETERS
        title: Global parameters data filename
        description: Name of the JSON filename containing global parameter data
        type: string
        default: "globals.json"
        required: false
      - name: VEHICLES_DATA
        title: Vehicle data filename
        description: Name of the JSON filename containing vehicle data
        type: string
        default: "vehicles.json"
        required: false
      - name: TIMELINE
        title: Timeline data filename
        description: Name of the JSON filename containing the simulation filename
        type: string
        default: "timeline.json"
        required: false
      - name: VEHICLE_FLOOD_DEPTH
        title: Vehicle flood depth in metres
        description: Depth of water at which inundated vehicles will be immobilised
        type: number
        default: 0.025
        required: false
      - name: SLOWDOWN
        title: Slowdown
        description: TODO Need description here
        type: number
        default: 0
        min: 0
        required: false
      - name: TIME_STAMP
        title: Time stamp
        description: TODO Need description here
        type: integer
        default: 1704067200
        min: 0
        required: false
      - name: TICK_TIME_VALUE
        title: Tick time value
        description: Simulation interval in seconds
        type: integer
        default: 1
        min: 1
        required: false
      - name: OCEAN_DEPTH
        title: Ocean depth in metres
        description: Depth of the ocean in metres
        type: integer
        default: 4
        min: 0
        required: false
    dataslots:
      - name: Location Properties
        description: Geographic properties of the location at which the simulation takes place
        path: inputs
        default:
          - 67861bde-b188-4fc4-b0a1-364480ca5dff
        required: true
  outputs:
    datasets:
      - name: FIRM simulation results
        type: txt
        description: Model output