Skip to content

Commit c98cd23

Browse files
Update README.md
1 parent eac17ca commit c98cd23

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
# sct_tutorial_data
22

3-
This repository contains image files required for the **[Spinal Cord Toolbox tutorials](https://spinalcordtoolbox.com/en/latest/tutorials/tutorials.html)**. It also contains scripts with all of the tutorial commands to demonstrate how commands can be linked together to form a pipeline.
3+
This dataset contains image files required for the **[Spinal Cord Toolbox tutorials](https://spinalcordtoolbox.com/en/latest/tutorials/tutorials.html)**. It also contains two scripts with all of the tutorial commands, to demonstrate how commands can be linked together to form a pipeline.
44

5-
## Using this repo
5+
## Using this dataset
66

7-
There are three ways to use this repo:
7+
There are three ways to use this dataset:
88

99
1. Download the entire `sct_tutorial_data` dataset ([Releases](https://github.com/spinalcordtoolbox/sct_tutorial_data/releases/latest) -> "[Source code (.zip)](https://github.com/spinalcordtoolbox/sct_tutorial_data/archive/refs/heads/master.zip)"), then follow along with each tutorial in the documentation from start to finish. (The tutorials link together.)
1010
2. Download the entire dataset, but use the included batch scripts ([`batch_single_subject.sh`](https://github.com/spinalcordtoolbox/sct_tutorial_data/blob/master/single_subject/batch_single_subject.sh) and [`process_data.sh`](https://github.com/spinalcordtoolbox/sct_tutorial_data/blob/master/multi_subject/process_data.sh)) to execute all of the commands together as a pipeline.
1111
3. Download a single dataset for a specific tutorial ([Releases](https://github.com/spinalcordtoolbox/sct_tutorial_data/releases/latest) -> e.g. "[`data_spinalcord-segmentation.zip`](https://github.com/spinalcordtoolbox/sct_tutorial_data/releases/latest/download/data_spinalcord-segmentation.zip)"), and complete just that tutorial.
1212

13-
## Making changes to this repo
13+
## Making changes to this dataset
1414

15-
If you've written or modified a tutorial for SCT, you'll need to do 4 things:
15+
If you've written or modified a tutorial for SCT, and your tutorial relies on certain files, updating this dataset requires 4 things:
1616

1717
1. Update the batch scripts ([`batch_single_subject.sh`](https://github.com/spinalcordtoolbox/sct_tutorial_data/blob/master/single_subject/batch_single_subject.sh) and [`process_data.sh`](https://github.com/spinalcordtoolbox/sct_tutorial_data/blob/master/multi_subject/process_data.sh)) with any new or modified commands.
1818
2. Update the file [`tutorial-datasets.csv`](https://github.com/spinalcordtoolbox/sct_tutorial_data/blob/master/tutorial-datasets.csv) for your tutorial.

0 commit comments

Comments
 (0)