model-definition.yml

kind: M
api_version: v1beta3
metadata:
  display_name: Urban_Flooding:Data Inputs
  contact_point_name: Olivia Butters
  contact_point_email: olivia.butters@newcastle.ac.uk
  name: data-inputs
  publisher: Newcastle University
  summary: >
    This model takes all of the parameter/ input data from the user specifically for the urban flooding workflow. 
    This data is then propogated through the model, reducing user input. 
  source_code: https://github.com/OpenCLIM/flood-impact-inputs
  description: >
    All data/ choices made by the user are inputted at this stage of the model to reduce user error. 
    This process simplifies the user input methods.

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

      - name: YEAR
        title: Year
        type: number
        description: The year of interest (range 2030-2080).
        default: 2050
        required: true
        options:
          - name: 2020
            title: 2020
          - name: 2035
            title: 2035
          - name: 2050
            title: 2050
          - name: 2055
            title: 2055
          - name: 2065
            title: 2065
          - name: 2080
            title: 2080
          - name: 2085
            title: 2085

      - name: SSP
        title: SSP
        type: string
        description: The socio-economic pathway of interest.
        default: 'ssp1'
        required: true
        options:
          - name: 'baseline'
            title: 'baseline'
          - name: 'ssp1'
            title: 'ssp1'
          - name: 'ssp2'
            title: 'ssp2'
          - name: 'ssp3'
            title: 'ssp3'
          - name: 'ssp4'
            title: 'ssp4'
          - name: 'ssp5'
            title: 'ssp5'        

      - 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: total_depth
        required: true
        options:
          # - name: return_period
          #   title: Return Periods
          - name: total_depth
            title: Total depth

      - 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: 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: 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: 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: 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
        required: false
        default: 0.1
        min: 0.1
        max: 10000

      - 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
        required: false
        default: 0

      - 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
        required: false
        default: 0
    

    dataslots:
      - name: Boundary File
        description:
          A .gpkg or .shp file containing the boundary of the location of interest.
        default:
          - 09a6bbc0-8d2c-4e1b-a0d2-7f11833f20ea
        path: inputs/boundary/
        required: true
        
      - name: SSP Data Sets
        description:
          Zip files of the data for each SSP.
        default:
          - 7a0cd595-42a6-4546-8048-9e96dca621da
          - 86cca88b-8aa0-4443-88ed-4aa588a968a0
          - 973040d1-860b-4e67-8503-eca853009f06
          - 8bdf31a3-01f3-413f-a44d-2b58a4982588
          - b1fb23e0-a075-4af9-823a-bc7b4caefa26
          - 0604b086-78dc-4024-84ab-986b17af5aed
          - 47ce6479-0717-4e88-8699-8ecaf565725d
          - 7ddfe894-821b-4538-952a-2a0da6a1dca7
          - 2e8fb741-103e-416a-850e-00073f53fbeb
          - de01fbea-0fa7-4b0f-bade-f04cd882ff09
          - 22d29429-1e8d-4458-b094-b0273f82cb5b
          - abeec947-4914-4c91-a8bc-8f9e02cc6175
          - 97504c6c-1e57-4528-8d39-ff08017478f1
          - aed9f85f-0021-4500-a48d-5876a93e3582
          - 25086e53-6353-4ee3-80da-176ab3d6fdd0
          - f3d79b1e-9f79-4d13-b2f3-7a0a2e8b9587
          - ff8cde9c-efdb-4fd2-b457-0c6719a0b37f
          - b210bc42-77cd-45db-94b2-9759b88fbf5e
          - 55b94407-5109-4c1e-93f8-de32ec8bc25c
          - 44325037-0b44-446c-a7af-6b0d9d133a4b
          - 4ce57763-4b2c-4029-919c-552cd7af5c64
          - 53b09ca1-73c1-48a2-a681-c48741a5198b
          - 815b1c59-593d-4663-b1fe-270a1b29dc10
          - 361bdf68-c2e6-4f9b-a713-47801ffb6470
          - e900b291-57d2-472a-ac12-3590d9892544
          - ac8d91d2-1e58-47f3-9a12-89775130727d
          - 8af79264-09a2-4967-a7be-6e3d2d9653b5
          - 9be3599a-e068-4f0d-965b-c67f8004c716
          - 70a435b9-6013-4b70-b837-5fd3cdb993c8
          - 271b0341-0a9b-4bdf-8eed-c011ef6159aa
          - 40513a50-1455-4855-bc22-ab924a9823e2
          - c4bde1e5-3e0b-42f5-b554-ce595d0f0364
          - b3dcdc59-a7fc-49ac-8ce6-d76c8aad58d1
          - b390d307-b7c4-478b-a640-e0a8f2fd1f3d
          - 3d3feb87-849a-4942-9fe6-cdba50ca698c

        path: inputs/ssps/
        required: true
      
  outputs:
    datasets:
      - name: outputs/boundary/*
        type: folder
        description:
          The city boundary file is saved in gpkg form.
        
      - name: outputs/parameters/*
        type: folder
        description:
          All parameters and their values are stored in a csv file.
          
      - name: outputs/metadata/*
        type: folder
        description:
          NID metadata for outputs.
          These file can be used for creating datasets on DAFNI with the title defined by the parameters specified by the user.