From cfd336c1b3ef53e12917c356711cad01d7f3b53b Mon Sep 17 00:00:00 2001 From: Mathieu Boudreau Date: Wed, 7 Feb 2024 22:48:29 -0400 Subject: [PATCH] Update README --- README.md | 25 ++++++++++++++++++++++--- 1 file changed, 22 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f478ac3..658fa37 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![DOI Badge](https://img.shields.io/badge/DOI-10.18112%2Fopenneuro.ds004906-blue)](https://openneuro.org/datasets/ds004906) [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/shimming-toolbox/rf-shimming-7t/blob/mb/neurolibre/data_processing.ipynb) -[![Open in MyBinder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/shimming-toolbox/rf-shimming-7t/mb/neurolibre?labpath=content%2Findex.ipynb) +[![launch binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/shimming-toolbox/rf-shimming-7t/mb/neurolibre?labpath=content%2Findex.ipynb) Reproducible Notebook for the paper "RF shimming in the cervical spinal cord at 7T" @@ -10,12 +10,31 @@ Reproducible Notebook for the paper "RF shimming in the cervical spinal cord at Click on the badge "Open in Colab" ☝️. The notebook takes about 2 hours to run on Google Colab (without a paid subscription that gives access to more powerful resource). -## Run on a BinderHub (eg. NeuroLibre, Mybinder) or with repo2binder +## Run in a Docker container (NeuroLibre, MyBinder, repo2ocker) -Click on the badge "Open in MyBinder" ☝️. This environment setup downloads the data and the output of notebook previously run on Google Colab, and by default the notebook will only run the analysis cells (i.e. not the SCT-related commands). +### NeuroLibre + +> [!NOTE] +> This repo isn't on NeuroLibre's whitelist yet, to cannot access it's binderhub until reviewed/published there. + + +### MyBinder + +> [!NOTE] +> MyBinder sometimes crashes during Docker build. NeuroLibre servers are preferred. + +Click on the badge "launch binder" ☝️. This environment setup downloads the data and the output of notebook previously run on Google Colab, and by default the notebook will only run the analysis cells (i.e. not the SCT-related commands). If you'd like to re-run the processing from scratch, change the `notebook = 'neurolibre-figures'` line in the first cell to `notebook = 'neurolibre-clean'`. This will delete the processed files and then re-run the entire processing pipeline. Note that some cells take a lot of RAM, and may fail on certain systems. +### repo2docker + +To run locally on your computer, you must first have Docker installed, running, and have created an account. Follow the instructions [here](https://www.docker.com/get-started/). + +Then, you need to install [repo2docker](https://github.com/jupyterhub/repo2docker). Install via pip: `pip install jupyter-repo2docker` + +To launch a Docker session from this repo, run `repo2docker --ref mb/neurolibre https://www.github.com/shimming-toolbox/rf-shimming-7t`. After it's completed, it will provie you with a weblink, copy and open this link in a browser to open the Jupyter Notebook session. + ## Run locally with Jupyter Notebook Install [Spinal Cord Toolbox](https://spinalcordtoolbox.com/user_section/installation.html)