Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mrc-ide/sircovid
https://github.com/mrc-ide/sircovid
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/mrc-ide/sircovid
- Owner: mrc-ide
- License: other
- Created: 2020-04-01T06:38:31.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-28T15:52:56.000Z (about 2 months ago)
- Last Synced: 2024-10-28T17:43:17.288Z (about 2 months ago)
- Language: C++
- Homepage: https://mrc-ide.github.io/sircovid
- Size: 63.5 MB
- Stars: 28
- Watchers: 5
- Forks: 6
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Changelog: NEWS.md
- License: LICENSE
Awesome Lists containing this project
README
# sircovid 
[](https://www.repostatus.org/#wip)
[](https://github.com/mrc-ide/sircovid/actions)
[](https://www.codefactor.io/repository/github/mrc-ide/sircovid)
[](https://codecov.io/gh/mrc-ide/sircovid?branch=master)
[](https://buildkite.com/mrc-ide/sircovid)
`sircovid` implements a series of mechanistic models to help modelling the transmission of the SARS-Cov-2 virus using stochastic compartmental models. `sircovid` also provides some tools to perfom Bayesian evidence synthesis from several surveillance data streams through the estimation of transmission parameters.
## Important information for users
Please note that whilst this code is free to use and adapt, Imperial College London does not endorse the outputs, results, or conclusions drawn from the implementation of this model to other settings. While we encourage the use and modification of our model for research and scientific purposes please do not refer to such results as the "Imperial model" or similar unless referring to specific use in publications by Imperial College researchers.
The model is constantly in flux and we make no effort to keep things backward compatible, nor do we have the capacity to provide support (including installation support). This package is being closely developed with [dust](https://mrc-ide.github.io/dust/) and [mcstate](https://mrc-ide.github.io/mcstate/) often requiring simultaneous upgrades. The minimum version number noted in the `DESCRIPTION` is a good starting place - be sure that versions match or sircovid will likely not compile.
## Installation
Install from the ncov drat:
```r
drat:::add("ncov-ic")
install.packages("sircovid")
```
or install directly from GitHub with:
```r
remotes::install_github("mrc-ide/sircovid", upgrade = FALSE)
```
You will need the most recent version of [`dust`](https://mrc-ide.github.io/dust) and [`mcstate`](https://mrc-ide.github.io/mcstate) to use the package. These will be installed automatically if you install `sircovid` from drat, or manually with:
```r
drat:::add("ncov-ic")
install.packages(c("dust", "mcstate"))
```
We use OpenMP for parallelism, and this may not be available on your system. If not then compilation will fail with an error like:
```r
clang: error: unsupported option '-fopenmp'
make[1]: *** [basic.o] Error 1
ERROR: compilation failed for package ‘sircovid’
```
You can either install OpenMP support, or edit your personal `Makevars` file to tell R that you do not have it. To do this, you can run
```r
usethis::edit_r_makevars("user")
```
and add the lines
```r
SHLIB_OPENMP_CFLAGS=
SHLIB_OPENMP_CXXFLAGS=
```
after which compilation will succeed, but the model will only run on one core.
## Development
In addition to the above you need to install [`odin`](https://mrc-ide.github.io/odin) and [`odin.dust`](https://mrc-ide.github.io/odin.dust/)
```r
drat:::add("ncov-ic")
install.packages(c("odin", "odin.dust"))
```
* Make changes to the models in `inst/odin`
* Run `odin.dust::odin_dust_package(here::here())` from the root directory, which will generate updated files `R/dust.R` and `src/basic.cpp`, `src/lancelot.cpp`, along with `R/cpp11.R` and `src/cpp11.cpp`
Alternatively, run `./scripts/generate_odin`
## License
MIT © Imperial College of Science, Technology and Medicine