Commit 12c5a64d authored by Javier Quinteros's avatar Javier Quinteros

Improve the introduction to dasconv in the README file.

parent dcc59f11
......@@ -22,7 +22,32 @@ generated by DAS systems. In particular, the ones saved in TDMs format.
Dasconv
-------
Convert and manipulate seismic waveforms from TDMs to MiniSEED format. ::
This utility lets you convert and manipulate seismic waveforms in TDMs format and export them into MiniSEED.
Data acquired from experiments with DAS systems are usually stored in one folder. Files within this folder have names
indicating the experiment and the start time of the waveforms saved. An example of the files generated in a test
experiment is shown below. ::
$ ls -l
total 1577352
-rwxrwxrwx 1 user staff 49965056 May 8 09:38 default_UTC_20190508_093735.409.tdms
-rwxrwxrwx 1 user staff 49965056 May 8 09:38 default_UTC_20190508_093805.409.tdms
-rwxrwxrwx 1 user staff 49965056 May 8 09:39 default_UTC_20190508_093835.409.tdms
-rwxrwxrwx 1 user staff 49965056 May 8 09:39 default_UTC_20190508_093905.409.tdms
-rwxrwxrwx 1 user staff 49965056 May 8 09:40 default_UTC_20190508_093935.409.tdms
-rwxrwxrwx 1 user staff 49965056 May 8 09:40 default_UTC_20190508_094005.409.tdms
-rwxrwxrwx 1 user staff 49965056 May 8 09:41 default_UTC_20190508_094035.409.tdms
-rwxrwxrwx 1 user staff 49965056 May 8 09:41 default_UTC_20190508_094105.409.tdms
-rwxrwxrwx 1 user staff 49965056 May 8 09:42 default_UTC_20190508_094135.409.tdms
There, *default* is the name of the experiment and the rest is the start time with the following format:
*experiment_TZ_YYYYMMDD_HHmmss.fff.tdms*.
Dasconv provides also a TDMS class which needs to receive one mandatory parameter to be instantiated,
*filename*, which is actually the experiment name and how all filenames in the containing folder start with.
A detailed explanation on how to use it on your own programms can be found in the documentation.
A typical help message from dasconv looks like the following: ::
usage: dasconv.py [-h] [-l {CRITICAL,ERROR,WARNING,INFO,DEBUG}] [-d DIRECTORY]
[--start START] [--end END] [--chstart CHSTART]
......@@ -54,3 +79,22 @@ Convert and manipulate seismic waveforms from TDMs to MiniSEED format. ::
--decimate DECIMATE Factor by which the sampling rate is lowered by
decimation.
--version show program's version number and exit
Examples
========
Export waveforms from channels 800, 802 and 804 starting at 2019-05-08T09:37:35.409000 until 2019-05-08T09:38:05.400000.
The waveforms will be exported to MiniSEED format after being decimated by a factor of 5 (e.g. from 1000Hz to 200Hz). ::
dasconv -d /home/user/test/ --start "2019-05-08T09:37:35.409000" --end "2019-05-08T09:38:05.400000" default --chstart 800 --chstop 805 --chstep 2
Export waveforms from channels 0 and 1 from the beginning of the measurements until 2019-05-08T09:32:15.
The waveforms will be exported to MiniSEED format after being decimated by a factor of 5 (e.g. from 1000Hz to 200Hz). ::
dasconv -d /home/user/test/ --endtime "2019-05-08T09:32:15" default --chstart 0 --chstop 1
Export waveforms from channels 0 to 4 from the beginning of the measurements until 2019-05-08T09:32:15.
The waveforms will be exported to MiniSEED format after being decimated by a factor of 5 (e.g. from 1000Hz to 200Hz). ::
dasconv -d /home/user/test/ --endtime "2019-05-08T09:32:15" default --chstart 0 --chstop 4 --decimate 2
\ No newline at end of file
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