Skip to content

Commit

Permalink
Updated README to use new model and mspinpoint/mindglide on dockerhub.
Browse files Browse the repository at this point in the history
  • Loading branch information
phiphi0815 committed May 9, 2024
1 parent 56cf2a9 commit 5c0bcf9
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 23 deletions.
14 changes: 8 additions & 6 deletions .github/workflows/docker-image.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
name: Docker Image CI

on:
push:
branches: [ "master" ]
pull_request:
branches: [ "master" ]
workflow_dispatch:
# on:
#push:
# branches: [ "master" ]
#pull_request:
# branches: [ "master" ]
#workflow_dispatch:

on: null # Disables all triggers for this workflow

jobs:
push_to_registry:
Expand Down
20 changes: 3 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,21 +37,7 @@ following command will download the latest version of the models:

`git lfs pull`

You can use Docker or Apptainer to run the container. To start testing
MindGlide, run the following command:

```
cd mindGlide
docker run -it --rm -v $(pwd):/mindGlide -w /mindGlide armaneshaghi/ms-pinpoint/mind-glide:latest {name_of_nifti_file}
```

You need to replace `{name_of_nifti_file}` with the name of the NIfTI file. For example, if you want to run the test file `test.nii.gz`, you can run the following command:

```
docker run -it --rm -v $(pwd):/mindGlide -w /mindGlide armaneshaghi/ms-pinpoint/mind-glide:latest test.nii.gz
```

`test.nii.gz` will be a brain MRI file.
You can use Docker or Apptainer to run the container.

Docker container is used for testing the model. If you want to use the
container on High Performance Computing (HPC) clusters, you can use
Expand All @@ -69,14 +55,14 @@ Apptainer (formerly known as Singularity). See [Apptainer](https://apptainer.org
docker run --gpus all \
--ipc=host --ulimit memlock=-1 -it \
-v $PWD:/mnt \
armaneshaghi/mind-glide:latest test/flair.nii.gz
mspinpoint/mindglide:may2024 test/flair.nii.gz
```

#### With Apptainer (Singularity)

First you need to use another Docker container to build the Apptainer or Singularity image:

`docker run -v /var/run/docker.sock:/var/run/docker.sock -v /tmp/test:/output --privileged -it --rm quay.io/singularity/docker2singularity armaneshaghi/mind-glide:latest`
`docker run -v /var/run/docker.sock:/var/run/docker.sock -v /tmp/test:/output --privileged -it --rm quay.io/singularity/docker2singularity mspinpoint/mindglide:may2024`

This will create a Singularity image in the `/tmp/test` directory.

Expand Down

0 comments on commit 5c0bcf9

Please sign in to comment.