global-flood-impact-inputs/model-definition.yml at main · OpenCLIM/global-flood-impact-inputs · 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
kind: M
api_version: v1beta3
metadata:
  display_name: Global Urban_Flooding:Data Inputs
  contact_point_name: Olivia Butters
  contact_point_email: olivia.butters@newcastle.ac.uk
  name: global-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: COUNTRY
        title: Country
        type: string
        description: The country where the urban area is located.
        default: England
        required: true

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

      - name: PROJECTION
        title: Projection
        type: number
        description:
          Input the numerical code for the required projection (e.g. 27700).
          Use a projection that uses meters not decimal degrees.
          If left blank the model will apply the appropriate Universal Transverse Mercator (UTM) Coordinate System.
        default: 0
        required: False

    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: UTM Zones
        description:
          A .gpkg file containing global UTM codes.
        default:
          - 28ee1963-6a2d-4c24-b380-8a874e0e4c51
        path: inputs/utm_zones/
        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.