schema-data.yml

$schema: "http://json-schema.org/draft-07/schema"
title: ForecastHub model data
description: >
  This is the schema of the forecasts files, please refer to
  https://github.com/european-modelling-hubs/covid19-forecast-hub-europe/wiki/Forecast-format
  for more info.
type: object
properties:
  forecast_date:
    description: The date at which the forecasts were established and submitted
    type: array
    items:
      type: string
      format: date
  scenario_id:
    description: One of forecast or a specified scenario ID
    type: array
    items:
      type: string
      pattern: ^forecast$
  target:
    description: >
      '"# wk ahead inc hosp" or "# wk ahead inc case" or "# wk ahead inc death" where # is usually
      between -3 and 4'
    type: array
    items:
      type: string
      pattern: ^-?\d+ wk ahead inc (hosp|case|death)
  target_end_date:
    description: Date as YYYY-MM-DD, the last day (Saturday) of the target week
    type: array
    items:
      type: string
      format: date
  location:
    description: 'An ISO-2 country code'
    type: array
    items:
      type: string
      enum: ["AT", "BE", "BG", "CH", "CY", "CZ", "DK", "DE", "EE", "ES", "FI", "FR", "GB", "GR", "HR", "HU", "IE", "IS", "IT", "LI", "NO", "LT", "LU", "LV", "MT", "NL", "PL", "PT", "RO", "SE", "SI", "SK"]
  type:
    description: 'One of "point" or "quantile"'
    type: array
    items:
      type: string
      enum:
        - point
        - quantile
  quantile:
    type: array
    items:
      type: ["number", "null"]
  value:
    type: array
    items:
      type: integer
      minimum: 0
additionalProperties: false
required:
  - forecast_date
  - target
  - target_end_date
  - location
  - type
  - quantile
  - value