Skip to content

Commit bc3699c

Browse files
committed
Merge branch 'main' of github.com:gallantlab/voxelwise_tutorials into main
* 'main' of github.com:gallantlab/voxelwise_tutorials: DOC update website text
2 parents 265cea6 + 9dad453 commit bc3699c

5 files changed

Lines changed: 27 additions & 11 deletions

File tree

doc/index.rst

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,22 @@ Getting started
1111
This website contains tutorials describing how to use the
1212
`voxelwise modeling framework <voxelwise_modeling.html>`_.
1313

14-
The tutorials consist of Python scripts, which are rendered in a `gallery of
15-
examples <_auto_examples/index.html>`_. Each Python script is also available as
16-
a Jupyter notebook (non-rendered). The tutorials are best explored in
17-
order, starting with the "Movies 3T tutorial".
18-
19-
To run the tutorials yourself, we recommend to download the project on GitHub
20-
at `gallantlab/voxelwise_tutorials
14+
To explore these tutorials, one can:
15+
16+
- read the rendered examples in the tutorials
17+
`gallery of examples <_auto_examples/index.html>`_ (recommended)
18+
- run the Python scripts located in the GitHub repository (`tutorials <https://github.com/gallantlab/voxelwise_tutorials/tree/main/tutorials>`_ directory)
19+
- run the Jupyter notebooks located in the GitHub repository
20+
(`tutorials/notebooks
21+
<https://github.com/gallantlab/voxelwise_tutorials/tree/main/tutorials/notebooks>`_
22+
directory)
23+
- run the merged notebook in
24+
`Colab <https://colab.research.google.com/github/gallantlab/voxelwise_tutorials/blob/main/tutorials/notebooks/movies_3T/merged_for_colab.ipynb>`_.
25+
26+
The tutorials are best explored in order, starting with the "Movies 3T"
27+
tutorial.
28+
29+
The project is available on GitHub at `gallantlab/voxelwise_tutorials
2130
<https://github.com/gallantlab/voxelwise_tutorials>`_. On top of the tutorials,
2231
the GitHub repository contains a Python package called ``voxelwise_tutorials``,
2332
which contains useful functions to download the data sets, load the files,

doc/voxelwise_package.rst

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,14 @@ results.
1212
Installation
1313
------------
1414

15-
To install the ``voxelwise_tutorials`` package, run
15+
To install the ``voxelwise_tutorials`` package, run:
16+
17+
.. code-block:: bash
18+
19+
pip install voxelwise_tutorials
20+
21+
22+
To also download the tutorial scripts and notebooks, clone the repository via:
1623

1724
.. code-block:: bash
1825

tutorials/movies_3T/00_load_colab.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
# Uncomment and run the following command to check that Google Drive was
4242
# correctly mounted.
4343

44-
# !ls 'drive' && echo SUCCESS || echo FAILURE
44+
# !ls drive/MyDrive/vim-5
4545

4646
###############################################################################
4747
# Tell the voxelwise_tutorials package where the data is. (If you placed the

tutorials/movies_3T/02_plot_wordnet_model.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -493,4 +493,4 @@
493493
# .. [2] Saunders, C., Gammerman, A., & Vovk, V. (1998).
494494
# Ridge regression learning algorithm in dual variables.
495495

496-
del pipeline
496+
del pipeline, kernel_ridge_cv

tutorials/movies_3T/03_plot_hemodynamic_response.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -252,4 +252,4 @@
252252
# weights. Note that in this dataset, the brain responses are recorded every
253253
# two seconds.
254254

255-
del pipeline
255+
del pipeline, pipeline_no_delay

0 commit comments

Comments
 (0)