Skip to content

Commit

Permalink
Adding hub-config files
Browse files Browse the repository at this point in the history
  • Loading branch information
Chipdelmal committed Mar 26, 2024
1 parent 87f308b commit 5baffe2
Show file tree
Hide file tree
Showing 4 changed files with 210 additions and 0 deletions.
3 changes: 3 additions & 0 deletions hub-config/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Hub configuation files

This folder should contain configuration files for the Hub, following the recommended [Hub configuration files in our documentation](https://hubdocs.readthedocs.io/en/latest/user-guide/hub-config.html).
12 changes: 12 additions & 0 deletions hub-config/admin.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"schema_version": "https://raw.githubusercontent.com/Infectious-Disease-Modeling-Hubs/schemas/main/v2.0.1/admin-schema.json",
"name": "WNV California Forecasting Challenge 2024",
"maintainer": "California Department of Public Health",
"contact": {
"name": "Héctor M. Sánchez C.",
"email": "hector.sanchez-castellanos@cdph.ca.gov"
},
"repository_url": "https://github.com/Chipdelmal/WNVCA-2024",
"file_format": ["csv"],
"timezone": "US/Pacific"
}
129 changes: 129 additions & 0 deletions hub-config/model-metadata-schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Schema for Modeling Hub model metadata",
"description": "This is the schema for model metadata files, please refer to https://github.com/cdcepi/FluSight-forecast-hub/blob/main/model-metadata/README.md for more information.",
"type": "object",
"properties": {
"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"
},
"email": {
"type": "string",
"format": "email"
},
"orcid": {
"type": "string",
"pattern": "^\\d{4}\\-\\d{4}\\-\\d{4}\\-[\\dX]{4}$"
}
},
"additionalProperties": false,
"required": ["name", "affiliation", "email"]
}
},
"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": [
"CC0-1.0",
"CC-BY-4.0",
"CC-BY_SA-4.0",
"PPDL",
"ODC-by",
"ODbL",
"OGL-3.0"
]
},
"designated_model": {
"description": "Team-specified indicator for whether the model should be eligible for inclusion in a Hub ensemble and public visualization. A team may designate up to two models.",
"type": "boolean"
},
"citation": {
"description": "One or more citations for this model",
"type": "string",
"examples": ["Gibson GC , Reich NG , Sheldon D. Real-time mechanistic bayesian forecasts of Covid-19 mortality. medRxiv. 2020. https://doi.org/10.1101/2020.12.22.20248736"]
},
"team_funding": {
"description": "Any information about funding source for the team or members of the team.",
"type": "string",
"examples": ["National Institutes of General Medical Sciences (R01GM123456). The content is solely the responsibility of the authors and does not necessarily represent the official views of NIGMS."]
},
"data_inputs": {
"description": "List or description of data inputs used by the model",
"type": "string"
},
"methods": {
"description": "A brief (200 char.) description of the methods used by this model",
"type": "string",
"maxLength": 200
},
"methods_long": {
"description": "A full description of the methods used by this model. Among other details, this should include whether spatial correlation is considered and how the model accounts for uncertainty.",
"type": "string"
},
"ensemble_of_models": {
"description": "Indicator for whether this model is an ensemble of any separate component models",
"type": "boolean"
},
"ensemble_of_hub_models": {
"description": "Indicator for whether this model is an ensemble specifically of other models submitted to this Hub",
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"team_name",
"team_abbr",
"model_name",
"model_abbr",
"model_contributors",
"license",
"designated_model",
"data_inputs",
"methods",
"methods_long",
"ensemble_of_models",
"ensemble_of_hub_models"
]
}
66 changes: 66 additions & 0 deletions hub-config/tasks.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
{
"schema_version": "https://raw.githubusercontent.com/Infectious-Disease-Modeling-Hubs/schemas/main/v2.0.1/tasks-schema.json",
"rounds": [{
"round_id_from_variable": true,
"round_id": "origin_date",
"model_tasks": [{
"task_ids": {
"origin_date": {
"required": null,
"optional": [
"2024-04-30", "2024-05-31", "2024-06-30",
"2024-07-31", "2024-08-31", "2024-09-30"
]
},
"target_date": {
"required": null,
"optional": [
"2024-05-31", "2024-06-30", "2024-07-31",
"2024-08-31", "2024-09-30", "2024-10-31"
]
},
"target": {
"required": ["WNV cases"],
"optional": null
},
"location": {
"required": [
"Fresno", "Kern", "Los Angeles", "Merced",
"Orange", "Placer", "Riverside", "Sacramento",
"San Bernardino", "San Joaquin", "Solano",
"Stanislaus", "Tulare"
],
"optional": null
}
},
"output_type": {
"cdf": {
"output_type_id": {
"required": [0, 1, 2, 3, 4, 5, 6, 8, 10, 15, 200],
"optional": null
},
"value": {
"type": "double",
"minimum": 0,
"maximum": 1
}
}
},
"target_metadata": [{
"target_id": "WNV cases",
"target_name": "Monthly reported WNV cases aggregated at a county level.",
"target_units": "count",
"target_keys": {"target": ["WNV cases"]},
"target_type": "discrete",
"description": "Monthly reported WNV cases (including mild, fever, and neuro) aggregated at a county level for selected counties in California (per million county inhabitants).",
"time_unit": "month",
"is_step_ahead": true
}]
}],
"submissions_due": {
"relative_to": "origin_date",
"start": -15,
"end": 8
}
}
]}

0 comments on commit 5baffe2

Please sign in to comment.