Skip to content

Commit a99b04a

Browse files
authored
[DOC] Remove parts about SPM + MATLAB set-up from the documentation. (aramis-lab#1622)
* Remove SPM + MATLAB mentions * Test for spacing * Test for spacing 2 * Test spacing table 3 * Adjust table size * Change column size in css * Try2 * Update css 3 * Final fix on css * Modify name
1 parent 48a7750 commit a99b04a

File tree

11 files changed

+36
-138
lines changed

11 files changed

+36
-138
lines changed

docs/CAPS/Specifications.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,9 @@ subjects/
6464
└─ <source_file>_segm-<segm>_dartelinput.nii.gz
6565
```
6666

67-
- The `modulated-{on|off}` key indicates if modulation has been used in [SPM](../Software/Third-party.md#spm12) to compensate for the effect of spatial normalization.
67+
- The `modulated-{on|off}` key indicates if modulation has been used in [SPM](../Software/Third-party.md#spm-standalone) to compensate for the effect of spatial normalization.
6868
- The possible values for the `segm-<segm>` key/value are: `graymatter`, `whitematter`, `csf`, `bone`, `softtissue`, and `background`.
69-
- The T1 image in `Ixi549Space` (reference space of the TPM) is obtained by applying the transformation obtained from the [SPM](../Software/Third-party.md#spm12) segmentation routine to the T1 image in native space.
69+
- The T1 image in `Ixi549Space` (reference space of the TPM) is obtained by applying the transformation obtained from the [SPM](../Software/Third-party.md#spm-standalone) segmentation routine to the T1 image in native space.
7070

7171
#### DARTEL
7272

@@ -81,7 +81,7 @@ groups/
8181
```
8282

8383
- The final group template is `<group_id>_template.nii.gz`.
84-
- The `<group_id>_iteration-<index>_template.nii.gz` obtained at each iteration will only be used when obtaining flow fields for registering a new image into an existing template ([SPM](../Software/Third-party.md#spm12) DARTEL existing templates procedure).
84+
- The `<group_id>_iteration-<index>_template.nii.gz` obtained at each iteration will only be used when obtaining flow fields for registering a new image into an existing template ([SPM](../Software/Third-party.md#spm-standalone) DARTEL existing templates procedure).
8585

8686
!!! Note "Note for SPM experts"
8787
The original name of `<group_id>_iteration-<index>_template.nii.gz` is `Template<index>.nii`.

docs/IOTools/center_nifti.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# `center-nifti` - Center NIfTI files of a BIDS directory
22

33
Your [BIDS](http://bids.neuroimaging.io) dataset may contain NIfTI files where the origin does not correspond to the center of the image (i.e. the anterior commissure).
4-
[SPM](../Software/Third-party.md#spm12) is especially sensitive to this case and segmentation procedures may result in blank images or even fail.
4+
[SPM](../Software/Third-party.md#spm-standalone) is especially sensitive to this case and segmentation procedures may result in blank images or even fail.
55
To mitigate this issue we offer a simple tool that generates from your BIDS a new dataset with centered NIfTI files for the selected modalities.
66

77

docs/Pipelines/PET_Surface.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
<!-- markdownlint-disable MD033 MD046 -->
22

3-
--8<-- "snippets/spm_banner.md"
4-
53
# `pet-surface` - Surface-based processing of PET images
64

75
This pipeline performs several processing steps for the analysis of PET data on the cortical surface [[Marcoux et al., 2018](https://doi.org/10.3389/fninf.2018.00094)]:
@@ -25,9 +23,7 @@ You need to have performed the [`t1-freesurfer`](./T1_FreeSurfer.md) pipeline on
2523

2624
## Dependencies
2725

28-
If you only installed the core of Clinica, this pipeline needs the installation of [FreeSurfer 6.0](../Software/Third-party.md#freesurfer), [FSL 6.0](../Software/Third-party.md#fsl), and [PETPVC 1.2.4](../Software/Third-party.md#petpvc) (which depends on [ITK 4](../Software/Third-party.md#itk)) on your computer.
29-
30-
In addition, you also need to either install [SPM12](../Software/Third-party.md#spm12) and [Matlab](../Software/Third-party.md#matlab), or [spm standalone](../Software/Third-party.md#spm12-standalone).
26+
If you only installed the core of Clinica, this pipeline needs the installation of [FreeSurfer 6.0](../Software/Third-party.md#freesurfer), [FSL 6.0](../Software/Third-party.md#fsl), and [PETPVC 1.2.4](../Software/Third-party.md#petpvc) (which depends on [ITK 4](../Software/Third-party.md#itk)) on your computer. In addition, you also need to install [spm standalone](../Software/Third-party.md#spm-standalone).
3127

3228
## Running the pipeline
3329

docs/Pipelines/PET_Surface_Longitudinal.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
<!-- markdownlint-disable MD046 -->
22

3-
--8<-- "snippets/spm_banner.md"
4-
53
# `pet-surface-longitudinal` - Surface-based longitudinal processing of PET images
64

75
This pipeline performs several processing steps for the longitudinal analysis of PET data on the cortical surface
@@ -30,9 +28,7 @@ You need to have performed the [`t1-freesurfer-longitudinal`](../T1_FreeSurfer_L
3028

3129
## Dependencies
3230

33-
If you only installed the core of Clinica, this pipeline needs the installation of [FreeSurfer 6.0](../Software/Third-party.md#freesurfer), [FSL 6.0](../Software/Third-party.md#fsl), and [PETPVC 1.2.4](../Software/Third-party.md#petpvc) (which depends on [ITK 4](../Software/Third-party.md#itk)) on your computer.
34-
35-
In addition, you also need to either install [SPM12](../Software/Third-party.md#spm12) and [Matlab](../Software/Third-party.md#matlab), or [spm standalone](../Software/Third-party.md#spm12-standalone).
31+
If you only installed the core of Clinica, this pipeline needs the installation of [FreeSurfer 6.0](../Software/Third-party.md#freesurfer), [FSL 6.0](../Software/Third-party.md#fsl), and [PETPVC 1.2.4](../Software/Third-party.md#petpvc) (which depends on [ITK 4](../Software/Third-party.md#itk)) on your computer. In addition, you also need to install [spm standalone](../Software/Third-party.md#spm-standalone).
3632

3733

3834
## Running the pipeline

docs/Pipelines/PET_Volume.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
<!-- markdownlint-disable MD046 -->
22

3-
--8<-- "snippets/spm_banner.md"
4-
53
# `pet-volume` – Volume-based processing of PET images
64

75
This pipeline performs several processing steps on [PET](../glossary.md#pet) data in voxel space, which include:
@@ -23,7 +21,7 @@ You need to have performed the [`t1-volume`](./T1_Volume.md) pipeline on your T1
2321

2422
## Dependencies
2523

26-
If you only installed the core of Clinica, this pipeline needs the installation of [SPM standalone](../Software/Third-party.md#spm12-standalone).
24+
If you only installed the core of Clinica, this pipeline needs the installation of [SPM standalone](../Software/Third-party.md#spm-standalone).
2725

2826
In addition, if you want to apply partial volume correction (PVC) on your PET data, you will need to install [PETPVC 1.2.4](../Software/Third-party.md#petpvc), which depends on [ITK 4](../Software/Third-party.md#itk).
2927

docs/Pipelines/Stats_Volume.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
<!-- markdownlint-disable MD046 -->
22

3-
--8<-- "snippets/spm_banner.md"
43

54
# `statistics-volume` - Volume-based mass-univariate analysis with SPM
65

@@ -12,7 +11,7 @@ Currently, this pipeline mainly handles gray matter maps obtained from T1-weight
1211

1312
## Dependencies
1413

15-
If you only installed the core of Clinica, this pipeline needs the installation of [Matlab](../Software/Third-party.md#matlab) and [SPM12](../Software/Third-party.md#spm12), or of [SPM standalone](../Software/Third-party.md#spm12-standalone), on your computer.
14+
If you only installed the core of Clinica, this pipeline needs the installation of [SPM standalone](../Software/Third-party.md#spm-standalone), on your computer.
1615

1716
## Running the pipeline
1817

docs/Pipelines/T1_Volume.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
<!-- markdownlint-disable MD007 MD033 -->
22

3-
--8<-- "snippets/spm_banner.md"
4-
53
# `t1-volume` – Volume-based processing of T1-weighted MR images with SPM
64

75
This pipeline performs four main processing steps on T1-weighted MR images using the [SPM](http://www.fil.ion.ucl.ac.uk/spm/) software:
@@ -26,7 +24,7 @@ The average gray matter density (also in MNI space) is then computed in each of
2624

2725
## Dependencies
2826

29-
If you only installed the core of Clinica, this pipeline needs the installation of [SPM standalone](../Software/Third-party.md#spm12-standalone) on your computer.
27+
If you only installed the core of Clinica, this pipeline needs the installation of [SPM standalone](../Software/Third-party.md#spm-standalone) on your computer.
3028

3129
## Running the pipeline
3230

docs/Software/Third-party.md

Lines changed: 19 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
<!-- markdownlint-disable MD046 -->
22

3-
--8<-- "snippets/spm_banner.md"
4-
53
# Third-party software
64

75
## Environment variables set-up
@@ -65,20 +63,19 @@ Specific dependencies are described in the table below (1) :
6563

6664
<div markdown="1" class="third_party_table">
6765

68-
| | ANTs | Convert3D | FreeSurfer | FSL | ITK | Matlab | MRtrix3 | PETPVC | SPM |
69-
|:-------------------:|:----:|:---------:|:----------:|:---:|:---:|:------:|:-------:|:------:|:---:|
70-
| Anat > Linear | ✓∘ | | | | | | | | |
71-
| Anat > Volume | | | | | || | ||
72-
| Anat > FreeSurfer | | || | | | | | |
73-
| DWI > Preprocessing ||| || | || | |
74-
| DWI > DTI || | || | || | |
75-
| DWI > Connectome | | ||| | || | |
76-
| PET > Linear || | | | | | | | |
77-
| PET > Surface | | ||| ✓⟡ || | ✓⟡ ||
78-
| PET > Volume | | | | | ✓⟡ || | ✓⟡ ||
79-
| Stats > Surface | | || | | | | | |
80-
| Stats > Volume | | | | | || | ||
81-
66+
| | ANTs | Convert3D | FreeSurfer | FSL | ITK | MRtrix3 | PETPVC | SPM |
67+
|:-------------------:|:-----:|:---------:|:----------:|:---:|:---:|:-------:|:------:|:---:|
68+
| Anat > Linear | ✓∘ | | | | | | | |
69+
| Anat > Volume | | | | | | | ||
70+
| Anat > FreeSurfer | | || | | | | |
71+
| DWI > Preprocessing ||| || || | |
72+
| DWI > DTI || | || || | |
73+
| DWI > Connectome | | ||| || | |
74+
| PET > Linear || | | | | | | |
75+
| PET > Surface | | ||| ✓⟡ | | ✓⟡ ||
76+
| PET > Volume | | | | | ✓⟡ | | ✓⟡ ||
77+
| Stats > Surface | | || | | | | |
78+
| Stats > Volume | | | | | | | ||
8279
</div>
8380

8481
- *✓∘ : for anatomical linear pipelines there is also the possibility to use ANTsPy instead of ANTs since Clinica `v0.9.0`*
@@ -202,23 +199,6 @@ official instructions for [downloading](https://www.mrtrix.org/download/).
202199

203200
___
204201

205-
### Matlab
206-
207-
You can find more details about `Matlab` on their [website](https://fr.mathworks.com/products/matlab/).
208-
209-
!!! warning
210-
Note that using `Matlab` requires having a **valid license** which might be available through your university or institution.
211-
212-
Make sure to have the following environment variables defined:
213-
214-
```{ .bash .copy }
215-
export MATLAB_HOME="/path/to/your/matlab/bin/"
216-
export PATH=${MATLAB_HOME}:${PATH}
217-
export MATLABCMD="${MATLAB_HOME}/matlab"
218-
```
219-
220-
___
221-
222202
### PETPVC
223203

224204
You can find more details about `PETPVC` on their [website](https://github.com/UCL/PETPVC),
@@ -235,59 +215,16 @@ You have basically three options:
235215

236216
___
237217

238-
### SPM12
239-
240-
!!! warning "SPM12 and Matlab"
241-
Note that `SPM12` works with [Matlab](#matlab) such that Clinica pipelines which require `SPM12`, will also need a `Matlab` installation.
242-
If you cannot install `Matlab`, you can install [SPM standalone](#spm12-standalone).
243-
244-
You can find more details about `SPM12` on their [website](http://www.fil.ion.ucl.ac.uk/spm/). To install it :
245-
246-
=== "Linux"
247-
Download the latest version [here](http://www.fil.ion.ucl.ac.uk/spm/download/restricted/eldorado/spm12.zip) and follow the instructions on the [SPM wiki](https://en.wikibooks.org/wiki/SPM/Installation_on_64bit_Linux).
248-
249-
=== "MacOS"
250-
Download the latest version [here](http://www.fil.ion.ucl.ac.uk/spm/download/restricted/eldorado/spm12.zip) and follow the instructions on the [SPM wiki](https://en.wikibooks.org/wiki/SPM/Installation_on_64bit_Mac_OS_(Intel)).
251-
252-
??? warning "MacOS Big Sur"
253-
For systems running on MacOS Big Sur, a [development version of SPM12](https://www.fil.ion.ucl.ac.uk/spm/download/restricted/utopia/dev/) as well as a more recent release of the MCR (minimum 2019a) are required.
218+
### SPM Standalone
254219

255-
Then :
220+
!!! danger "Set-up MATLAB + SPM"
221+
Clinica now only supports SPM standalone, which functions without MATLAB.
256222

257-
1. Make sure to have the following environment variable defined:
258-
```{ .bash .copy }
259-
export SPM_HOME="/path/to/your/spm12"
260-
```
223+
To use SPM standalone, you will need to install two things:
261224

262-
2. You must also add `SPM` to the `MATLAB` path variable if you installed it as a toolbox.
263-
- First, verify a `startup.m` file exists in your *initial working folder*, by default `~/Documents/MATLAB` (see [here](https://fr.mathworks.com/help/matlab/ref/startup.html) for more details).
264-
If the file does not exist, you can create it.
265-
- Then, type inside:
266-
```matlab
267-
addpath('/path/to/your/spm12');
268-
```
269-
**OR**, assuming the `$SPM_HOME` environment variable is set in your `~/.bashrc` file :
270-
```matlab
271-
[~, spmhome] = system('source ~/.bashrc > /dev/null; echo $SPM_HOME;');
272-
spmhome = strsplit(spmhome,'\n');
273-
addpath(spmhome{end-1});
274-
```
275-
276-
!!! warning
277-
`zsh` shell users will have to replace `~/.bashrc` by `~/.zshrc`.
278-
279-
___
280-
281-
### SPM12 standalone
282-
283-
If you want to install `SPM12` without installing [Matlab](#matlab), you will need to install two things:
284-
285-
- The Matlab runtime (often abbreviated into MCR), for which no license is required.
225+
- The Matlab Runtime (often abbreviated into MCR), for which no license is required.
286226
- The SPM standalone itself.
287227

288-
!!! danger "Which version to use ?"
289-
SPM has recently released a version `SPM25` on Github for which the installation is described [here](https://www.fil.ion.ucl.ac.uk/spm/docs/installation/standalone/).
290-
Clinica does support this version for both `t1-volume` and `pet-volume`
291228

292229
!!! tip "Verify your environment variables"
293230
If you followed the installation instructions, you should have set the environment variable `$LD_LIBRARY_PATH` on Linux, or `$DYLD_LIBRARY_PATH` on MacOS.
@@ -297,11 +234,9 @@ In addition, you need to define the following environment variables:
297234
```bash
298235
export MCR_HOME="/path/to/your/MCR/"
299236
export SPMSTANDALONE_HOME="/path/to/your/spmstandalone/home/"
300-
export SPM_HOME="/path/to/your/spmstandalone/home/"
301237
```
302238

303-
!!! tip "Which paths to use ?"
304-
- `SPM_HOME` is not actually used with this set-up but it still needs to be defined
239+
!!! tip "What are these paths ?"
305240
- `SPMSTANDALONE_HOME` should indicate the directory containing the `run_spmxx.sh` file.
306241
- `MCR_HOME` should indicate the directory containing the `bin`, `runtime`... folders
307242

@@ -321,6 +256,3 @@ eval "$(register-python-argcomplete clinica)"
321256
bashcompinit
322257
source ~/.bash_completion.d/python-argcomplete.sh
323258
```
324-
325-
326-
--8<-- "snippets/known_issues.md:matlab"

docs/css/clinica.css

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -75,32 +75,29 @@ h3, .h3, .md-typeset h3 {
7575
}
7676

7777
.third_party_table th:nth-child(1) {
78-
width: 20%;
78+
width: 19%;
7979
}
8080
.third_party_table th:nth-child(2) {
81-
width: 8%;
81+
width: 10%;
8282
}
8383
.third_party_table th:nth-child(3) {
84-
width: 11%;
84+
width: 15%;
8585
}
8686
.third_party_table th:nth-child(4) {
87-
width: 11%;
87+
width: 15%;
8888
}
8989
.third_party_table th:nth-child(5) {
90-
width: 6%;
90+
width: 7%;
9191
}
9292
.third_party_table th:nth-child(6) {
93-
width: 6%;
93+
width: 7%;
9494
}
9595
.third_party_table th:nth-child(7) {
96-
width: 10%;
96+
width: 12%;
9797
}
9898
.third_party_table th:nth-child(8) {
99-
width: 10%;
99+
width: 13%;
100100
}
101101
.third_party_table th:nth-child(9) {
102-
width: 10%;
103-
}
104-
.third_party_table th:nth-child(10) {
105102
width: 8%;
106103
}

docs/snippets/known_issues.md

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,3 @@
1-
--8<-- [start:matlab]
2-
## :warning: Known issue with Matlab and SPM12
3-
4-
[Matlab](https://www.mathworks.com/products/matlab.html) and [SPM12](https://www.fil.ion.ucl.ac.uk/spm/software/spm12/) (whose implementation is based on Matlab) can sometimes randomly crash, causing a rather unreadable error in the console.
5-
Those events are unpredictable. In case it occurs to you, please do the following:
6-
7-
- Check that you have a valid Matlab license.
8-
- Before relaunching the command line, be sure to remove the content of the working directory (if you specified one).
9-
--8<-- [end:matlab]
10-
11-
121
--8<-- [start:center-nifti]
132
!!! warning "Centering BIDS nifti"
143
If the images from the `BIDS_DIRECTORY` are not centered, Clinica will give a **warning** because this can be an issue **if** later processing steps involve SPM (for instance if you are planning to run [pet-surface](./PET_Surface.md) afterwards).

0 commit comments

Comments
 (0)