Skip to content

Commit 2bc05a7

Browse files
paudetseispaudetseis
authored
Merge pull request #27 from nfsi-canada/arg_update
Arg update
2 parents ea6625b + 568869c commit 2bc05a7

File tree

4 files changed

+233
-240
lines changed

4 files changed

+233
-240
lines changed

‎docs/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ used in command-line scripts. Tutorials are provided in the sections below.
2727
.. image:: https://github.com/nfsi-canada/OrientPy/workflows/Build/badge.svg
2828
:target: https://github.com/nfsi-canada/OrientPy/actions
2929
.. image:: https://codecov.io/gh/nfsi-canada/OrientPy/branch/master/graph/badge.svg
30-
:target: https://codecov.io/gh/nfsi-canada/OrientPy
30+
:target: https://codecov.io/gh/nfsi-canada/OrientPy
3131

3232
.. note::
3333

‎docs/scripts.rst

+67-44
Original file line numberDiff line numberDiff line change
@@ -80,27 +80,40 @@ Usage
8080
Server Settings:
8181
Settings associated with which datacenter to log into.
8282
83-
--catalogue-source CAT_CLIENT
84-
Specify the server to connect to for the event
85-
catalogue. Options include: BGR, ETH, GEONET, GFZ,
86-
INGV, IPGP, IRIS, KOERI, LMU, NCEDC, NEIP, NERIES,
87-
ODC, ORFEUS, RESIF, SCEDC, USGS, USP. [Default IRIS]
88-
--cat_url CAT_URL Specify the obspy base_url server address (and port if
89-
needed) to open for the catalogue client. Overrides
90-
any settings to cat_client. [Default None]
91-
--waveform-source WF_CLIENT
92-
Specify the server to connect to for the waveform
93-
data. Options include: BGR, ETH, GEONET, GFZ, INGV,
94-
IPGP, IRIS, KOERI, LMU, NCEDC, NEIP, NERIES, ODC,
95-
ORFEUS, RESIF, SCEDC, USGS, USP. [Default IRIS]
96-
--wf_url WF_URL Specify the obspy base_url server address (and port if
97-
needed) to open for the waveform client. Overrides any
98-
settings to wf_client. [Default None]
99-
-U USERAUTH, --user-auth USERAUTH
100-
Enter your Authentification Username and Password for
101-
the waveform server (--user-
102-
auth='username:authpassword') to access and download
103-
restricted data. [Default no user and password]
83+
--server-cat SERVER_CAT
84+
Catalogue server setting: Key string for recognized
85+
server that provide `available_event_catalogs` service
86+
(one of 'AUSPASS', 'BGR', 'EARTHSCOPE', 'EIDA',
87+
'EMSC', 'ETH', 'GEOFON', 'GEONET', 'GFZ', 'ICGC',
88+
'IESDMC', 'INGV', 'IPGP', 'IRIS', 'IRISPH5', 'ISC',
89+
'KNMI', 'KOERI', 'LMU', 'NCEDC', 'NIEP', 'NOA',
90+
'NRCAN', 'ODC', 'ORFEUS', 'RASPISHAKE', 'RESIF',
91+
'RESIFPH5', 'SCEDC', 'TEXNET', 'UIB-NORSAR', 'USGS',
92+
'USP'). [Default 'IRIS']
93+
--server-wf SERVER_WF
94+
Waveform server setting: Base URL of FDSN web service
95+
compatible server (e.g. “http://service.iris.edu”) or
96+
key string for recognized server (one of 'AUSPASS',
97+
'BGR', 'EARTHSCOPE', 'EIDA', 'EMSC', 'ETH', 'GEOFON',
98+
'GEONET', 'GFZ', 'ICGC', 'IESDMC', 'INGV', 'IPGP',
99+
'IRIS', 'IRISPH5', 'ISC', 'KNMI', 'KOERI', 'LMU',
100+
'NCEDC', 'NIEP', 'NOA', 'NRCAN', 'ODC', 'ORFEUS',
101+
'RASPISHAKE', 'RESIF', 'RESIFPH5', 'SCEDC', 'TEXNET',
102+
'UIB-NORSAR', 'USGS', 'USP'). [Default 'IRIS']
103+
--user-auth USERAUTH Authentification Username and Password for the
104+
waveform server (--user-auth='username:authpassword')
105+
to access and download restricted data. [Default no
106+
user and password]
107+
108+
--eida-token TOKENFILE
109+
Token for EIDA authentication mechanism, see
110+
http://geofon.gfz-
111+
potsdam.de/waveform/archive/auth/index.php. If a token
112+
is provided, argument --user-auth will be ignored.
113+
This mechanism is only available on select EIDA nodes.
114+
The token can be provided in form of the PGP message
115+
as a string, or the filename of a local file with the
116+
PGP message in it. [Default None]
104117
105118
Station Selection Parameters:
106119
Parameters to select a specific station.
@@ -143,7 +156,6 @@ Usage
143156
[Default 175.]
144157
--max-dep MAXDEP Specify maximum Earthquake Depth (km). [Default no
145158
limit]
146-
--discard-catalogue Specify to discard the eq catalogue after processing.
147159
148160
Processing Parameters:
149161
Parameters associated with BNG processing.
@@ -281,27 +293,39 @@ Usage
281293
Server Settings:
282294
Settings associated with which datacenter to log into.
283295
284-
--catalogue-source CAT_CLIENT
285-
Specify the server to connect to for the event
286-
catalogue. Options include: BGR, ETH, GEONET, GFZ,
287-
INGV, IPGP, IRIS, KOERI, LMU, NCEDC, NEIP, NERIES,
288-
ODC, ORFEUS, RESIF, SCEDC, USGS, USP. [Default IRIS]
289-
--cat_url CAT_URL Specify the obspy base_url server address (and port if
290-
needed) to open for the catalogue client. Overrides
291-
any settings to cat_client. [Default None]
292-
--waveform-source WF_CLIENT
293-
Specify the server to connect to for the waveform
294-
data. Options include: BGR, ETH, GEONET, GFZ, INGV,
295-
IPGP, IRIS, KOERI, LMU, NCEDC, NEIP, NERIES, ODC,
296-
ORFEUS, RESIF, SCEDC, USGS, USP. [Default IRIS]
297-
--wf_url WF_URL Specify the obspy base_url server address (and port if
298-
needed) to open for the waveform client. Overrides any
299-
settings to wf_client. [Default None]
300-
-U USERAUTH, --user-auth USERAUTH
301-
Enter your Authentification Username and Password for
302-
the waveform server (--user-
303-
auth='username:authpassword') to access and download
304-
restricted data. [Default no user and password]
296+
--server-cat SERVER_CAT
297+
Catalogue server setting: Key string for recognized
298+
server that provide `available_event_catalogs` service
299+
(one of 'AUSPASS', 'BGR', 'EARTHSCOPE', 'EIDA',
300+
'EMSC', 'ETH', 'GEOFON', 'GEONET', 'GFZ', 'ICGC',
301+
'IESDMC', 'INGV', 'IPGP', 'IRIS', 'IRISPH5', 'ISC',
302+
'KNMI', 'KOERI', 'LMU', 'NCEDC', 'NIEP', 'NOA',
303+
'NRCAN', 'ODC', 'ORFEUS', 'RASPISHAKE', 'RESIF',
304+
'RESIFPH5', 'SCEDC', 'TEXNET', 'UIB-NORSAR', 'USGS',
305+
'USP'). [Default 'IRIS']
306+
--server-wf SERVER_WF
307+
Waveform server setting: Base URL of FDSN web service
308+
compatible server (e.g. “http://service.iris.edu”) or
309+
key string for recognized server (one of 'AUSPASS',
310+
'BGR', 'EARTHSCOPE', 'EIDA', 'EMSC', 'ETH', 'GEOFON',
311+
'GEONET', 'GFZ', 'ICGC', 'IESDMC', 'INGV', 'IPGP',
312+
'IRIS', 'IRISPH5', 'ISC', 'KNMI', 'KOERI', 'LMU',
313+
'NCEDC', 'NIEP', 'NOA', 'NRCAN', 'ODC', 'ORFEUS',
314+
'RASPISHAKE', 'RESIF', 'RESIFPH5', 'SCEDC', 'TEXNET',
315+
'UIB-NORSAR', 'USGS', 'USP'). [Default 'IRIS']
316+
--user-auth USERAUTH Authentification Username and Password for the
317+
waveform server (--user-auth='username:authpassword')
318+
to access and download restricted data. [Default no
319+
user and password]
320+
--eida-token TOKENFILE
321+
Token for EIDA authentication mechanism, see
322+
http://geofon.gfz-
323+
potsdam.de/waveform/archive/auth/index.php. If a token
324+
is provided, argument --user-auth will be ignored.
325+
This mechanism is only available on select EIDA nodes.
326+
The token can be provided in form of the PGP message
327+
as a string, or the filename of a local file with the
328+
PGP message in it. [Default None]
305329
306330
Station Selection Parameters:
307331
Parameters to select a specific station.
@@ -341,7 +365,6 @@ Usage
341365
--max-dist MAXDIST Specify the maximum earthquake distance (in degrees).
342366
[Default 175.]
343367
--max-dep MAXDEP Specify maximum Earthquake Depth (km). [Default 150.]
344-
--discard-catalogue Specify to discard the eq catalogue after processing.
345368
346369
``dl_average``
347370
**************

0 commit comments

Comments
 (0)