Metadata: variables

Variables which are available for display SWE station points on the map user interface component.

• Variables definition file MUST be named variables.json.
• Variables definition file MUST be in compliance with the schema.
• Variables definition file MUST be ingested by copying static/snow-water-equivalent/variables.json from this repository, as this source-controlled file is the source of truth.

Schema

{
  "$defs": {
    "SweVariable": {
      "additionalProperties": false,
      "description": "A unique SWE variable.",
      "properties": {
        "longName": {
          "title": "Longname",
          "type": "string"
        },
        "helpText": {
          "title": "Helptext",
          "type": "string"
        },
        "labelMapLegend": {
          "title": "Labelmaplegend",
          "type": "string"
        },
        "valuePrecision": {
          "title": "Valueprecision",
          "type": "integer"
        },
        "valueRange": {
          "description": "The range of values this variable can realistically have",
          "maxItems": 2,
          "minItems": 2,
          "prefixItems": [
            {
              "type": "integer"
            },
            {
              "type": "integer"
            }
          ],
          "title": "Valuerange",
          "type": "array"
        },
        "colormapValueRange": {
          "description": "The range of values the colormap covers",
          "maxItems": 2,
          "minItems": 2,
          "prefixItems": [
            {
              "type": "integer"
            },
            {
              "type": "integer"
            }
          ],
          "title": "Colormapvaluerange",
          "type": "array"
        },
        "noDataValue": {
          "title": "Nodatavalue",
          "type": "integer"
        },
        "colormapId": {
          "title": "Colormapid",
          "type": "integer"
        },
        "transparentZero": {
          "title": "Transparentzero",
          "type": "boolean"
        },
        "unit": {
          "title": "Unit",
          "type": "string"
        }
      },
      "required": [
        "longName",
        "helpText",
        "labelMapLegend",
        "valuePrecision",
        "valueRange",
        "colormapValueRange",
        "noDataValue",
        "colormapId",
        "transparentZero",
        "unit"
      ],
      "title": "SweVariable",
      "type": "object"
    }
  },
  "description": "Mapping of satellite variable unique IDs to properties.",
  "patternProperties": {
    "^.+$": {
      "$ref": "#/$defs/SweVariable"
    }
  },
  "title": "SweVariablesIndex",
  "type": "object"
}

Example

../static/snow-water-equivalent/variables.json

{
  "swe_inches": {
    "longName": "Snow Water Equivalent",
    "labelMapLegend": "Snow Water Equivalent (inches)",
    "helpText": "",
    "valuePrecision": 0,
    "colormapId": 3,
    "transparentZero": false,
    "noDataValue": 255,
    "valueRange": [
      0,
      100
    ],
    "colormapValueRange": [
      0,
      50
    ],
    "unit": "cm"
  },
  "swe_delta_inches": {
    "longName": "Change in Snow Water Equivalent",
    "labelMapLegend": "Change in SWE (inches) in past 24 hours",
    "helpText": "",
    "valuePrecision": 0,
    "colormapId": 7,
    "transparentZero": false,
    "noDataValue": 255,
    "valueRange": [
      -4,
      4
    ],
    "colormapValueRange": [
      -2,
      2
    ],
    "unit": "cm"
  },
  "swe_normalized_pct": {
    "longName": "Percentage of Median Snow Water Equivalent",
    "labelMapLegend": "Percentage of Median Snow Water Equivalent (%)",
    "helpText": "",
    "valuePrecision": 0,
    "colormapId": 7,
    "transparentZero": false,
    "noDataValue": 255,
    "valueRange": [
      0,
      200
    ],
    "colormapValueRange": [
      45,
      155
    ],
    "unit": "%"
  }
}