diff --git a/README.md b/README.md index 9f32da8ac0395415f481a7f8e8da38e3a9ebbfe4..26f4b87133f94c4e26270fb905b857d2fed0f217 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Getting started -To run the different tutorials made by QIM, you will be using Python and Jupyter Notebooks. I you don't have a working installation of Python, you can choose to either: **Option A**: run the tutorials online using binder or **Option B**: create a local installation of Python and Jupyter Notebooks using Miniconda (faster to install), or Anaconda. Follow the instructions below. +To run the different tutorials made by QIM, you will be using Python and Jupyter Notebooks. If you don't have a working installation of Python, you can choose either **Option A**: run the tutorials online using binder or **Option B**: create a local installation of Python and Jupyter Notebooks in your computer. Follow the instructions below. ## Option A: Running the tutorials with binder You can run the tutorials on Jupyter Notebook from Binder by clicking on the Binder link you will find in the README document of the tutorials you are interested in. @@ -11,7 +11,7 @@ If you want to configure a local setup, so that you can also use Python in the f ### 1. Get the tutorial material Clone the repository, or just download it as a .zip. -### 1. Installation of framework for Jupyter Notebooks +### 2. Installation of framework for Jupyter Notebooks We suggest you run Jupyter Notebooks via **Miniconda** if you want a faster installation, you may prefer Anaconda if you plan to continue runing Jupyter Notebooks and Python in the future. 1. Go to https://docs.conda.io/en/latest/miniconda.html and download the latest version @@ -33,7 +33,7 @@ We suggest you run Jupyter Notebooks via **Miniconda** if you want a faster inst - Change permissions to install by running `chmod 700 <filename>.sh` - To install, type `<filename>.sh` -### 2. Set up environment +### 3. Set up environment You can run the file called environment.yml to install the required packages via the command line. If using Anaconda, you can also install the packages using its graphical user interface, just check the packages that are required by opening the environment file with a text reader. Mac/Linux: @@ -53,9 +53,7 @@ Windows ### 4. Install the tool demonstrated in the tutorial In the case of the layered surfaces tutorials, install package using `pip install slgbuilder` to get the implementation from this [repository](https://github.com/Skielex/slgbuilder). -In the case of the structure tensor, the tutorial notebook for structure tensor will automatically clone the repository of the structure tensor tool. If that were to fail, follow the steps below. - -_Option 2_ +In the case of the structure tensor, the tutorial notebook for structure tensor will automatically clone the repository of the structure tensor tool. If that were to fail, follow the steps below: 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