-
Notifications
You must be signed in to change notification settings - Fork 12
Preparing to submit
Below we explain the steps needed to submit your first scenario projections to this hub.
We rely on GitHub to store and interact with projections. To submit projections, you will need a free GitHub account.
Broadly, the steps to submit are:
-
Fork this repository (called
RespiCompass
)- Use the
Fork
button at the top right of the main page of the repository - (optional) In case you want to use the CLI and keep your fork synchronized with the main repository, configure a remote and sync your fork
- Use the
-
Create a metadata file, including information about the team and methods. The metadata file should be placed in the folder
model-metadata
and named:team-model.yml
Where:
-
team
is the team name (corresponding to the fieldteam_abbr
of the metadata file, see below) -
model
is the name of your model (corresponding to the fieldmodel_abbr
of the metadata file, see below)
Both
team
andmodel
must be less than 15 characters and can include only uppercase or lowercase letters, digits, the_
and the+
sign. -
-
Create a new sub-directory for your team. Each team stores their projections in a separate folder within the
model-output
folder of this repository. Before submitting your first projection, please create and name your own folder in the format:team-model
Where:
-
team
is the team name (corresponding to the fieldteam_abbr
of the metadata file, see below) -
model
is the name of your model (corresponding to the fieldmodel_abbr
of the metadata file, see below)
Both
team
andmodel
must be less than 15 characters and can include only uppercase or lowercase letters, digits, the_
and the+
sign. If submitting multiple models, please create ateam-model
folder for each one. -
-
Submit metadata and/or projections by creating a pull request
It is possible to submit the projections in two different ways, depending on personal preferences and technical expertise: the gitHub Web interface and the command line. The steps above are explained in more detail in the following pages, providing instructions for:
If you are new to GitHub and pull request, here are some helpful beginner guides to Github.
- How to Join RespiCompass
- Preparing to Submit
- Submission Format
- Submitting
- Rounds