-
Notifications
You must be signed in to change notification settings - Fork 12
Submitting using GitHub Command Line
Scenario projections has to be submitted using pull requests from a forked version of this repository. This will trigger all the validation checks to ensure a successful acquisition of the projections. Using the command line requires some technical expertise and some knowledge of the git framework. If you are not confident you shall submit using GitHub Website.
-
Install the GitHub cli.
-
Authenticate your user using the GitHub cli:
gh auth login
To do so you need first to create a Personal access token (info here) with at least the repo, workflow and admin:org scopes enabled.
-
Fork and clone the
RespiCompass
repository using the GitHub cli:gh repo fork european-modelling-hubs/RespiCompass --clone=true
-
Set default repository to use when querying the GitHub API for local clone to
RespiCompass
using:gh repo set-default european-modelling-hubs/RespiCompass
-
Be sure your local fork is up to date with the original repo, syncing it:
git checkout main
gh repo sync <your_github_handle>/RespiCompass -b main
git pull
-
Create a new branch for the submission and switch to it:
git checkout -b <submit_branch>
(The name of the branch should be new, for example "submit_branch_YYYYMMDD").
-
Navigate to the
model-output
folder (where all the projections are stored).ONLY BEFORE THE FIRST SUBMISSION: Create and name your own folder in the format
team-model
(where team and model correspond to theteam_abbr
andmodel_abbr
fields of the metadata file). -
Copy your projections/changes file to your projections folder (the
team-model
folder above). -
Commit your changes via the standard git commands:
git add --all
git commit -m "Commit comment"
-
Submit a pull request to the main branch of the RespiCompass repository. Please use your team name, model name and and round_id as the title of the pull request.
gh pr create
-
Wait for validation and merge.
FOR SUBSEQUENT SUBMISSIONS REPEAT FROM POINT 5.
- How to Join RespiCompass
- Preparing to Submit
- Submission Format
- Submitting
- Rounds