Commit 8cc57332 authored by Javier Quinteros's avatar Javier Quinteros

Minor changes in README.

parent 12c5a64d
das-scripts
===========
dasscripts
==========
==========
.. image:: https://img.shields.io/pypi/v/dasscripts.svg
:target: https://img.shields.io/pypi/v/dasscripts.svg
......@@ -20,7 +21,7 @@ Overview
This package provides a set of scripts to read, manipulate and convert seismic waveforms
generated by DAS systems. In particular, the ones saved in TDMs format.
Dasconv
dasconv
-------
This utility lets you convert and manipulate seismic waveforms in TDMs format and export them into MiniSEED.
......@@ -43,17 +44,17 @@ experiment is shown below. ::
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,
``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: ::
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]
[--chstop CHSTOP] [--chstep CHSTEP] [--decimate DECIMATE]
[--version]
filename
usage: dasconv [-h] [-l {CRITICAL,ERROR,WARNING,INFO,DEBUG}] [-d DIRECTORY]
[--start START] [--end END] [--chstart CHSTART]
[--chstop CHSTOP] [--chstep CHSTEP] [--decimate DECIMATE]
[--version]
filename
Read, manipulate and convert seismic waveforms generated by a DAS system.
......
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