Commit 6fe47f6a authored by Michael Rudolf's avatar Michael Rudolf
Browse files

Updated README and added __main__ for -m execution

parent 341c423b
......@@ -40,7 +40,7 @@ Using this version you can also access the functions for your personal project,
for example by using:
```Python
import rstevaluation.tools.analysis
import rstevaluation.analysis
```
### Linux or Windows Command Line (with sample data)
......
# RSTpicking
Automatic picking procedure including the production of files and plots for a
datapublication.
## RST_pick_GUI (recommended)
User interface based script that allows for quick and easy adjustment of
picking parameters. Furthermore, it is possible to do a full manual picking or
revise the automatically picked peaks with this script.
### How To Run
The evaluation is started by downloading the repository and then running the
script in its folder in the console.
#### For Windows:
1. Press `Ctrl+R` and type `cmd`, this opens the command prompt.
2. Navigate to the folder by using `cd` and the path to the script like so:
`cd C:\Users\username\git-repos\rst-evaluation\RSTpicking\`.
......@@ -19,6 +23,7 @@ script in its folder in the console.
otherwise it stops working.
#### For Linux:
1. Use a file browser to navigate to the folder `RSTpicking`, then right
click and select `open Terminal/Bash here`
2. Type `python3 RST_pick_GUI.py` and then the below interface should appear.
......@@ -28,6 +33,7 @@ script in its folder in the console.
See below for typical errors.
### The Interface
![RSTpickGUI.png](https://gitext.gfz-potsdam.de/analab-code/rst-evaluation/-/raw/master/Documentation/RSTpickGUI.png "The main interface")
The above picture shows the main interface and the standard selections based on
......@@ -52,6 +58,7 @@ plots are automatically generated and output to the `Output Folder`. Additional
settings are found in the `More options...` dialog (see below).
### Picking Interface
![RSTpickGUImanualPick.png](https://gitext.gfz-potsdam.de/analab-code/rst-evaluation/-/raw/master/Documentation/RSTpickGUImanualPick.png "The picking and revision interface")
This is the manual picking and revision dialog. It is based on a standard
......@@ -73,6 +80,7 @@ correctly. When this is the case the user should modify the `prec` option in
the `More options...` dialog.
### Other Options Dialog
The additional options that the user can modify for correct evaluation of the
parameters. The image below shows the default settings.
![RSTpickGUIoptions.png](https://gitext.gfz-potsdam.de/analab-code/rst-evaluation/-/raw/master/Documentation/RSTpickGUIoptions.png
......@@ -85,6 +93,7 @@ require changing if the tests are either non-standard or the material behaves
differently than the standard, e.g. when it shows stick-slip behavior.
## RST_main (deprecated)
Older version that does not support manual picking or revision. Parameters are
hard-coded and need to be changed directly in the script. This is to maintain
backwards compatibility with the original data publication and is not going to
......@@ -93,6 +102,7 @@ is going to be updated. Most functionality is provided by the shared script
`RST_func.py`.
## Console Output
During the run you may see several notifications in the Python console:
```
......@@ -130,6 +140,7 @@ been written into a single ASCII-text file for easier import into Excel or
other spreadsheet software.
## RST_Func
This file only contains functions for the module to run properly. They may be
incorporated into other projects easily by importing them, e.g.:
```Python
......@@ -142,6 +153,7 @@ To get a simple conversion function that can read the different data formats we
use at HelTec.
# Troubleshooting
Here some common problems are outlined and indications for solutions are given.
- `'python' is not recognized as internal or external command, operable program
......
from . import RST_pick_GUI
RST_pick_GUI.run()
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment