add abstract with documentation

README.md

@@ -40,7 +40,8 @@ submitted at the same time to the [model-metadata/](./model-metadata/) folder
 of this GitHub repository. 
 Technical instructions for submission and required file formats can be found 
 [here](./model-output/README.md), 
-[here, for the metadata file](./model_metadata/README.md).
+[here, for the metadata file](./model_metadata/README.md), and
+[here, for the abstract file](./model-abtract/README.md)
 
 ## Disparities Round
 

model-abstract/README.md

@@ -0,0 +1,74 @@
+# Model Abstract
+
+This folder contains abstract files per round for team-models submitting to the 
+Scenario Modeling Hub. 
+
+----
+
+## Subdirectory
+
+Each sub-directory within the [model-abstract/](./) directory has the
+format:
+
+    team-model
+
+where 
+
+- `team` is the abbraviated teamname (`team_abbr`) and 
+- `model` is the abbreviated name of your model (`model_abbr`). 
+
+Both team and model should be less than 15 characters, and not include
+hyphens nor spaces.
+
+The `team-model` should correspond to the `team-model` sub-directory in the
+associated model-output folder containing the associated projections. 
+
+----
+
+## Template
+
+Each abstract is associated with a specific round. A template of 
+the expected abstract format is available in the 
+[template/](./template/) folder, with the `round_id` name as the
+name of the file. 
+
+|Round Name|Round ID (Filename Date)|
+|:---|:---|
+|Round 1 - Phase I |2024-06-25|
+
+## Abstract file 
+
+Each abstract file within the subdirectory should have the following 
+name
+
+    YYYY-MM-DD-team-model.md
+
+where
+
+- `YYYY` is the 4 digit year,
+- `MM` is the 2 digit month,
+- `DD` is the 2 digit day,
+- `team` is the teamname, and
+- `model` is the name of your model.
+
+The date YYYY-MM-DD should correspond to the round ID.
+For example for the round 1 - Phase I of the disparity round,
+it corresponds to the round **due date**, "`2024-06-25`" from 
+"Phase 1 projections due: 2024-06-25" as noted in the scenario 
+description on the main 
+[README, Submission Information](https://github.com/midas-network/covid19-smh-research)).
+
+Please keep the sections (or headings), lines starting with `#`, as 
+they are in the templates and only change spaces marked with `FILL`.
+All markdown associated format is accepted, except the addition of other 
+sections (or headings).
+
+For more information on the markdown format, please consult the 
+(GitHub - Basic writing and formatting syntax help page)[https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax]
+
+### Examples
+
+The [model-abstract/](./) contains an example abstract file from 
+a `team2-modelb` team. The abstract file associated with the example
+is a copy of a template file, the example here is mainly design
+to illustrate the organization of the folder and the file naming system. 

model-abstract/team2-modelb/2024-06-25-team2-modelb.md

@@ -0,0 +1,44 @@
+## Summary of results given model assumptions? 
+FILL
+
+## Distribution of susceptibility at the start of the projection period? 
+FILL
+
+## Which disease datasets (serology, cases, cases with imputed race/ethnicity information provided by coordination team, hospitalizations, deaths) were used for calibration? 
+FILL
+
+## How were the transmission (P(infection)) and severity (P(death|infection) risks estimated across racial/ethnic groups? 
+FILL
+
+## How was the suppression of deaths handled in calibration? 
+FILL
+
+## Details about calibration of race/ethnicity showing zero deaths throughout the calibration period (e.g., Others in CA and Asian in NC)? 
+FILL
+
+## How was contact mixing between racial/ethnic groups characterized? Was a contact matrix (either population-level or setting-specific) used? If so, describe the process used to apply the contact matrix.)
+FILL
+
+## Was mobility data used throughout the calibration/projection period? 
+FILL
+
+## Besides transmission, severity risk and contact matrices, did any other parameters vary by race/ethnicity (e.g., case reporting, NPI compliance)? 
+FILL
+
+## How was the introduction of more transmissible variants modeled? 
+FILL
+
+## How were NPIs implemented? 
+FILL
+
+## What was assumed about immunity/protection following infection? 
+FILL
+
+## How was vaccination implemented? What was assumed about immunity/protection following vaccination? 
+FILL
+
+## Was age modeled in addition to race/ethnicity? Was there consideration for differences in the age structure across racial/ethnic populations? 
+FILL
+
+## Was there importation of cases (e.g. from another external state)? 
+FILL

model-abstract/template/2024-06-25.md

@@ -0,0 +1,44 @@
+## Summary of results given model assumptions? 
+FILL
+
+## Distribution of susceptibility at the start of the projection period? 
+FILL
+
+## Which disease datasets (serology, cases, cases with imputed race/ethnicity information provided by coordination team, hospitalizations, deaths) were used for calibration? 
+FILL
+
+## How were the transmission (P(infection)) and severity (P(death|infection) risks estimated across racial/ethnic groups? 
+FILL
+
+## How was the suppression of deaths handled in calibration? 
+FILL
+
+## Details about calibration of race/ethnicity showing zero deaths throughout the calibration period (e.g., Others in CA and Asian in NC)? 
+FILL
+
+## How was contact mixing between racial/ethnic groups characterized? Was a contact matrix (either population-level or setting-specific) used? If so, describe the process used to apply the contact matrix.)
+FILL
+
+## Was mobility data used throughout the calibration/projection period? 
+FILL
+
+## Besides transmission, severity risk and contact matrices, did any other parameters vary by race/ethnicity (e.g., case reporting, NPI compliance)? 
+FILL
+
+## How was the introduction of more transmissible variants modeled? 
+FILL
+
+## How were NPIs implemented? 
+FILL
+
+## What was assumed about immunity/protection following infection? 
+FILL
+
+## How was vaccination implemented? What was assumed about immunity/protection following vaccination? 
+FILL
+
+## Was age modeled in addition to race/ethnicity? Was there consideration for differences in the age structure across racial/ethnic populations? 
+FILL
+
+## Was there importation of cases (e.g. from another external state)? 
+FILL

model-output/README.md

@@ -96,7 +96,7 @@ For the disparities round, the date YYYY-MM-DD should correspond to the
 **due date**, for example: "`2024-06-25`" from 
 "Phase 1 projections due: 2024-06-25" as noted in the scenario 
 description on the main 
-[README, Submission Information](https://github.com/midas-network/rsv-scenario-modeling-hub)).
+[README, Submission Information](https://github.com/midas-network/covid19-smh-research)).
 
 The `team` and `model` in this file must match the `team` and `model` in the 
 directory this file is in. Both `team` and `model` should be less than 15