Merge branch 'master' of github.com:aus-covid-modelling/NationalCabin…

…etModelling

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Australian COVID Modelling Consortium
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,10 @@
+# Modelling for National Cabinet
+The Peter Doherty Institute for Infection and Immunity has produced modelling to advise on the National Plan to transition Australia's National COVID response. The technical report associated with this work can be viewed [here](https://www.doherty.edu.au/news-events/news/doherty-institute-modelling-report-for-national-cabinet). This repository contains submodules for each of the parts of the code used to generate the reports.
+
+There are four submodules: TransmissionPotential, AgentBasedModel, ClinicalPathwaysModel and NationalModelPlotting.
+
+## Transmission Potential
+The transmission potential code is stored as part of a much larger collection of work relating to situational awareness in Australia, maintained by Prof. Nick Golding, Curtin University. The relevant piece of code for this work is in R/reopening.R.
+
+## Dynamic model outputs
+Outputs from the agent based model are fed into the clinical pathways model, and outputs from the clinical pathways model are fed into the national model plotting. Please see the readme in each of these three submodules for more specifics on running these code blocks.