README.md 3.4 KB
Newer Older
Michael Rudolf's avatar
Michael Rudolf committed
1
2
3
# RST Evaluation
Scripts for analysing shear experiments from the Schulze RST.pc01 ring shear tester.

4
5
6
7
8
9
# Quick Guide to rst-evaluation
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.

10
11
12
13
14
15
16
17
# Installation / Download

Download the latest Windows release: [setup_RST_pick_GUI.exe](/uploads/fd500dbf0eac3dba20234be7bb8633cb/setup_RST_pick_GUI.exe)

## Windows
Install the above setup and run it.

## Linux or Command Line
18
19
20
21
22
23
24
This software is programmed in Python 3 using several external modules and
therefore requires these to run. You can find the newest version of Python at
[here (external link!)](https://python.org). At the time of writing this was
Python 3.8.x, but because of the relatively simple nature of this software it
should also work with most older versions. Furthermore it uses the additional
modules summarized in
[requirements.txt](https://gitext.gfz-potsdam.de/analab-code/rst-evaluation/blob/master/requirements.txt)
Michael Rudolf's avatar
Michael Rudolf committed
25
26
which are installed using `pip` by calling `python3 -m pip install -r requirements.txt --no-cache --only-binary=:all:`.
If you are using Windows you need to call: `python -m pip install -r requirements.txt --no-cache --only-binary=:all:`.
27
28
29

To install this software simply download and extract, or git clone, it into
your destination folder.
Michael Rudolf's avatar
Michael Rudolf committed
30
31

# How-To
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
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.

## RSTpicking
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.

## Other Components
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
53

Michael Rudolf's avatar
Michael Rudolf committed
54
55
56
57
58
59
60
61
# Acknowledgements
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

# Citation
Please cite this repository as:

62
63
64
Rudolf, M., & M. Warsitzka (2019): RST Evaluation - Scripts for analysing shear
experiments from the Schulze RST.pc01 ring shear tester.
https://gitext.gfz-potsdam.de/analab-code/rst-evaluation/