Skip to content

Commit

Permalink
update file path for hub-config (past hub-metadata)
Browse files Browse the repository at this point in the history
  • Loading branch information
LucieContamin committed Apr 24, 2023
1 parent 75f3afe commit 9ff30f4
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/source/format/hub-config.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
(hub-metadata)=
(hub-config)=
# Hub configuration files

## Directory Structure
Expand Down
2 changes: 1 addition & 1 deletion docs/source/format/hub-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The directory and file structure of a modeling hub should contain only the follo
* Documentation files
* Hubs should provide a documentation file (e.g., `README.md`) at the top level that describes the overall structure of the hub, as well as a documentation file within each folder that provides more detail.

* `hub-metadata` directory (see {doc}`/format/hub-metadata`)
* `hub-config ` directory (see {doc}`/format/hub-config`)

* `model-output` directory (see {doc}`/format/model-output`)

Expand Down
4 changes: 2 additions & 2 deletions docs/source/format/intro-data-formats.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ On this page we provide an [outline on the contents of this data formats section
This section of the documentation provides standards for:

* [Structure of hub repositories](hub-structure): standards for file and directory structures for Hubs
* [Hub configuration files](hub-metadata): the files needed to set up and run a modeling Hub
* [Hub configuration files](hub-config): the files needed to set up and run a modeling Hub
* [Model metadata](model-metadata): metadata describing models
* [Model output](model-output): standard formats for model output such as forecasts and projections that are saved in Hubs
* [Target data](target-data): standard formats for target data, the eventually observable quantities of interest to a hub
Expand Down Expand Up @@ -118,4 +118,4 @@ As Hubs define new modeling tasks, they may need to introduce new task ID variab

(submission-rounds)=
## Submission rounds
Many Hubs will accept model output submissions over multiple rounds. In the case of the forecast hubs there has typically been one submission round per week, while the scenario hubs have had submission rounds less frequently, typically about once per month. As part of the [Hub metadata](hub-metadata), Hubs should specify a set of `round_id` values that uniquely identify the submission round. For instance, for weekly submissions the round id might be the date that submissions are due to the Hub or a specification of an epidemic week. In instances where the rounds do not follow a predetermined schedule, more generic identifiers such as “round1” may be preferred. The round id will be used as the file names of model output submissions and round-specific model abstract submissions, as well as in the Hub metadata to specify model tasks that may vary across rounds.
Many Hubs will accept model output submissions over multiple rounds. In the case of the forecast hubs there has typically been one submission round per week, while the scenario hubs have had submission rounds less frequently, typically about once per month. As part of the [Hub configuration files](hub-config), Hubs should specify a set of `round_id` values that uniquely identify the submission round. For instance, for weekly submissions the round id might be the date that submissions are due to the Hub or a specification of an epidemic week. In instances where the rounds do not follow a predetermined schedule, more generic identifiers such as “round1” may be preferred. The round id will be used as the file names of model output submissions and round-specific model abstract submissions, as well as in the Hub metadata to specify model tasks that may vary across rounds.
4 changes: 2 additions & 2 deletions docs/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ We have created some [example Hub repositories](https://github.com/Infectious-Di

### Schema files for hub configuration

To take advantage of the infrastructure designed by the Consortium, a hub must contain JSON configuration files in a [specific location and format](hub-metadata). The schemas that define the structure and formats of the configuration files live in their own [schemas repository](https://github.com/Infectious-Disease-Modeling-Hubs/schemas). The schemas are versioned, and every hub must point to a specific version of the schemas that they are using.
To take advantage of the infrastructure designed by the Consortium, a hub must contain JSON configuration files in a [specific location and format](hub-config). The schemas that define the structure and formats of the configuration files live in their own [schemas repository](https://github.com/Infectious-Disease-Modeling-Hubs/schemas). The schemas are versioned, and every hub must point to a specific version of the schemas that they are using.

## Software for modeling hubs

Expand Down Expand Up @@ -56,7 +56,7 @@ overview/definitions.md
:hidden:
format/intro-data-formats.md
format/hub-structure.md
format/hub-metadata.md
format/hub-config.md
format/model-metadata.md
format/model-output.md
format/target-data.md
Expand Down

0 comments on commit 9ff30f4

Please sign in to comment.