README.Rmd

---
output: 
  rmarkdown::github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# apothecary <img src=https://github.com/mrc-ide/apothecary/blob/master/man/figures/apothecary_logo.PNG align="right" height="138.5" />
<!-- badges: start -->
[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
[![AppVeyor build status](https://ci.appveyor.com/api/projects/status/github/mrc-ide/squire?branch=master&svg=true)](https://ci.appveyor.com/project/cwhittaker1000/apothecary)
[![Travis build status](https://travis-ci.org/mrc-ide/apothecary.svg?branch=master)](https://travis-ci.org/mrc-ide/apothecary)
[![Codecov test coverage](https://codecov.io/gh/mrc-ide/apothecary/branch/master/graph/badge.svg)](https://codecov.io/gh/mrc-ide/apothecary?branch=master)
<!-- badges: end -->

apothecary enables users to simulate models of SARS-CoV-2 epidemics with an explicit focus on exploring the impact of therapeutic interventions. This is done using an age-structured SEIR model that also explicitly considers healthcare capacity and disease severity. 

## IMPORTANT NOTES

:warning: This code is released with no support, is not currently finished and initial results arising from its use have **NOT** been published. Users outside Imperial College looking to run models of COVID-19 transmission dynamics should **NOT** be using **apothecary** and instead use the actively maintained, currently functional package **squire** (available at: https://github.com/mrc-ide/squire) 

:warning: This model is in active development and so parameter names and behaviours, as well as output file formats, will change without notice.


# Copyright and Licensing
The source code for apothecary is licensed under the GPLv3, see LICENSE for more details.

It is Copyright Imperial College of Science, Technology and Medicine. The lead developers are Charlie Whittaker and OJ Watson

# Notes
With thanks to vectorportal.com for the Pestle and Mortar image.