{
  "$schema": "http://json-schema.org/draft-07/schema",
  "$id": "https://github.com/hubverse-org/schemas/blob/main/v0.0.0.9/model-schema.json",
  "title": "ForecastHub model metadata",
  "description": "This is the schema of the model metadata file, please refer to https://github.com/epiforecasts/covid19-forecast-hub-europe/wiki/Metadata[an] for more information.",
  "type": "object",
  "properties": {
        "schema_version": {
            "type": "string",
            "format": "uri"
        },
    "team_name": {
      "description": "The name of the team submitting the model",
      "type": "string"
    },
    "team_abbr": {
      "description": "Abbreviated name of the team submitting the model",
      "type": "string",
      "pattern": "^[a-zA-Z0-9_+]+$",
      "maxLength": 16
    },
    "model_name": {
      "description": "The name of the model",
      "type": "string"
    },
    "model_abbr": {
      "description": "Abbreviated name of the model",
      "type": "string",
      "pattern": "^[a-zA-Z0-9_+]+$",
      "maxLength": 16
    },
    "model_version": {
      "description": "Identifier of the version of the model",
      "type": "string"
    },
    "model_contributors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "affiliation": {
            "type": "string"
          },
          "orcid": {
            "type": "string",
            "pattern": "^\\d{4}\\-\\d{4}\\-\\d{4}\\-[\\dX]{4}$"
          },
          "email": {
            "type": "string",
            "format": "email"
          },
          "twitter": {
            "type": "string"
          },
          "additionalProperties": false
        }
      }
    },
    "website_url": {
      "description": "Public facing website for the model",
      "type": "string",
      "format": "uri"
    },
    "repo_url": {
      "description": "Repository containing code for the model",
      "type": "string",
      "format": "uri"
    },
    "license": {
      "description": "License for use of model output data",
      "type": "string",
      "enum": [
        "apache-2.0",
        "cc-by-4.0",
        "cc-by-nc-4.0",
        "cc-by-nc-nd-4.0",
        "cc-by-sa-4.0",
        "gpl-3.0",
        "lgpl-3.0",
        "mit"
      ]
    },
    "include_viz": {
      "description": "Indicator for whether the model should be included in the Hub’s visualization",
      "type": "boolean"
    },
    "include_ensemble": {
      "description": "Indicator for whether the model should be included in the Hub’s ensemble",
      "type": "boolean"
    },
    "include_eval": {
      "description": "Indicator for whether the model should be scored for inclusion in the Hub’s evaluations",
      "type": "boolean"
    },
    "citation": {
      "type": "string"
    },
    "team_funding": {
      "type": "string"
    },
    "model_details": {
      "type": "object",
      "properties": {
        "data_inputs": {
          "type": "string"
        },
        "methods": {
          "type": "string",
          "maxLength": 200
        },
        "methods_long": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": ["data_inputs", "methods"]
    },
    "ensemble_of_hub_models": {
      "description": "Indicator for whether this model is an ensemble of other Hub models",
      "type": "boolean"
    },
    "modeling_NPI": {
      "type": "string"
    },
    "compliance_NPI": {
      "type": "string"
    },
    "contact_tracing": {
      "type": "string"
    },
    "testing": {
      "type": "string"
    },
    "vaccine_efficacy_transmission": {
      "type": "string"
    },
    "vaccine_efficacy_delay": {
      "type": "string"
    },
    "vaccine_hesitancy": {
      "type": "string"
    },
    "vaccine_immunity_duration": {
      "type": "string"
    },
    "natural_immunity_duration": {
      "type": "string"
    },
    "case_fatality_rate": {
      "type": "string"
    },
    "infection_fatality_rate": {
      "type": "string"
    },
    "asymptomatics": {
      "type": "string"
    },
    "age_groups": {
      "type": "string"
    },
    "importations": {
      "type": "string"
    },
    "confidence_interval_method": {
      "type": "string"
    },
    "calibration": {
      "type": "string"
    },
    "spatial_structure": {
      "type": "string[bc]"
    }
  },
  "additionalProperties": false,
  "required": [
    "schema_version",
    "team_name",
    "team_abbr",
    "model_name",
    "model_abbr",
    "model_contributors",
    "website_url",
    "license",
    "include_viz",
    "include_ensemble",
    "include_eval",
    "model_details"
  ]
}
