@@ -69,21 +69,29 @@ selecting ``fsLR`` surface space without a density label, ``fsLR:den-32k`` will
69
69
70
70
Custom standard spaces
71
71
""""""""""""""""""""""
72
- Although the functionality is not available yet, the interface of the
73
- ``--output-spaces `` permits providing paths to custom templates that
74
- follow TemplateFlow's naming conventions
75
- (e.g., ``/path/to/custom/templates/tpl-MyCustom:res-2 ``).
76
- Following the example, at least the following files
77
- must be found under under ``/path/to/custom/templates/tpl-MyCustom ``::
78
-
79
- tpl-MyCustom/
80
- template_description.json
81
- tpl-MyCustom_res-1_T1w.nii.gz
82
- tpl-MyCustom_res-1_desc-brain_mask.nii.gz
83
- tpl-MyCustom_res-2_T1w.nii.gz
84
- tpl-MyCustom_res-2_desc-brain_mask.nii.gz
85
-
86
- Although a more comprehensive coverage of standard files would be advised.
72
+ To make your custom templates visible by *fMRIPrep *, and usable via
73
+ the ``--output-spaces `` argument, please store your template under
74
+ *TemplateFlow *'s home directory.
75
+ The default *TemplateFlow *'s home directory is ``$HOME/.cache/templateflow ``
76
+ and that can path can be arbitrarily changed by setting
77
+ the ``$TEMPLATEFLOW_HOME `` environment variable.
78
+ A minimal example of the necessary files for a template called
79
+ ``MyCustom `` (and therefore callable via, e.g., ``--output-spaces MyCustom ``)
80
+ follows::
81
+
82
+ $TEMPLATEFLOW_HOME/
83
+ tpl-MyCustom/
84
+ template_description.json
85
+ tpl-MyCustom_res-1_T1w.nii.gz
86
+ tpl-MyCustom_res-1_desc-brain_mask.nii.gz
87
+ tpl-MyCustom_res-2_T1w.nii.gz
88
+ tpl-MyCustom_res-2_desc-brain_mask.nii.gz
89
+
90
+ For further information about how custom templates must be organized and
91
+ corresponding naming, please check `the TemplateFlow tutorials
92
+ <https://www.templateflow.org/python-client/tutorials.html> `__.
93
+ For more general information about *TemplateFlow *, visit
94
+ `TemplateFlow.org <https://www.templateflow.org >`__.
87
95
88
96
Nonstandard spaces
89
97
""""""""""""""""""
0 commit comments