Skip to content

Commit

Permalink
Update links for configuring c toolchain (#707)
Browse files Browse the repository at this point in the history
* Update links for configuring c toolchain

* Update WORDLIST

* Add NEWS item

* Revert change to docker statement
  • Loading branch information
jamesmbaazam authored Jul 2, 2024
1 parent 35409a6 commit b14d1e3
Show file tree
Hide file tree
Showing 3 changed files with 64 additions and 2 deletions.
4 changes: 4 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# EpiNow2 (development version)

## Documentation

- The installation guide in the README has been updated to provide instructions for configuring the C toolchain of Windows, MacOS, and Linux. By @jamesmbaazam in #707 and reviewed by @<REVIEWER>.

## Model changes

- `epinow()` now returns the "timing" output in a "time difference"" format that is easier to understand and work with. By @jamesmbaazam in #688 and reviewed by @sbfnk.
Expand Down
5 changes: 4 additions & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,10 @@ if (!require("remotes")) {
remotes::install_github("epiforecasts/EpiNow2")
```

Windows users will need a working installation of Rtools in order to build the package from source. See [here](https://github.com/stan-dev/rstan/wiki/RStan-Getting-Started#checking-the-c-toolchain) for a guide to installing Rtools for use with Stan (which is the statistical modelling platform used for the underlying model). For simple deployment/development a prebuilt docker image is also available (see documentation [here](https://github.com/epiforecasts/EpiNow2/wiki/Docker)).
To build `{EpiNow2}` from source, users will need to configure their C toolchain. This is because `{EpiNow2}` implements the underlying models in Stan (a statistical modelling programming language), which is built on C++.

Each operating system has a different set up procedure. Windows users need to install an appropriate version of [RTools](https://github.com/stan-dev/rstan/wiki/Configuring-C---Toolchain-for-Windows). Mac users can [follow these steps](https://github.com/stan-dev/rstan/wiki/Configuring-C---Toolchain-for-Mac), and Linux users can use [this guide](https://github.com/stan-dev/rstan/wiki/Configuring-C-Toolchain-for-Linux). For
simple deployment/development a prebuilt docker image is also available (see documentation [here](https://github.com/epiforecasts/EpiNow2/wiki/Docker)).

## Resources

Expand Down
57 changes: 56 additions & 1 deletion inst/WORDLIST
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
AndrewRiceMGW
BMC
Bisaloo
Bracher
CMD
CMF
Expand All @@ -16,14 +18,17 @@ ECDC
EpiEstim
EpiNow
Epinow
GauriSaran
Gruson
HAKGH
HHS
Habakuk
Hain
HalfNormal
Hamada
IO
Inf
JAllen
Jit
Kanjilal
Kucharski
Expand All @@ -32,7 +37,10 @@ Lifecycle
Linted
Lipsitch
Lison
LizaHadley
LloydChapman
LogNormal
MFZaini
Makevars
Matern
Mayol
Expand All @@ -45,27 +53,38 @@ PLoS
PMF
Poisson
Quilty
RTools
RichardMN
Riutort
Rstan
Rtools
Runtimes
SACEMA
SARS
Sanjat
Susswein
VB
Wellcome
adamkucharski
affans
andrjohns
andrybicio
ast
athowes
avallecam
backcalc
backcalculation
bp
brynhayder
centered
cmdstanr
codecov
com
csv
dajmcdon
davidvilanova
dd
defato
dependabot
detectCores
discretisation
discretise
Expand All @@ -75,67 +94,103 @@ div
doi
dt
dynamicaltruncation
ellisp
epidemia
epiforecasts
epinow
epinowcast
epiparameter
etc
fabsig
filepath
fkrauer
frac
furqan
github
gp
hsbadr
intial
jamesmbaazam
jdmunday
jhellewell
joeHickson
johnaponte
joshwlambert
jrcpulliam
kathsherratt
kgostic
krageth
laplace
ldots
lengthscale
leq
lineranges
linters
lintr
lorenzwalthert
lt
matern
mathcal
mathrm
mc
medRxiv
medewitt
metacran
munozedg
negbin
nikosbosse
nlinton
nolint
nonmechanistic
nowcast
nowcasting
nowcasts
ntorresd
objec
obs
pak
parallisation
parameterisations
parameterised
params
pcarbo
pearsonca
philturk
pitmonticone
pkgdown
pmf
pngs
poisson
raulfernandezn
realland
rhamoonga
rp
rstan
runtimes
rw
sbfnk
schiller
sd
se
seabbs
sim
sophie
sophiemeakin
st
stan
stanfit
testland
th
thlytras
tibbles
timelimit
tony
underreporting
varphi
vb
vscode
warmup
wellcomeopenres
wil
yungwai
yyyy

0 comments on commit b14d1e3

Please sign in to comment.