Skip to content

README: on CRAN #55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nullsatz merged 1 commit into from
Oct 26, 2026
Merged

README: on CRAN #55

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 13 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# gputools

[![CRAN](https://www.r-pkg.org/badges/version/gputools)](https://cran.r-project.org/package=gputools)
[![R-CMD-check](https://github.com/nullsatz/gputools/actions/workflows/R-CMD-check.yml/badge.svg)](https://github.com/nullsatz/gputools/actions/workflows/R-CMD-check.yml)
[![r-universe](https://nullsatz.r-universe.dev/badges/gputools)](https://nullsatz.r-universe.dev/gputools)

Expand Down Expand Up @@ -53,8 +54,14 @@ array work in R, [torch](https://torch.mlverse.org/) is the better tool.
## Installing

To build the package you need an NVIDIA CUDA toolkit, 11.7 or later; to
run the GPU functions, an NVIDIA GPU and driver. Install from
[r-universe](https://nullsatz.r-universe.dev):
run the GPU functions, an NVIDIA GPU and driver. Install the released
version from [CRAN](https://cran.r-project.org/package=gputools):

```r
install.packages("gputools")
```

the development version from [r-universe](https://nullsatz.r-universe.dev):

```r
install.packages("gputools",
Expand All @@ -68,10 +75,10 @@ or from GitHub:
remotes::install_github("nullsatz/gputools")
```

Either way, on Linux gputools is compiled on your machine against your
CUDA toolkit. The prebuilt packages r-universe offers (Windows, macOS, and
its opt-in Linux binaries) are built without CUDA: they install and load,
but their GPU functions cannot run.
Whichever way, on Linux gputools is compiled on your machine against your
CUDA toolkit. The prebuilt binaries CRAN and r-universe offer (Windows,
macOS, and r-universe's opt-in Linux binaries) are built without CUDA:
they install and load, but their GPU functions cannot run.

The package also installs and loads on a machine with no GPU, such as a
login node or a CI runner; `gpuAvailable()` says whether the GPU
Expand Down
Loading