storm-event-curve/model-definition.yml at main · OpenCLIM/storm-event-curve · 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
kind: M
api_version: v1beta3
metadata:
  display_name: Storm Event Curve
  contact_point_name: Olivia Butters
  contact_point_email: olivia.butters@newcastle.ac.uk
  name: rainfall-curve
  publisher: Newcastle University
  summary: >
    This model generates a text file to be used as an input to the City Cat model detailing the storm event.
  source_code: https://github.com/OpenCLIM/storm-event-curve
  description: >
    This model takes the unit profile of a storm event and adapts it to reflect an event based on storm duration and the total depth of rainfall.
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: Storm Profile
        required: true

      - name: TOTAL_DEPTH
        title: Total depth (mm)
        description:
          The total depth of rainfall during the event.
        type: number
        default: 40
        required: false
        min: 10
        max: 100

      - name: DURATION
        title: Duration (hours)
        description:
          The duration of the rainfall event.
        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'

    dataslots:
      - name: Parameters
        description:
          All input parameters and their values are stored in a csv file.
        path: inputs/parameters/
        required: false

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

      - name: outputs/parameters/*
        type: folder
        description:
          All parameters and their values are stored in a csv file.