Skip to content

Commit 7eae454

Browse files
authored
DOC: Usage
Improve container usage documentation, clarify `--segmentation-dir` layout.
1 parent 7e9cc9b commit 7eae454

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,14 @@
1515

1616
Given its extensive dependencies, the easiest way to get up and running with *NiBabies* is by using the available [Docker](https://hub.docker.com/r/mgxd/nibabies/tags?page=1&ordering=last_updated) or [Singularity](https://cloud.sylabs.io/library/mathiasg/default/nibabies) containers.
1717

18+
Images are all tagged with the release number, which must be specified in order to pull the images. For example, if you wanted to pull version `0.1.0`, you would use the following command.
19+
```
20+
# Docker
21+
docker pull mgxd/nibabies:0.1.0
22+
# Singularity
23+
singularity pull library://mathiasg/default/nibabies:0.1.0
24+
```
25+
1826
If you insist on installing this tool locally, you can use the [Dockerfile](./Dockerfile) as a guide.
1927

2028

@@ -32,6 +40,10 @@ However, as infant brains can vastly differ depending on age, providing the foll
3240
- **--age-months** - participant age in months
3341
- **--segmentation-dir** - directory containing pre-labeled segmentations to use for Joint Label Fusion.
3442

43+
> **_NOTE:_** The segmentation directory should consist of one or more template directories containing:
44+
> - A segmented and labelled NIfTI that includes `Segmentation` in the filename.
45+
> - A brainmasked T1w NIfTI that includes `T1w` in the filename.
46+
3547
<details>
3648
<summary>Extensive argument list</summary>
3749

0 commit comments

Comments
 (0)