Skip to content

Commit

Permalink
Small correction in the paper and added section in readme file how to…
Browse files Browse the repository at this point in the history
… get help.
  • Loading branch information
mrosskopf committed Jul 8, 2024
1 parent 501f9f3 commit ff624e2
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,8 @@ pip install -e .

## Example
An example dataset to test the software can be accessed with the [Zenodo DOI](https://doi.org/10.5281/zenodo.10598393).\
The dataset consists of a python run-file and its associated configuration file and the needed waveform and station xml files.
The dataset consists of a python run-file and its associated configuration file and the needed waveform and station xml files.

## Getting help
If any problems arise, please open an issue. We will try to help and solve it as soon as possible.\
Additionally, any feedback or contributions are welcome! In this case, please also feel free to open an issue if you have any suggestions or would like to contribute a feature.
2 changes: 1 addition & 1 deletion paper/paper.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ The open source, Python-based DUGseis package is designed to align with the func

# Functionality and Features
The DUGseis software is a Python-based package with the main focus to process continuous high-frequency data, extract picoseismic event waveforms and create an earthquake catalog. To make its usage and its outputs more easily accessible for seismologists, some features use modules and functions of the ObsPy package [@Beyreuther2010], a popular package in seismology.\
The DUGseis software requires sensor metadata with sensor locations and continuous waveform data in the ASDF format [@Greenfield2015; @asdf] to run. Here, the continuous waveform data was acquired using DUGseis acquisition [@DugSeisAcqui], another software package developed specifically for the Bedretto Underground Laboratory to record and store waveform data of AE sensors in the ASDF format using specific Spectrum digitizer cards. For general usage of the here presented DUGseis package, the waveform data does not need to be acquired from DUGseis acquisition but the ASDF format can be transferred from other data formats. \
The DUGseis software requires sensor metadata with sensor locations as StationXML files and continuous waveform data in the ASDF format [@Greenfield2015; @asdf] to run. Here, the continuous waveform data was acquired using DUGseis acquisition [@DugSeisAcqui], another software package developed specifically for the Bedretto Underground Laboratory to record and store waveform data of AE sensors in the ASDF format using specific Spectrum digitizer cards. For general usage of the here presented DUGseis package, the waveform data does not need to be acquired from DUGseis acquisition but the ASDF format can be transferred from other data formats. \
DUGseis retrieves all important information regarding data directories and processing settings from a configuration file. The configuration file can be used to open a graphical interface or can be given to the processing script. After processing the continuous waveform data, DUGseis outputs an event catalog as a database, which additionally can be saved as QuakeML or CSV files. Figure \autoref{fig:DUGseisScatch} shows the in- and output of the DUGseis processing.

![In- and output of DUGseis processing. \label{fig:DUGseisScatch}](DUGseis_InputOutputScatch.png)
Expand Down

0 comments on commit ff624e2

Please sign in to comment.