marcel/survBot
1
0
Fork 0
Code Issues 2 Pull Requests Packages Projects Releases 1 Wiki Activity

[minor] update documentation

Browse Source 
* add pyyaml to the list of required modules in README.md
* delete / add some whitespaces
This commit is contained in:
Kasper D. Fischer 2022-11-07 17:06:25 +01:00
parent 64daf34941
commit a0abed7909
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -11,11 +11,12 @@ The following packages are required:
* Python 3 * Python 3
* obspy * obspy
* pyyaml
(the following are dependencies of the above): (the following are dependencies of the above):
* numpy * numpy
* matplotlib * matplotlib
to use the GUI: to use the GUI:
@ -26,16 +27,19 @@ to use the GUI:
Configurations of *datapath*, *networks*, *stations* etc. can be done in the **parameters.yaml** input file. Configurations of *datapath*, *networks*, *stations* etc. can be done in the **parameters.yaml** input file.
The main program is executed by entering The main program is executed by entering
```shell script ```shell script
python survBot.py python survBot.py
``` ```
The GUI can be loaded via The GUI can be loaded via
```shell script ```shell script
python survBotGui.py python survBotGui.py
``` ```
## Staff ## Staff
Original author: M.Paffrath (marcel.paffrath@rub.de) Original author: M.Paffrath (marcel.paffrath@rub.de)
November 2022 November 2022