search

BDI-pathogens / OpenABM-Covid19

OpenABM-Covid19: an agent-based model for modelling the spread of SARS-CoV-2 (coronavirus) and control interventions for the Covid-19 epidemic
GNU General Public License v3.0
111 stars 76 forks source link

Missing release documentation #145

Closed PurpleBooth closed 4 years ago

PurpleBooth commented 4 years ago

We're running this model in production and we're trying to work out which version we should be running.

It'd be really useful to have some documentation or to regularly tag what you consider to be the "released" version.

Or if we're supposed to be using master it'd be cool to have that in the README, we've currently assumed master is the correct version to use.

If you'd like we'd be happy to contribute some pipeline code for GitHub Actions to automate the process.

p-robot commented 4 years ago

Thanks for the comment. Release information has been added to the repo now. Do you think that's sufficient or would you also suggest mentioning this in the README?

PurpleBooth commented 4 years ago

Thanks for doing this! ✨

I am just looking through the repo now, and I suspect I am being dumb but where can I see which version I should be running?

p-robot commented 4 years ago

Sorry, updated the PR now. See #159 for updated README with recommendation on how to use the model. Closing this now (unless this doesn't solve the issue!).

PurpleBooth commented 4 years ago

Perfect @p-robot thank you so much!