Skip to content

Commit

Permalink
container build instructions were updated for Github containers.
Browse files Browse the repository at this point in the history
  • Loading branch information
Gab-D-G committed Sep 25, 2023
1 parent 179cb52 commit d4a540b
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,16 @@ However, this does not account for non-python dependencies found in `dependencie
## Container (Singularity/Docker)
For most uses, we recommend instead using a containerized installation with [Singularity](https://singularity.lbl.gov) or [Docker](https://www.docker.com). Containers allow to build entire computing environments, grouping all dependencies required to run the software. This in turn reduces the burden of installing dependencies manually and ensures reproducible behavior of the software. Singularity is generally preferred over Docker since it requires less permission, and can thus be imported from most computing environment (e.g. high performance computing clusters such as Compute Canada.)

A containerized version of RABIES is available on [Docker Hub](https://hub.docker.com/r/gabdesgreg/rabies). After installing Singularity or Docker, the following command will pull and build the container:
A [containerized version](https://github.com/CoBrALab/RABIES/pkgs/container/rabies) of RABIES is available from Github. After installing Singularity or Docker, the following command will pull and build the container:
* Install Singularity .sif file:
```
singularity build rabies.sif docker://gabdesgreg/rabies:tagname
singularity build rabies.sif docker://ghcr.io/cobralab/rabies:latest
```
* Install Docker image:
```
docker pull gabdesgreg/rabies:tagname
docker pull ghcr.io/cobralab/rabies:latest
```
A specific tag version can be selected (instead of `latest`) from the [list online](https://github.com/CoBrALab/RABIES/pkgs/container/rabies). Versions prior to 0.5.0 are found on [Docker Hub](https://hub.docker.com/r/gabdesgreg/rabies).

## Neurodesk
RABIES is also made available on the [Neurodesk platform](https://neurodesk.github.io/), as part of the [built-in tools](https://neurodesk.github.io/applications/) for neuroimaging. The Neurodesk platform allows for an entirely browser-based neuroimaging computing environment, with pre-built neuroimaging tools from the community, and aims at reducing needs for manual development of computing environments and at improving reproducible neuroimaging. More details on Neurodesk here <https://neurodesk.github.io/docs/>.

0 comments on commit d4a540b

Please sign in to comment.