diff --git a/README.md b/README.md index b70a2d9082d9c46444b28a3b432b5e51e0b3f336..4d620b716c4432437a166e481e756f5df34952ee 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,15 @@ This repository contains the exercises and tutorials for the hands-on session by QIM at the European Synchrotron Radiation Facility the 8th February 2021. -To **get started** follow the steps below. +## Option 1: Running the tutorials with binder +You can run the tutorials on Jupyter Notebook from [](https://mybinder.org/v2/git/https%3A%2F%2Flab.compute.dtu.dk%2FQIM%2Fworkshops%2Fesrf-um-2021/HEAD) -## 1. Get Workshop Material + +## Option 2: Configuring a Local Setup +If Binder doesn't work for you, follow the instructions below to configure a local setup. +### 1. Get Workshop Material Clone or download this repository as a .zip. -## 2. Installation of Framework for Jupyter Notebooks +### 2. Installation of Framework for Jupyter Notebooks If you don't already have Anaconda to run Jupyter Notebooks. We suggest two options: **Miniconda** @@ -28,11 +32,7 @@ If you don't already have Anaconda to run Jupyter Notebooks. We suggest two opti - Change permissions to install by running `chmod 700 <filename>.sh` - To install, type `<filename>.sh` -**Google Colab** - -Billy? - -## 3. Set up environment +### 3. Set up environment Unless you are using Google Colab, you will need to run the file called environment.yml to install the required packages via the command line. Mac/Linux: @@ -49,16 +49,16 @@ Windows 3. Type `conda env create -f environment.yml` and press enter. 4. Type `conda activate qim-esrf` and press enter. -## 4. Installation of Layered Surface Tool +### 4. Installation of Layered Surface Tool Install package using `pip install slgbuilder` to get the implementation from this [repository](https://github.com/Skielex/slgbuilder) -## 5. Installation of Structure Tensor Tool +### 5. Installation of Structure Tensor Tool 1. Download the [repository](https://lab.compute.dtu.dk/QIM/structure-tensor) as a .zip file 2. Extract the .zip file 3. Rename the directory from structure-tensor-master to structure_tensor_master 4. Place the directory inside esrf-um-2021-master/Structure Tensor/ -## 6. Open Jupyter Notebooks +### 6. Open Jupyter Notebooks In the same terminal window where you activated the environment, type `jupyter notebook`. You are ready! You can now navigate to the tutorial of interest =)