flood-impact-maps/model-definition.yml at main · OpenCLIM/flood-impact-maps · 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
kind: M
api_version: v1beta3
metadata:
  display_name: Urban_Flooding:Flood Impact Maps
  name: flood-impact-maps
  contact_point_name: Olivia Butters
  contact_point_email: olivia.butters@newcastle.ac.uk
  publisher: Newcastle University
  summary: >
    Visualisation of flood impacts for different scenarios
  source_code: https://github.com/OpenCLIM/flood-impact-maps
  description: >
    This model can be appended onto the end of the flood impact assessment model, or work on its own.
    If standalone, the user can add 1,2 or 4 output files generated by the Urban_Flooding: Flood Impact Assessment model.
    Taking the 1km damages, and flooded building data, this model creates georeferenced maps of the data which can be cross compared
    for different scenarios/ rainfall events.

spec:
  inputs:
    parameters:
      - name: LOCATION
        title: Location
        type: string
        description: The city/location of interest.
        required: false

    dataslots:
      - name: Boundary
        description:
          This file should be in gpkg or shp format and should define the city bounds.
        path: inputs/boundary
        required: false

      - name: Parameters
        description:
          A list of parameters in csv format generated by the user input model.
        path: inputs/parameters
        required: false

      - name: OS Grid Selection
        description:
          A single geopackage containing each OS British National 5km Grid cell.
          The coordinate reference system is British National Grid (ESPG:27700)
        default:
          - 0c6275e1-1557-4b5a-9548-7c6c87309368
        path: inputs/grid
        required: true

      - name: Impact Assessment Output
        description:
          All the output data generated by the flood impact assessment model.
          1,2 or 4 csv files with the following naming structure - 1km_data_location_ssp_year_depth.csv
          The file should contain data for each 1km os grid cell.
        path: inputs
        required: false

  outputs:
    datasets:
      - name: outputs/data/
        type: folder
        description: path to model outputs