2 コミット 30afebc667 ... 77e52d4d93

作者 SHA1 メッセージ 日付
  Tom Dupré la Tour 77e52d4d93 DOC improve README's 'How to get started' 2 年 前
  Tom Dupré la Tour 30afebc667 DOC improve README's 'How to get started' 2 年 前
1 ファイル変更13 行追加12 行削除
  1. 13 12
      README.md

+ 13 - 12
README.md

@@ -19,7 +19,7 @@ If you publish any work using the dataset, please cite the original publication
 > J. L. (2022). Gallant Lab Natural Short Clips 3T fMRI Data.
 > https://dx.doi.org/--TBD--
 
-## Difference with the "vim-2" dataset
+#### Difference with the "vim-2" dataset
 
 The present dataset uses the same stimuli (natural short movie clips) than a
 previous experiment of the Gallant lab [2], publicly released in CRCNS under
@@ -44,23 +44,23 @@ mappers to plot the data on flatten maps of the cortical surface.
 
 ## How to get started
 
-### a. With dedicated tutorials
+#### a. With dedicated tutorials
 The preferred way to explore this dataset is through the [voxelwise
 tutorials](https://github.com/gallantlab/voxelwise_tutorials). These tutorials
 includes Python downloading tools, data loaders, plotting utilities, and
 examples of analysis following the original publication [1] [2].
 
-To run the tutorials, see
-[https://gallantlab.github.io/voxelwise_tutorials](https://gallantlab.github.io/voxelwise_tutorials)).
+To run the tutorials, go to
+[https://gallantlab.github.io/voxelwise_tutorials](https://gallantlab.github.io/voxelwise_tutorials).
 
 <a href="https://gallantlab.github.io/voxelwise_tutorials/"><img
 src="https://gallantlab.github.io/voxelwise_tutorials/_images/sphx_glr_06_plot_banded_ridge_model_002.png"
 alt="Example" width="600"/></a>
 
-### b. With git and git-annex
+#### b. With git and git-annex
 
-To download the data with [git-annex](https://git-annex.branchable.com/), the
-following dependencies are necessary: git, git-annex. Then, run the commands
+To download the data with [git-annex](https://git-annex.branchable.com/), run
+the commands:
 ```bash
 # clone the repository, without the data files
 git clone https://gin.g-node.org/gallantlab/shortclips
@@ -71,12 +71,13 @@ git annex get features/wordnet.hdf --from wasabi
 git annex get . --from wasabi
 ```
 
-To maximize the download speed, two remotes are available to download the data.
-The first remote is GIN (`--from origin`), but the bandwidth might be limited.
-The second remote is Wasabi (`--from wasabi`), with a larger bandwidth.
+To maximize the downloading speed, two remotes are available to download the
+data. The first remote is GIN (`--from origin`), but the bandwidth might be
+limited. The second remote is Wasabi (`--from wasabi`), with a larger
+bandwidth.
 
-A basic example script is available in `example.py`. For more utilities and
-example of analysis, see the dedicated [voxelwise
+To load and plot the data, a basic example script is available in `example.py`.
+For more utilities and examples of analysis, see the dedicated [voxelwise
 tutorials](https://github.com/gallantlab/voxelwise_tutorials).
 
 ## How to get help