core/variable-1.0.0¶

Schema that describes a variable.

Description

This class is a slight modification of the corresponding NetCDF datamodel item. (See https://www.unidata.ucar.edu/software/netcdf/docs/netcdf_data_model.html)

Outline

Schema Definitions Original Schema

Schema Definitions ¶

This type is an object with the following properties:

name
string Required
The variables name.

No length restriction
dimensions
array Required
An array that contains the dimension names in the correct order (outer to inner).

No length restriction
dtype
string Required
The arrays fundamental data type defined by a code of 3 characters (adapted from NumPy). For further information see: https://numpy.org/doc/stable/reference/arrays.interface.html#arrays-interface

No length restriction
data
tag:stsci.edu:asdf/core/ndarray-1.0.0 Required
An n-dimensional array that contains the data.
unit
string
Optional field describing the unit of the data as valid string representation.

No length restriction

Original Schema ¶

%YAML 1.1
---
$schema: "http://stsci.edu/schemas/yaml-schema/draft-01"
id: "http://weldx.bam.de/schemas/weldx/core/variable-1.0.0"
tag: "tag:weldx.bam.de:weldx/core/variable-1.0.0"

title: |
  Schema that describes a variable.
description: |
  This class is a slight modification of the corresponding NetCDF datamodel item.
  (See https://www.unidata.ucar.edu/software/netcdf/docs/netcdf_data_model.html)
type: object
properties:
  name:
    description: |
      The variables name.
    type: string
  dimensions:
    description: |
      An array that contains the dimension names in the correct order (outer to inner).
    type: array
  dtype:
    description: |
      The arrays fundamental data type defined by a code of 3 characters (adapted from NumPy). For further information
      see: https://numpy.org/doc/stable/reference/arrays.interface.html#arrays-interface
    type: string
  data:
    description: |
      An n-dimensional array that contains the data.
    $ref: tag:stsci.edu:asdf/core/ndarray-1.0.0
  unit:
    description: |
      Optional field describing the unit of the data as valid string representation.
    type: string

required: [name, dimensions, dtype, data]
propertyOrder: [name, dimensions, dtype, unit, data]
flowStyle: block
additionalProperties: false
...