Commit 9eafe1fd authored by Javier Quinteros's avatar Javier Quinteros
Browse files

Update documentation with latest changes

parent c2b79ec4
......@@ -52,8 +52,8 @@ A typical help message from ``dasconv`` looks like the following: ::
usage: dasconv [-h] [-l {CRITICAL,ERROR,WARNING,INFO,DEBUG}] [-d DIRECTORY]
[--start START] [--end END] [--chstart CHSTART]
[--chstop CHSTOP] [--chstep CHSTEP] [--decimate {1,5}]
[--metadata] [-V]
filename
[-N NETWORK] [-C CHANNEL] [-o {SDS,StreamBased,StreamBasedHour}]
[--metadata] [-V] filename
Read, manipulate and convert seismic waveforms generated by a DAS system.
......@@ -66,7 +66,7 @@ A typical help message from ``dasconv`` looks like the following: ::
-l {CRITICAL,ERROR,WARNING,INFO,DEBUG}, --loglevel {CRITICAL,ERROR,WARNING,INFO,DEBUG}
Verbosity in the output.
-d DIRECTORY, --directory DIRECTORY
Directory where files are located.
Directory where files are located (default: ".")
--start START, --starttime START
Start of the selected time window. Format:
2019-02-01T00:01:02.123456Z
......@@ -78,6 +78,12 @@ A typical help message from ``dasconv`` looks like the following: ::
--chstep CHSTEP Step between channels in the selection
--decimate {1,5} Factor by which the sampling rate is lowered by
decimation.
-N NETWORK, --network NETWORK
Network code to store in the miniseed header (default: "XX")
-C CHANNEL, --channel CHANNEL
Channel code to store in the miniseed header (default: "FSF")
-o {SDS,StreamBased,StreamBasedHour}, --outstruct {SDS,StreamBased,StreamBasedHour}
Available options are [SDS, StreamBased, StreamBasedHour]
--metadata Read and display the metadata from the TDMS files
-V, --version show program's version number and exit
......@@ -133,7 +139,7 @@ One can see below a typical config file. ::
[NSLC]
network = XX
location =
channel = FH1
channel = FSF
The "experiment" variable refers to the first part of the filenames in the folder. For instance, in the example above
all files will start with "default" and then a timestamp including the timezone (or UTC) will follow. ::
......@@ -146,7 +152,7 @@ all files will start with "default" and then a timestamp including the timezone
The variables "network", "location" and "channel" will be fixed to define the N.S.L.C code. Only the station will vary
and it will always be a number referring to the stream number for the experiment. From the example above, the only valid
code would be "XX.00001..FH1", "XX.00002..FH1", ..., "XX.00123..FH1" up to all available streams.
code would be "XX.00001..FSF", "XX.00002..FSF", ..., "XX.00123..FSF" up to all available streams.
Running the service
~~~~~~~~~~~~~~~~~~~
......
......@@ -67,14 +67,16 @@ To check if the software was properly installed you can run ::
% dasconv -h
usage: dasconv [-h] [-l {CRITICAL,ERROR,WARNING,INFO,DEBUG}] [-d DIRECTORY]
[--start START] [--end END] [--chstart CHSTART] [--chstop CHSTOP]
[--chstep CHSTEP] [--decimate {1,5}] [-N NETWORK] [-C CHANNEL]
[-o {SDS,StreamBased,StreamBasedHour}] [--metadata] [-V] filename
[--start START] [--end END] [--chstart CHSTART]
[--chstop CHSTOP] [--chstep CHSTEP] [--decimate {1,5}]
[-N NETWORK] [-C CHANNEL] [-o {SDS,StreamBased,StreamBasedHour}]
[--metadata] [-V] filename
Read, manipulate and convert seismic waveforms generated by a DAS system.
positional arguments:
filename Experiment to read and process. It is usually the first part of the filenames.
filename Experiment to read and process. It is usually the
first part of the filenames.
optional arguments:
-h, --help show this help message and exit
......@@ -83,13 +85,16 @@ To check if the software was properly installed you can run ::
-d DIRECTORY, --directory DIRECTORY
Directory where files are located (default: ".")
--start START, --starttime START
Start of the selected time window. Format: 2019-02-01T00:01:02.123456Z
Start of the selected time window. Format:
2019-02-01T00:01:02.123456Z
--end END, --endtime END
End of the selected time window. Format: 2019-02-01T00:01:02.123456Z
End of the selected time window. Format:
2019-02-01T00:01:02.123456Z
--chstart CHSTART First channel to export
--chstop CHSTOP Last channel to export
--chstep CHSTEP Step between channels in the selection
--decimate {1,5} Factor by which the sampling rate is lowered by decimation.
--decimate {1,5} Factor by which the sampling rate is lowered by
decimation.
-N NETWORK, --network NETWORK
Network code to store in the miniseed header (default: "XX")
-C CHANNEL, --channel CHANNEL
......@@ -210,7 +215,7 @@ One can see below a typical config file. ::
[NSLC]
network = XX
location =
channel = FH1
channel = FSF
The "experiment" variable refers to the first part of the filenames in the folder. For instance, in the example above
all files will start with "default" and then a timestamp including the timezone (or UTC) will follow. ::
......
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