README.md 3.27 KB
Newer Older
Michael Rudolf's avatar
Michael Rudolf committed
1
# RST Evaluation
Michael Rudolf's avatar
Michael Rudolf committed
2

Michael Rudolf's avatar
Michael Rudolf committed
3
4
Scripts for analysing shear experiments from the Schulze RST.pc01 ring shear tester.

Michael Rudolf's avatar
Michael Rudolf committed
5
6
## Quick Guide to rst-evaluation

7
8
9
10
11
The software `rst-evaluation` is a series of scripts to semi-automatically
evaluate shear experiments done at the Helmholtz Laboratory for Tectonic
Modelling. In principle, it may be used for other measurements done in a
similar setup, but it was build with our standardized workflow in mind.

Michael Rudolf's avatar
Michael Rudolf committed
12
13
14
15
## Installation / Download

### Windows Installer

16
Download the latest Windows release: [setup_RST_pick_GUI_0.2.5.exe](/uploads/a7058ed12e5468800bf231be2e01ab7b/setup_RST_pick_GUI_0.2.5.exe)
17

Michael Rudolf's avatar
Michael Rudolf committed
18
19
### Linux or Windows Command Line (without sample data)

20
21
22
23
24
25
To install for Linux or to use it from a Windows command line we advise to
install the the software using pip:

`python -m pip install git+https://git.gfz-potsdam.de/analab-code/rst-evaluation.git`

To run the GUI-Version:
26

Michael Rudolf's avatar
Michael Rudolf committed
27
28
29
30
31
32
33
34
35
36
37
38
39
40
```bash
rstevaluation
```

if the Python script folder is on your `$PATH$` variable, alternatively

```bash
python -m rstevaluation
```

should work for all systems (in some cases you need to use `python3`).

Using this version you can also access the functions for your personal project,
for example by using:
41

42
```Python
43
    import rstevaluation.analysis
44
```
Michael Rudolf's avatar
Michael Rudolf committed
45

Michael Rudolf's avatar
Michael Rudolf committed
46
47
### Linux or Windows Command Line (with sample data)

48
Download the repository and run the scripts as needed.
49
50
51
52
53
The main scripts are located in RSTpicking and to run the scripts you should
use `python RST_main.py` (Windows) or `python3 RST_main.py` (Unix). That will
open a GUI providing the necessary details to open data files and analyse full
folders.

Michael Rudolf's avatar
Michael Rudolf committed
54
55
### RSTpicking

56
57
58
59
60
61
62
63
64
65
The software features several independent components that can be used for file
conversion, manual picking, analysis or a fully featured analysis.

The main component of this software is `RSTpicking` which incorporates the
functionality of all other components. There are two different scripts that run
the picking and analysis. It is recommended to use `RST_pick_GUI.py` which
makes use of a user interface and allows the user to easily change the
parameters and projects. `RST_main.py` is an older version that is less
flexible and requires the user to manually edit the settings in the script.

Michael Rudolf's avatar
Michael Rudolf committed
66
67
### Other Components

68
69
70
71
For a more detailed description of the other components see the
[Documentation](https://gitext.gfz-potsdam.de/analab-code/rst-evaluation/blob/master/Documentation/)
and the readme files in the individual folders.

Michael Rudolf's avatar
Michael Rudolf committed
72

Michael Rudolf's avatar
Michael Rudolf committed
73
74
## Acknowledgements

Michael Rudolf's avatar
Michael Rudolf committed
75
76
77
78
The original scripts for version 0.0.1 (4260ec45) in this repository have been provided by M. Warsitzka @warsitzka_at_ig.cas.cz and contain scripts that have been developed by M. Ritter.

Warsitzka, Michael; Ge, Zhiyuan; Schönebeck, Jan-Michael; Pohlenz, Andre; Kukowski, Nina (2019): Ring-shear test data of foam glass beads used for analogue experiments in the Helmholtz Laboratory for Tectonic Modelling (HelTec) at the GFZ German Research Centre for Geosciences in Potsdam and the Institute of Geosciences, Friedrich Schiller University Jena. GFZ Data Services. http://doi.org/10.5880/GFZ.4.1.2019.002

Michael Rudolf's avatar
Michael Rudolf committed
79
## Citation
Michael Rudolf's avatar
Michael Rudolf committed
80
81
Please cite this repository as:

82
Rudolf, Michael; Warsitzka, Michael (2021): RST Evaluation - Scripts for analysing shear experiments from the Schulze RST.pc01 ring shear tester. GFZ Data Services. https://doi.org/10.5880/GFZ.4.1.2021.001