forked from OpenCLIM/citycat-dafni
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmodel-definition.yml
298 lines (274 loc) · 12.5 KB
/
model-definition.yml
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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
kind: Model
api_version: v1beta1
metadata:
display_name: CityCAT (OpenCLIM)
name: citycat-openclim
publisher: Newcastle University
summary: CityCAT is a tool for modelling, analysis and visualisation of surface water flooding.
source_code: https://github.com/OpenCLIM/citycat-dafni
description: >
CityCAT (City Catchment Analysis Tool) is a unique software tool for modelling, analysis and visualisation of surface water flooding.
CityCAT enables rapid assessment of combined pluvial and fluvial flood risk and allows assessment of the effects of different flood alleviation measures.
This DAFNI model generates input data for CityCAT, runs a simulation and then converts the output data.
All input data is assumed to be projected in [OSGB 1936](https://epsg.io/27700).
The domain is generated either using a boundary polygon or a combination of centroid location and size.
A rainfall total can either be specified directly or extracted from FUTURE-DRAINAGE based on a return period, duration and time horizon.
The storm profile is generated using the FEH summer profile.
The effects of buildings, green areas and inflow boundary conditions can be included.
Results are provided in a range of formats and a metadata JSON file is created which can be used to create DAFNI datasets.
spec:
inputs:
parameters:
- name: NAME
title: Run name
type: string
description: Name for the run, used in the title field of the metadata file.
default: CityCAT Output
required: true
- name: RAINFALL_MODE
title: Rainfall mode
type: string
description:
If `RAINFALL_MODE` is set to "return_period" then the rainfall depth corresponding to the `DURATION` and `RETURN_PERIOD` are extracted from the relevant CSV file in the `future-drainage` dataslot.
If the `TIME_HORIZON` is anything other than "baseline", the rainfall depth is then uplifted by the percentage given in the CSV file.
If `RAINFALL_MODE` is set to "total_depth" then the `TOTAL_DEPTH` parameter is used to define the amount of rainfall and the `RETURN_PERIOD` and `TIME_HORIZON` parameters are ignored.
The rainfall depth value, either directly provided or extracted from FUTURE-DRAINAGE, is used to generate a storm profile in combination with the summer profile and `DURATION` parameter.
default: return_period
required: true
options:
- name: return_period
title: Return Periods
- name: total_depth
title: Total depth
- name: RETURN_PERIOD
title: Return Period (years)
description:
The return period of the rainfall event.
This parameter is only used if `RAINFALL_MODE` is set to "return_period".
If this is provided, then data must be present in the `future-drainage` dataslot.
This return period is used to extract a rainfall depth from the FUTURE-DRAINAGE dataset and select the percentage uplift if required.
type: string
default: '100'
required: false
options:
- name: '2'
title: '2'
- name: '5'
title: '5'
- name: '10'
title: '10'
- name: '25'
title: '25'
- name: '30'
title: '30'
- name: '100'
title: '100'
- name: TOTAL_DEPTH
title: Total depth (mm)
description:
The total depth of rainfall during the event.
This parameter is only used if `RAINFALL_MODE` is set to "total_depth".
type: number
default: 40
required: false
min: 10
max: 100
- name: DURATION
title: Duration (hours)
description:
The duration of the rainfall event.
This value is used in combination with the rainfall depth and summer profile to generate a storm profile.
If `RAINFALL_MODE` is "return_period", this value is also used to extract a rainfall depth from FUTURE-DRAINAGE.
Only specific values are available as there is a limited number of durations within FUTURE-DRAINAGE.
type: string
default: '1'
required: true
options:
- name: '1'
title: '1'
- name: '3'
title: '3'
- name: '6'
title: '6'
- name: '12'
title: '12'
- name: '24'
title: '24'
- name: POST_EVENT_DURATION
title: Post-event Duration (hours)
description:
The duration of the dry period following the rainfall event.
After the rainfall event ends, CityCAT will continue to run for this period of time.
This is to allow water to continue propogating and accumulating on the floodplain.
type: number
required: true
default: 0
min: 0
max: 10
- name: SIZE
title: Domain Size (km)
description:
The width and height of the domain to create, centered at the location specified by `X` and `Y`.
This value is only used if no data is available in the `boundary` dataslot.
type: number
default: 6
required: true
min: 0.1
max: 10000
- name: OUTPUT_INTERVAL
title: Output Interval (seconds)
description:
Time between depth and velocity outputs (s).
Decreasing this value will lead to a higher number of output files.
type: integer
default: 600
required: true
- name: X
title: Domain Centroid X (OSGB)
description:
The X coordinate of the domain centroid in OSGB.
This value is only used if no data is available in the `boundary` dataslot.
type: integer
default: 258722
required: true
- name: Y
title: Domain Centroid Y (OSGB)
description:
The Y coordinate of the domain centroid in OSGB.
This value is only used if no data is available in the `boundary` dataslot.
type: integer
default: 665028
required: true
- name: OPEN_BOUNDARIES
title: Open Boundaries
description:
If `OPEN_BOUNDARIES` is "True", water will be allowed to leave the domain at the edges.
If it is "False", water will bounce back from the edges of the domain and cannot leave.
type: boolean
default: True
required: true
- name: PERMEABLE_AREAS
title: Permeable areas
type: string
description:
If `PERMEABLE_AREAS` is set to "polygons", polygons from the `green_areas` dataslot are used to define areas which are permeable.
Otherwise, all cells are treated as being "permeable" or "impermeable", depending on the selection.
default: polygons
required: true
options:
- name: polygons
title: Polygons
- name: permeable
title: Permeable
- name: impermeable
title: Impermeable
- name: ROOF_STORAGE
title: Roof storage
description:
Depth of water that can be stored on rooftops (m).
This value is uniformly applied to all buildings.
type: number
default: 0
required: true
min: 0
max: 10
- name: TIME_HORIZON
title: Time horizon
description:
The time horizon to use when selecting rainfall uplifts, baseline indicates no uplift.
This is used in combination with the `RETURN_PERIOD` and `DURATION` to select a rainfall depth from FUTURE-DRAINAGE.
type: string
default: '2070'
required: false
options:
- name: '2070'
title: '2070'
- name: '2050'
title: '2050'
- name: baseline
title: baseline
- name: DISCHARGE
title: Discharge (m3/s)
description:
Value of discharge boundary condition, if provided then the `flow_polygons` dataslot is required.
Discharge is distributed uniformly over the `DURATION` and gets multiplied by the number of cell boundaries intersected by the polygons in the `flow_polygons` dataslot.
Therefore, it is normally advisable to divide the total desired discharge by the number of overlapping cell boundaries.
type: number
default: 0
required: true
min: 0
max: 1000
dataslots:
- name: Digital Elevation Model
description:
A DEM must be provided in ASCII raster format, within a single file or as multiple tiles.
The default DEM dataset is OS Terrain 5, a corrected digital surface model of the UK with 5m resolution.
The dataset was created using a combination of photogrammetry and topographic survey and is updated regularly.
This data is licenced for research only.
default:
- 859e810c-4597-44b6-8d92-a9f00e45dcbd
path: inputs/dem
required: true
- name: Boundary
description:
A polygon can be provided to define the domain in GeoPackage or Shapefile format.
If this is provided, the X, Y and SIZE parameters will be ignored.
path: inputs/boundary
required: false
- name: Future Drainage
description:
Rainfall depths for a range of return periods, durations and time periods are provided by (FUTURE-DRAINAGE)[https://artefacts.ceda.ac.uk/badc_datadocs/future-drainage/FUTURE_DRAINAGE_Guidance_for_applying_rainfall_uplifts.pdf].
The estimates are based on 2.2 km hourly precipitation data from UKCP18 for RCP 8.5.
Baseline rainfall depths are provided describing the period 1981-2000 in the ReturnLevel.<year> field.
Percentage uplifts are available for two future horizons, 2050 and 2070.
The values are provided for points on a 5km grid covering the UK.
default:
- 0f7733d1-f6f3-44c4-b27e-9eecf6773e34
path: inputs/future-drainage
required: false
- name: Buildings
description:
Buildings can be provided as polygons in GeoPackage or Shapefile format.
Cells which fall within buildings are removed from the domain.
Water is prevented from flowing into these removed areas using closed cell boundary conditions.
By default, OS MasterMap is used to represent buildings.
MasterMap is the most detailed and up-to-date view of Britain’s landscape.
This data is licenced for research only.
Optionally, future buildings generated by UDM can be provided and combined with the buildings from OS MasterMap.
Cells within building polygons are removed from the domain.
default:
- 7f0344d8-079c-41ce-828e-9caadc431628
path: inputs/buildings
required: false
- name: Green areas
description:
Green areas can be provided as polygons in GeoPackage or Shapefile format.
Infiltration is allowed at cells within green areas polygons.
By default, OS MasterMap is used to represent green spaces.
If `PERMEABLE_AREAS` is set to anything other than "polygons", this data is not used.
default:
- 22601187-67c5-4cbd-927f-0d5d38fe9dbe
path: inputs/green_areas
required: false
- name: Flow Polygons
description:
Optionally, discharge can be provided as an input parameter and used as a boundary condition.
If discharge is provided, then a file containing a polygon that overlaps with domain cell boundaries is required.
Discharge is routed onto the domain at these overlapping cell boundaries.
The discharge is distributed uniformly over the specified duration and gets multiplied by the number of cells boundaries intersected.
path: inputs/flow_polygons
required: false
outputs:
datasets:
- name: outputs/run/**/*
type: folder
description:
The CityCAT model outputs four GeoTIFF files describing maximum depth, maximum depth with gaps interpolated, maximum velocity and maximum velocity-depth product.
The maximum depth is also plotted in a PNG file (Figure 1).
The depths and velocities from all timesteps are stored in a netCDF file and archived to a ZIP file.
- name: outputs/run/metadata.json
type: JSON
description:
NID metadata for outputs.
This file can be used for creating datasets on DAFNI.
All active parameters are included in this file.