YAML Validation SchemaΒΆ

cis_interface uses the schema below for validating the YAML specification files used to define integration networks. Users should not need to interact with the schema directly. Instead cis_interface provides a command line utility cisvalidate for using the schema to validate a provided list of YAML specification files defining a run.

  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
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
additionalProperties: false
definitions:
  comm:
    $id: '#comm'
    allOf:
    - additionalProperties: false
      dependencies:
        driver: [args]
      properties:
        args: {type: string}
        as_array: {default: false, type: boolean}
        commtype:
          default: default
          enum: [default, ipc, rmq, rmq_async, zmq]
          type: string
        datatype:
          default: {type: bytes}
          type: schema
        driver: {type: string}
        field_names:
          items: {type: string}
          type: array
        field_units:
          items: {type: string}
          type: array
        name: {type: string}
        recv_converter: {type: function}
        send_converter: {type: function}
      required: [name, commtype, datatype]
      type: object
    - anyOf:
      - properties:
          commtype:
            enum: [default]
        title: DefaultComm
      - properties:
          commtype:
            enum: [ipc]
        title: IPCComm
      - properties:
          commtype:
            enum: [rmq_async]
        title: RMQAsyncComm
      - properties:
          commtype:
            enum: [rmq]
        title: RMQComm
      - properties:
          commtype:
            enum: [zmq]
        title: ZMQComm
    description: Schema for comm components.
    title: comm
  connection:
    $id: '#connection'
    allOf:
    - additionalProperties: false
      dependencies:
        driver: [args]
      properties:
        args: {type: string}
        connection_type:
          enum: [file_input, file_output, input, output]
        driver: {type: string}
        inputs:
          items:
            anyOf:
            - {$ref: '#/definitions/comm'}
            - {$ref: '#/definitions/file'}
          minItems: 1
          type: array
        onexit: {type: string}
        outputs:
          items:
            anyOf:
            - {$ref: '#/definitions/comm'}
            - {$ref: '#/definitions/file'}
          minItems: 1
          type: array
        translator:
          items: {type: function}
          type: array
      required: [inputs, outputs]
      type: object
    - anyOf:
      - properties:
          connection_type:
            enum: [file_input]
        title: FileInputDriver
      - properties:
          connection_type:
            enum: [file_output]
        title: FileOutputDriver
      - properties:
          connection_type:
            enum: [input]
        title: InputDriver
      - properties:
          connection_type:
            enum: [output]
        title: OutputDriver
    description: Schema for connection components.
    title: connection
  file:
    $id: '#file'
    allOf:
    - additionalProperties: false
      dependencies:
        driver: [args]
      properties:
        append: {default: false, type: boolean}
        args: {type: string}
        as_array: {default: false, type: boolean}
        comment: {default: '# ', type: string}
        default_flow_style: &id006 {default: false, type: boolean}
        delimiter: &id001 {default: "\t", type: string}
        driver: {type: string}
        encoding: &id007 {default: utf-8, type: string}
        field_names:
          items: {type: string}
          type: array
        field_units:
          items: {type: string}
          type: array
        filetype:
          default: binary
          enum: [ascii, binary, json, map, mat, obj, pandas, pickle, ply, table, yaml]
          type: string
        format_str: &id002 {type: string}
        in_temp: {default: false, type: boolean}
        indent: &id004
          default: "\t"
          type: [string, int]
        is_series: {default: false, type: boolean}
        name: {type: string}
        newline: {default: '

            ', type: string}
        recv_converter: {type: function}
        send_converter: {type: function}
        sort_keys: &id005 {default: true, type: boolean}
        use_astropy: &id003 {default: false, type: boolean}
        wait_for_creation: {default: 0.0, type: float}
        working_dir: {type: string}
      required: [name, filetype, working_dir]
      type: object
    - anyOf:
      - properties:
          filetype:
            enum: [ascii]
        title: AsciiFileComm
      - properties:
          delimiter: *id001
          filetype:
            enum: [map]
        title: AsciiMapComm
      - properties:
          delimiter: {default: "\t", type: string}
          filetype:
            enum: [table]
          format_str: *id002
          use_astropy: *id003
        title: AsciiTableComm
      - properties:
          filetype:
            enum: [binary]
        title: FileComm
      - properties:
          filetype:
            enum: [json]
          indent: *id004
          sort_keys: *id005
        title: JSONFileComm
      - properties:
          filetype:
            enum: [mat]
        title: MatFileComm
      - properties:
          filetype:
            enum: [obj]
        title: ObjFileComm
      - properties:
          delimiter: {default: "\t", type: string}
          filetype:
            enum: [pandas]
          format_str: {type: string}
          use_astropy: {default: false, type: boolean}
        title: PandasFileComm
      - properties:
          filetype:
            enum: [pickle]
        title: PickleFileComm
      - properties:
          filetype:
            enum: [ply]
        title: PlyFileComm
      - properties:
          default_flow_style: *id006
          encoding: *id007
          filetype:
            enum: [yaml]
          indent:
            default: "\t"
            type: [string, int]
        title: YAMLFileComm
    description: Schema for file components.
    title: file
  model:
    $id: '#model'
    allOf:
    - additionalProperties: false
      dependencies:
        driver: [args]
      properties:
        args:
          items: {type: string}
          type: array
        builddir: {type: string}
        cc: &id008 {type: string}
        client_of:
          default: []
          items: {type: string}
          type: array
        cmakeargs:
          default: []
          items: {type: string}
          type: array
        driver: {type: string}
        inputs:
          default: []
          items: {$ref: '#/definitions/comm'}
          type: array
        is_server: {default: false, type: boolean}
        language:
          enum: [c, c++, cmake, cpp, executable, lpy, make, matlab, python]
          type: string
        make_command: &id010 {default: make, type: string}
        makedir: &id011 {type: string}
        makefile: &id012 {default: Makefile, type: string}
        name: {type: string}
        outputs:
          default: []
          items: {$ref: '#/definitions/comm'}
          type: array
        overwrite: &id009 {default: true, type: boolean}
        sourcedir: {type: string}
        strace_flags:
          default: []
          items: {type: string}
          type: array
        valgrind_flags:
          default: [--leak-check=full]
          items: {type: string}
          type: array
        with_strace: {default: false, type: boolean}
        with_valgrind: {default: false, type: boolean}
        working_dir: {type: string}
      required: [name, language, args, working_dir]
      type: object
    - anyOf:
      - properties:
          language:
            enum: [cmake]
        title: CMakeModelDriver
      - properties:
          cc: *id008
          language:
            enum: [c, c++, cpp]
          overwrite: *id009
        title: GCCModelDriver
      - properties:
          language:
            enum: [lpy]
        title: LPyModelDriver
      - properties:
          language:
            enum: [make]
          make_command: *id010
          makedir: *id011
          makefile: *id012
        title: MakeModelDriver
      - properties:
          language:
            enum: [matlab]
        title: MatlabModelDriver
      - properties:
          language:
            enum: [executable]
        title: ModelDriver
      - properties:
          language:
            enum: [python]
        title: PythonModelDriver
    description: Schema for model components.
    title: model
description: Schema for cis_interface YAML input files.
properties:
  models:
    items: {$ref: '#/definitions/model'}
    minItems: 1
    type: array
  connections:
    items: {$ref: '#/definitions/connection'}
    type: array
required: [models]
title: YAML Schema
type: object