Skip to content

Commit

Permalink
fix #42
Browse files Browse the repository at this point in the history
  • Loading branch information
jeffreyhanson committed Mar 19, 2022
1 parent f0a7617 commit 58fd44e
Show file tree
Hide file tree
Showing 7 changed files with 156 additions and 141 deletions.
4 changes: 4 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# surveyvoi 1.0.3.6

- Update README with system requirements for PoissonBinomial package (#42).

# surveyvoi 1.0.3.5

- Autoconf is used for installation on Linux and macOS operating systems.
Expand Down
11 changes: 6 additions & 5 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -43,26 +43,27 @@ The [Rtools](https://cran.r-project.org/bin/windows/Rtools/) software needs to b

#### Ubuntu

The `gmp`, `mpfr`, and `symphony` libraries need to be installed to install the _surveyvoi R_ package. For recent versions of Ubuntu (18.04 and later), these libraries are available through official repositories. They can be installed using the following system commands:
The `gmp`, `fftw3`, `mpfr`, and `symphony` libraries need to be installed to install the _surveyvoi R_ package. Although the `fftw3` and `symphony` libraries are not used directly, they are needed to successfully install dependencies. For recent versions of Ubuntu (18.04 and later), these libraries are available through official repositories. They can be installed using the following system commands:

```
apt-get -y update
apt-get install -y libgmp3-dev libmpfr-dev coinor-libsymphony-dev
apt-get install -y libgmp3-dev libfftw3-dev libmpfr-dev coinor-libsymphony-dev
```

#### Linux

For Unix-alikes, `gmp` (>= 4.2.3), `mpfr` (>= 3.0.0), and `symphony` (>= 5.6.16) are required.
For Unix-alikes, `gmp` (>= 4.2.3), `mpfr` (>= 3.0.0), `fftw3` (>= 3.3), and `symphony` (>= 5.6.16) are required.

#### MacOS

The `gmp`, `mpfr`, and `symphony` libraries are required. The easiest way to install these libraries is using [HomeBrew](https://brew.sh/). After installing HomeBrew, these libraries can be installed using the following commands in the system terminal:
The `gmp`, `fftw`, `mpfr`, and `symphony` libraries are required. Although the `fftw3` and `symphony` libraries are not used directly, they are needed to successfully install dependencies. The easiest way to install these libraries is using [HomeBrew](https://brew.sh/). After installing HomeBrew, these libraries can be installed using the following commands in the system terminal:

```
brew tap coin-or-tools/coinor
brew install symphony
brew install pkg-config
brew install gmp
brew install fftw
brew install mpfr
```

Expand All @@ -72,7 +73,7 @@ Please cite the _surveyvoi R_ package when using it in publications. To cite the

```{r, echo = FALSE, results = "asis", comment = ""}
dev_version <- as.character(packageVersion("surveyvoi"))
dev_year <- "2021"
dev_year <- "2022"
cat(paste0("> Hanson JO, Chadès I, Hudgins EJ, Bennett J (", dev_year, "). surveyvoi: Survey Value of Information. R package version ", dev_version, ". Available at https://github.com/jeffreyhanson/surveyvoi.\n"))
```

Expand Down
23 changes: 14 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,38 +48,43 @@ This software provides system requirements from

#### Ubuntu

The `gmp`, `mpfr`, and `symphony` libraries need to be installed to
install the *surveyvoi R* package. For recent versions of Ubuntu (18.04
The `gmp`, `fftw3`, `mpfr`, and `symphony` libraries need to be
installed to install the *surveyvoi R* package. Although the `fftw3` and
`symphony` libraries are not used directly, they are needed to
successfully install dependencies. For recent versions of Ubuntu (18.04
and later), these libraries are available through official repositories.
They can be installed using the following system commands:

apt-get -y update
apt-get install -y libgmp3-dev libmpfr-dev coinor-libsymphony-dev
apt-get install -y libgmp3-dev libfftw3-dev libmpfr-dev coinor-libsymphony-dev

#### Linux

For Unix-alikes, `gmp` (&gt;= 4.2.3), `mpfr` (&gt;= 3.0.0), and
`symphony` (&gt;= 5.6.16) are required.
For Unix-alikes, `gmp` (&gt;= 4.2.3), `mpfr` (&gt;= 3.0.0), `fftw3`
(&gt;= 3.3), and `symphony` (&gt;= 5.6.16) are required.

#### MacOS

The `gmp`, `mpfr`, and `symphony` libraries are required. The easiest
way to install these libraries is using [HomeBrew](https://brew.sh/).
After installing HomeBrew, these libraries can be installed using the
The `gmp`, `fftw`, `mpfr`, and `symphony` libraries are required.
Although the `fftw3` and `symphony` libraries are not used directly,
they are needed to successfully install dependencies. The easiest way to
install these libraries is using [HomeBrew](https://brew.sh/). After
installing HomeBrew, these libraries can be installed using the
following commands in the system terminal:

brew tap coin-or-tools/coinor
brew install symphony
brew install pkg-config
brew install gmp
brew install fftw
brew install mpfr

## Citation

Please cite the *surveyvoi R* package when using it in publications. To
cite the developmental version, please use:

> Hanson JO, Chadès I, Hudgins EJ, Bennett J (2021). surveyvoi: Survey
> Hanson JO, Chadès I, Hudgins EJ, Bennett J (2022). surveyvoi: Survey
> Value of Information. R package version 1.0.3.5. Available at
> <https://github.com/jeffreyhanson/surveyvoi>.
Expand Down
13 changes: 7 additions & 6 deletions docs/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions docs/news/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ pkgdown: 2.0.2
pkgdown_sha: ~
articles:
surveyvoi: surveyvoi.html
last_built: 2022-03-19T03:44Z
last_built: 2022-03-19T05:14Z
urls:
reference: https://jeffrey-hanson.com/surveyvoi/reference
article: https://jeffrey-hanson.com/surveyvoi/articles
Expand Down
Loading

0 comments on commit 58fd44e

Please sign in to comment.