Skip to content

Commit ce5a3eb

Browse files
committed
update documentation
1 parent fc40863 commit ce5a3eb

1 file changed

Lines changed: 41 additions & 7 deletions

File tree

model-output/README.md

Lines changed: 41 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -439,17 +439,51 @@ that row.
439439

440440
---
441441

442-
## Scenario validation
442+
## Model outout validation
443443

444444
To ensure proper data formatting, pull requests for new data or updates in
445-
data-processed/ will be automatically validated.
445+
`model-output/` and `model-metadata/` are automatically validated.
446446

447447
### Pull request scenario validation
448448

449-
When a pull request is submitted, the data are automatically validated.
450-
The intent for these tests are to validate the requirements above and
451-
all checks are specifically enumerated
452-
[on the wiki](https://github.com/midas-network/covid19-scenario-modeling-hub/wiki/Scenario-File-Checks).
453-
Please [let us know](https://github.com/midas-network/covid19-scenario-modeling-hub/issues) if
449+
When a pull request is submitted, the data are automatically validated.
450+
The intent for these tests are to validate the requirements above and
451+
all checks are specifically enumerated on the
452+
[SMH website](https://scenariomodelinghub.org/documentation/validation.html).
453+
454+
Please
455+
[let us know](https://github.com/midas-network/covid19-scenario-modeling-hub/issues) if
454456
the wiki is inaccurate.
455457

458+
### Workflow
459+
460+
When a pull request is submitted, the validation will be
461+
automatically triggered.
462+
463+
- If the pull request (PR) contains update abstract file(s):
464+
- These files are manually validated, the automatic validation
465+
will only returns a message indicating it did not run any
466+
validation.
467+
468+
- If the PR contains model output and/or model metadata submission file(s).
469+
The validation automatically runs and output a message.
470+
471+
- The validation has 3 possible output:
472+
- "Error" (red cross): the validation has failled and returned a message
473+
indicating the error(s). The error(s) should be fixed to have the PR
474+
accepted
475+
- "Warning" (red !): the PR can be accepted. However, it is
476+
necessary for the submitting team to validate if the warning(s) is
477+
expected or not before merging the PR.
478+
- "Success" (green check): the validation did not found any issue and
479+
returns a message indicating that the validation is a success
480+
481+
If any issues or questions on a PR, please feel free to send them in the PR via
482+
comments.
483+
484+
#### Run checks locally
485+
486+
To run these checks locally rather than waiting for the results from a pull
487+
request, the package
488+
[SMHvalidation](https://github.com/midas-network/SMHvalidation) contains
489+
multiple documentation and vignettes.

0 commit comments

Comments
 (0)