Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,13 @@ on:
- main
tags:
- 'v*' # Trigger on version tags
paths-ignore:
- 'SimpleITK_Foyer/**'
pull_request:
branches:
- main
paths-ignore:
- 'SimpleITK_Foyer/**'
workflow_dispatch:
# enable manual triggering
schedule:
Expand Down
4 changes: 2 additions & 2 deletions SimpleITK_Foyer/DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ Authors@R: c(person("Richard", "Beare", role = "aut",
email = "blowekamp@mail.nih.gov"),
person("Ziv", "Yaniv", role = c("aut", "cre"),
email = "zivyaniv@nih.gov"))
Description: Provides a lightweight installer for the SimpleITK package, which
Description: A lightweight installer for the SimpleITK image analysis package, which
is an interface to the Insight Toolkit (ITK) for medical image segmentation
and registration. After installing this package, call install_simpleitk().
and registration. After installing this package, call install_simpleitk()
to download and install the pre-built binary packages for your platform
from the SimpleITKRInstaller GitHub releases. Due to the large size of the compiled
package, the actual functionality is distributed as platform-specific binaries
Expand Down
6 changes: 3 additions & 3 deletions SimpleITK_Foyer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ This is a lightweight installer package for SimpleITK, providing easy access to

## Installation

Install the SimpleITK foyer package from GitHub Pages:
Install the SimpleITK foyer package from r-universe:
```r
install.packages("SimpleITK.foyer",
repos = "https://SimpleITK.github.io/SimpleITKRInstaller",
repos = "https://simpleitk.r-universe.dev",
type = "source")
```

Expand Down Expand Up @@ -37,7 +37,7 @@ img <- ReadImage("path/to/image.dcm")

The full SimpleITK package is quite large (~40-50 MB depending on platform) and requires significant compilation time when built from source. To make it easier for users, we distribute:

1. **This lightweight foyer package** - hosted on GitHub Pages as a CRAN-like repository
1. **This lightweight foyer package** - hosted on the r-universe CRAN-like platform
2. **Pre-built binaries on GitHub Releases** - the actual SimpleITK package

The foyer package installs instantly and provides the `install_simpleitk()` function which downloads the correct pre-built binary for your platform.