Running Checks Locally

For Mac

1. Install Python3.x https://www.python.org/downloads/
2. Clone the repository git clone https://github.com/reichlab/covid19-forecast-hub.git
3. Add your files to data-processed/<model_abbr>
4. Run these commands for one-time setup from the root of this repository.

sudo easy_install pip
pip3 install --upgrade setuptools
pip3 install -r visualization/requirements.txt

Validate new forecast files

Validate new forecast files added by running this command at the root of the repository.
python3 code/validation/test-formatting.py

Force validating a single forecast file:

The previous command just runs a test on all files that have not been checked previously by the CI. If you're updating a single forecast, it will not run checks on that. To force validate a check on a particular forecast file, run the following command:

python3 code/validation/validate_single_forecast_file.py <forecast>

The <forecast> option should be a string. It can be specified with one of the following options:

• model_abbr:
  • Specifying this for <forecast> will run the forecast validation checks for all files with that model_abbr. Example: Specifying COVIDhub-ensemble will run validations for all forecast files by the COVIDhub-ensemble model.
• The path inside data-processed folder:
  • You can also specify a path to the forecast file within the data-processed folder. Example: data-processed/COVIDhub-ensemble/2020-04-13-COVIDhub-ensemble.csv. You can also omit the extension.