Skip to content
Snippets Groups Projects
Commit e69db5c8 authored by monj's avatar monj
Browse files

Update README.md

parent 73c411c9
Branches master
No related tags found
No related merge requests found
......@@ -6,7 +6,7 @@
4. [Contributions](#4)
<a name='1'></a>
### 1. Description of repository content
## 1. Description of repository content
The tutorials demonstrate the use of the structure tensor tool for the analysis of orientations using 2D and 3D data. These tutorials have been developed for the implementation in https://github.com/Skielex/structure-tensor. This implementation is compatible with the python package `cupy`. Therefore, if you have large volumes to process and a graphical processing unit (GPU), you can speed up your computations simply by having a working installation of [cupy](https://docs.cupy.dev/en/stable/install.html).
......@@ -15,8 +15,8 @@ With these tutorials we would like you to 1) learn how to choose the parameters
To find out more, click on the binder icon to run the tutorials online [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/git/https%3A%2F%2Flab.compute.dtu.dk%2FQIM%2Ftutorials%2Fstructuretensor/HEAD)
<a name='2'></a>
### 2. Local set-up to run the tutorials and the tool
If you want to run the tutorials locally, check our instructions for [installing Jupyter Notebooks](https://lab.compute.dtu.dk/QIM/tutorials/getting-started) and then follow the instructions below to install the tool.
## 2. Local set-up to run the tutorials and the tool
If you want to run the tutorials locally, follow the instructions below to install the tool. You may also check our instructions for [installing Jupyter Notebooks](https://lab.compute.dtu.dk/QIM/tutorials/getting-started) on your computer.
**Option 1: pip install**
......@@ -24,7 +24,7 @@ If you have `pip`, you can install the tool with `pip install structure-tensor`.
**Option 2: Set up environment**
You can run the file called environment.yml to install the structure tensor tool and other required packages via the command line, as explained below. 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.
You can run the file called environment.yml to install the structure tensor tool and other required packages using the terminal, as explained below. 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:
1. Navigate to the tutorial extracted folder.
......@@ -41,7 +41,7 @@ Windows:
4. Type `conda activate qim-ST` and press enter.
<a name='3'></a>
### 3. Resources and inspiration
## 3. Resources and inspiration
To learn more about the computation of structure tensor, the visualisation of orientation analysis and other examples of using orientation analysis in volumetric data analysis, we recommend you take a look at the [notes](http://people.compute.dtu.dk/vand/notes/ST_intro.pdf) by Vedrana A. Dahl vand@dtu.dk
......@@ -52,7 +52,7 @@ For inspiration, check out the following papers on user cases we have solved wit
- Jeppesen, Mikkelsen, Dahl, Nymark, Dahl. [Quantifying effects of manufacturing methods on fiber orientation in unidirectional composites using structure tensor analysis.](https://www.sciencedirect.com/science/article/pii/S1359835X21002633?via%3Dihub) Composites Part A: Applied Science and Manufacturing, 2021
<a name='4'></a>
### 4. Contributions
## 4. Contributions
The development of the tutorials is a combined effort from several researchers in the QIM team. The collection of scripts and exercises is in constant development, and actively used to demonstrate the tool and teach at workshops. We would therefore very much appreciate to hear about your experience.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment