Skip to content

Commit b8962a5

Browse files
committed
updated the docstring and the output format
1 parent dc7db7e commit b8962a5

File tree

2 files changed

+36
-2
lines changed

2 files changed

+36
-2
lines changed

docs/source/parts/gf-extraction/index.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,28 @@ A normal query for a subset from a hosted database would look like this
9898
The ``--`` is important for entering negative numbers. It's hard for CLI to
9999
distinguish ``-option`` and a negative number. Hence, ``click`` implements the ``--`` which tells the CLI to take all following command line arguments are, in fact, arguments and not options. For details, please visit: `click: option-like-arguments <https://click.palletsprojects.com/en/8.1.x/arguments/#option-like-arguments>`_.
100100

101+
Other examples are:
102+
103+
.. code:: bash
104+
105+
# Query info
106+
gf3d database query info princeton
107+
108+
# Get query URL
109+
gf3d database query info --debug princeton
110+
111+
# Get available stations query url
112+
gf3d database query stations --debug princeton
113+
114+
# Get query URL for subset
115+
gf3d database query subset --debug -- princeton testquery.h5 -31.1300 -72.0900 17.3500 28.0
116+
117+
# Get query URL for fortran ordered subset
118+
gf3d database query subset --debug -- princeton testquery.h5 -31.1300 -72.0900 17.3500 28.0
119+
120+
# Get query URL for fortran ordered subset
121+
gf3d database query subset --debug -- princeton testquery.h5 -31.1300 -72.0900 17.3500 28.0
122+
101123
102124
103125
OLD command line tool

src/gf3d/bin/gf3d_exec.py

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -234,8 +234,20 @@ def subset_extract(
234234
gf3d query synthetics - - ARG1 ARG2
235235
236236
\b
237-
PARAMETERS
238-
----------
237+
OUTPUT FORMAT:
238+
--------------
239+
\b
240+
# itypsokern
241+
<outdir>/NET.STA.S3.MX{N,E,Z}.mseed # for the synthetic 0
242+
<outdir>/NET.STA.S3.MX{N,E,Z}.<par>.mseed # for the kernels
243+
# par = mrr, mtt, mpp, 1
244+
# mrt, mrp, mtp,
245+
# lat, lon, dep, 2
246+
# cmt, hdr 3
247+
248+
\b
249+
PARAMETERS:
250+
-----------
239251
240252
\b
241253
SUBSETFILENAME = file containing Green functions of a subset of elements

0 commit comments

Comments
 (0)