Skip to content

Commit 0e3529d

Browse files
authored
Merge pull request #70 from MELDProject/dev_docker
fix issue documentation singularity
2 parents 5c45c69 + 039831a commit 0e3529d

2 files changed

Lines changed: 17 additions & 1 deletion

File tree

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
# MELD Graph
44

55
**Full documentation: [here](https://meld-graph.readthedocs.io/en/latest/index.html)**
6+
**Intro to MELD Graph and installation videos: [here](https://youtu.be/PIM1gwYNLns)**
67

78
Graph based FCD lesion segmentation for the [MELD project](https://meldproject.github.io/).
89

@@ -44,7 +45,10 @@ The MELD surface-based graph FCD detection algorithm is intended for research pu
4445
You can install and use the MELD FCD prediction pipeline with :
4546
- [**docker container**](https://meld-graph.readthedocs.io/en/latest/install_docker.html) recommended for easy installation of the pipeline as all the prerequisite packages are already embedded into the container. Note: Dockers are not working on High Performance Computing (HCP) systems ; Not tested on Windows
4647
- [**native installation**](https://meld-graph.readthedocs.io/en/latest/install_native.html) recommended for Mac and users that want to modify the code and/or use the code to train/test their own classifier.
47-
- [**singularity container (Not tested yet)**](https://meld-graph.readthedocs.io/en/latest/install_singularity.html) enables to run a container on High Performance Computing (HCP) systems.
48+
- [**singularity container (Not tested yet)**](https://meld-graph.readthedocs.io/en/latest/install_singularity.html) enables to run a container on High Performance Computing (HCP) systems.
49+
50+
**YouTube tutorials available for the [docker installation](https://youtu.be/oduOe6NDXLA) and [native installation](https://youtu.be/jUCahJ-AebM)**
51+
4852

4953
### Running the pipeline
5054
Once installed you will be able to use the MELD FCD prediction pipeline on your data following the steps:
@@ -53,6 +57,8 @@ Once installed you will be able to use the MELD FCD prediction pipeline on your
5357
3. Run the prediction pipeline: [guidelines](https://meld-graph.readthedocs.io/en/latest/run_prediction_pipeline.html)
5458
4. Interpret the results: [guidelines](https://meld-graph.readthedocs.io/en/latest/interpret_results.html)
5559

60+
**YouTube tutorials available to run the [harmonisation step](https://youtu.be/te_TR6sA5sQ), to run the [prediction pipeline](https://youtu.be/OZg1HSzqKyc) and to [interpret the pipeline results](https://youtu.be/dSyd1zOn4F8)**
61+
5662
Note: If you have a question or if you are running into issues at any stage (installation/use/interpretation), have a look at our [FAQs](https://meld-graph.readthedocs.io/en/latest/FAQs.html) page to see if we have not already answered them.
5763

5864
**What is the harmonisation process ?**

docs/run_prediction_pipeline.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ Then run the command
5353
./meldgraph.sh new_pt_pipeline.py -id <subject_id>
5454
```
5555

56+
:::
5657
:::{tab-item} Singularity
5758
:sync: singularity
5859

@@ -108,6 +109,7 @@ DOCKER_USER="$(id -u):$(id -g)" docker compose run meld_graph python scripts/new
108109
./meldgraph.sh new_pt_pipeline.py -id sub-001 --fastsurfer
109110
```
110111

112+
:::
111113
:::{tab-item} Singularity
112114
:sync: singularity
113115
```bash
@@ -132,6 +134,7 @@ DOCKER_USER="$(id -u):$(id -g)" docker compose run meld_graph python scripts/new
132134
./meldgraph.sh new_pt_pipeline.py -id sub-001 -harmo_code H1
133135
```
134136

137+
:::
135138
:::{tab-item} Singularity
136139
:sync: singularity
137140
```bash
@@ -156,6 +159,7 @@ DOCKER_USER="$(id -u):$(id -g)" docker compose run meld_graph python scripts/new
156159
./meldgraph.sh new_pt_pipeline.py -ids list_subjects.txt --parallelise
157160
```
158161

162+
:::
159163
:::{tab-item} Singularity
160164
:sync: singularity
161165
```bash
@@ -195,6 +199,7 @@ DOCKER_USER="$(id -u):$(id -g)" docker compose run meld_graph python scripts/new
195199
./meldgraph.sh run_script_preprocessing.py -id sub-001
196200
```
197201

202+
:::
198203
:::{tab-item} Singularity
199204
:sync: singularity
200205
First you will need to mount the `meld_data` folder to the `/data` folder of the container by running:
@@ -224,6 +229,7 @@ DOCKER_USER="$(id -u):$(id -g)" docker compose run meld_graph python scripts/new
224229
./meldgraph.sh run_script_segmentation.py -h
225230
```
226231

232+
:::
227233
:::{tab-item} Singularity
228234
:sync: singularity
229235
```bash
@@ -262,6 +268,7 @@ DOCKER_USER="$(id -u):$(id -g)" docker compose run meld_graph python scripts/new
262268
./meldgraph.sh run_script_preprocessing.py -id sub-001
263269
```
264270

271+
:::
265272
:::{tab-item} Singularity
266273
:sync: singularity
267274
First you will need to mount the `meld_data` folder to the `/data` folder of the container by running:
@@ -291,6 +298,7 @@ DOCKER_USER="$(id -u):$(id -g)" docker compose run meld_graph python scripts/new
291298
./meldgraph.sh run_script_preprocessing.py -h
292299
```
293300

301+
:::
294302
:::{tab-item} Singularity
295303
:sync: singularity
296304
```bash
@@ -325,6 +333,7 @@ DOCKER_USER="$(id -u):$(id -g)" docker compose run meld_graph python scripts/new
325333
./meldgraph.sh run_script_prediction.py -id sub-001
326334
```
327335

336+
:::
328337
:::{tab-item} Singularity
329338
:sync: singularity
330339
First you will need to mount the `meld_data` folder to the `/data` folder of the container by running:
@@ -354,6 +363,7 @@ DOCKER_USER="$(id -u):$(id -g)" docker compose run meld_graph python scripts/new
354363
./meldgraph.sh run_script_prediction.py -h
355364
```
356365

366+
:::
357367
:::{tab-item} Singularity
358368
:sync: singularity
359369
```bash

0 commit comments

Comments
 (0)