Preparing to submit

Before submitting your first forecast, please get in touch using the Issues. Let us know your team and for which targets and countries you are planning to forecast. We are looking forward to hearing from you!

The next step is to fork this repository, go to the data-processed directory, and create a new sub-directory for your team.

Creating a team directory

Each team should name their own data-processed sub-directory in the format:

data-processed/team-model

Where team is the team name and model is the name of your model. Both team and model should be less than 15 characters and not include hyphens. If submitting multiple models, please create a team-model folder for each.

Each sub-directory should contain:

• Metadata file
• License file (optional)
• Forecasts

Metadata

Participating teams must provide a metadata file (see template), including some information about the team and methods. The metadata file should be named similarly to your sub-directory:

metadata-team-model.txt

License (optional)

We encourage you to include a license file. Please use the following format:

LICENSE-team.txt

Links to some commonly used licenses can be found here.

Forecasts

The team-model directory is where you will store and submit all your forecasts. When you have prepared a forecast in line with submission guidelines, please submit files via a pull request. This will also trigger our validation scripts to check the data format. We provide a step-by-step explanation on how to do this, using only the user interface of the GitHub website and a shorter explanation for more experienced GitHub users.