Skip to content

Commit

Permalink
DOC: Add instruction on using custom script
Browse files Browse the repository at this point in the history
  • Loading branch information
YT-R committed Feb 7, 2024
1 parent be9f2d9 commit 2939545
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ For deployment we provide a [Docker container](https://hub.docker.com/repository

## Docker Instructions:

```
```bash
sudo docker run --rm \
-v $(pwd)/INPUTS/:/INPUTS/ \
-v $(pwd)/OUTPUTS:/OUTPUTS/ \
Expand All @@ -44,6 +44,14 @@ ytzero/synbold-disco:v1.4
* \<path to license.txt\> should point to freesurfer license.txt file
* For Mac users, Docker defaults allows only 2Gb of RAM and 2 cores - we suggest giving Docker access to >8Gb of RAM
* Additionally on MAC, if permissions issues prevent binding the path to the license.txt file, we suggest moving the freesurfer license.txt file to the current path and replacing the path line to " $(pwd)/license.txt:/opt/freesurfer/license.txt "
* To customize the pipeline, bind your script to the container and set it as the entry point using the command below. Replace /path/to/host/script with your scripts path in your computer, /path/in/container/script with the desired container path.

```bash
docker run -v
/path/to/host/script:/path/in/container/script
--entrypoint /path/in/container/script
ytzero/synbold-disco:v1.4
```


## Singularity Instructions
Expand All @@ -56,7 +64,7 @@ singularity pull docker://ytzero/synbold-disco:v1.4

Then, to run the synbold-disco.sif container:

```
```bash
singularity run -e \
-B $(pwd)/INPUTS/:/INPUTS \
-B $(pwd)/OUTPUTS/:/OUTPUTS \
Expand Down

0 comments on commit 2939545

Please sign in to comment.