vector-mesh/model-definition.yml at main · OpenCLIM/vector-mesh · 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
kind: M
api_version: v1beta3
metadata:
  display_name: Urban_Flooding:Extract Buildings
  contact_point_name: Olivia Butters
  contact_point_email: olivia.butters@newcastle.ac.uk
  name: vector-mesh
  publisher: Newcastle University
  summary: >
    This model takes national scale datasets and clips them to a geographical area.
  source_code: https://github.com/OpenCLIM/vector-mesh
  description: >
    National scale datasets are too large to upload onto DAFNI, and processing these large datasets is time extensive. Models such as City Catchment Analysis Tool,
    require vector data from the national datasets for a city of interest. The national data sets have been uploaded onto DAFNI in zip format for each 100km OS grid cell.
    Geopackage files within the zip folders contain the vector data per 5km OS grid cell. This model identifies which 5km grid cells are contained within the boundary
    file for the city of interest, and merges the geopackage to generate a single gpkg file for the city.

spec:
  inputs:
    dataslots:
      - name: Boundary File
        description:
          A .gpkg or .shp file containing the boundary of the location of interest.
        path: inputs/boundary/
        required: false

      - name: Grids
        description:
          The 5km OS grid cells for the UK.
        default:
          - 7358511d-76ec-484b-8996-66af6e6ea8de
        path: inputs/grids/
        required: false

      - name: Vectors
        description:
          National vector datasets (saved by OS grid cells).
        default:
          - 0eed4eb0-9795-414d-9008-939b8ebf8821
          - 4da2cddf-f626-40f5-959d-a16e57ffe806
          - df89bca6-13f7-49c3-b373-72787eb52622
          - 8164524d-d9fc-4b2d-9388-43a222d6ac3c
          - 1fe727df-13e2-45ee-9ec7-c6e9f8dbbe3c
        path: inputs/vectors/
        required: false


  outputs:
    datasets:
      - name: outputs/buildings/*
        type: folder
        description:
          A gpgk of existing building data for the city of interest.