Skip to content

Commit

Permalink
Automatic README update (#709)
Browse files Browse the repository at this point in the history
Co-authored-by: sbfnk <[email protected]>
  • Loading branch information
github-actions[bot] and sbfnk authored Jul 2, 2024
1 parent b14d1e3 commit 31d39c0
Showing 1 changed file with 14 additions and 7 deletions.
21 changes: 14 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,13 +146,20 @@ 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
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

0 comments on commit 31d39c0

Please sign in to comment.