diff --git a/geomagio/Controller.py b/geomagio/Controller.py
index e07874a642dfcc4074863bcd71b21abc60e6b379..6b95ff5e50983947deafe945e6b7dccb1ca17159 100644
--- a/geomagio/Controller.py
+++ b/geomagio/Controller.py
@@ -460,75 +460,9 @@ def main(args):
with instantiated I/O factories, and algorithm(s)
"""
- # TODO: remove argument mapping in future version
- # map legacy input arguments
- usingDeprecated = False
- if args.input_edge is not None:
- args.input = 'edge'
- args.input_host = args.input_edge
- args.input_port = args.input_edge_port
- usingDeprecated = True
- elif args.input_iaga_file is not None:
- args.input = 'iaga2002'
- args.input_file = args.input_iaga_file
- usingDeprecated = True
- elif args.input_iaga_stdin:
- args.input = 'iaga2002'
- args.input_stdin = True
- usingDeprecated = True
- elif args.input_iaga_url is not None:
- args.input = 'iaga2002'
- args.input_url = args.input_iaga_url
- usingDeprecated = True
- elif args.input_imfv283_file is not None:
- args.input = 'imfv283'
- args.input_file = args.input_imfv283_file
- usingDeprecated = True
- elif args.input_imfv283_url is not None:
- args.input = 'imfv283'
- args.input_url = args.input_imfv283_url
- usingDeprecated = True
- elif args.input_imfv283_goes:
- args.input = 'goes'
- usingDeprecated = True
- # map legacy output arguments
- if args.output_edge is not None:
- args.output = 'edge'
- args.output_host = args.output_edge
- args.output_port = args.edge_write_port
- usingDeprecated = True
- elif args.output_iaga_file is not None:
- args.output = 'iaga2002'
- args.output_file = args.output_iaga_file
- usingDeprecated = True
- elif args.output_iaga_stdout:
- args.output = 'iaga2002'
- args.output_stdout = True
- usingDeprecated = True
- elif args.output_iaga_url is not None:
- args.output = 'iaga2002'
- args.output_url = args.output_iaga_url
- usingDeprecated = True
- elif args.output_pcdcp_file is not None:
- args.output = 'pcdcp'
- args.output_file = args.output_pcdcp_file
- usingDeprecated = True
- elif args.output_pcdcp_stdout:
- args.output = 'pcdcp'
- args.output_stdout = True
- usingDeprecated = True
- elif args.output_pcdcp_url is not None:
- args.output = 'pcdcp'
- args.output_url = args.output_pcdcp_url
- usingDeprecated = True
- elif args.output_plot:
- args.output = 'plot'
- usingDeprecated = True
-
- if usingDeprecated:
- print('WARNING: you are using deprecated arguments,' +
- ' please update your usage', file=sys.stderr)
- # TODO check for unused arguments.
+ # only try to parse deprecated arguments if they've been enabled
+ if args.enable_deprecated_arguments:
+ parse_deprecated_arguments(args)
# make sure observatory is a tuple
if isinstance(args.observatory, (str, unicode)):
@@ -537,9 +471,13 @@ def main(args):
if args.output_observatory is None:
args.output_observatory = args.observatory
elif args.observatory_foreach:
- raise Exception("Cannot specify" +
+ raise Exception("Cannot combine" +
" --output-observatory and --observatory-foreach")
+ if args.output_stdout and args.update:
+ raise Exception("Cannot combine" +
+ " --output-stdout and --update")
+
# translate realtime into start/end times
if args.realtime:
if args.realtime is True:
@@ -608,309 +546,497 @@ def parse_args(args):
dictionary like object containing arguments.
"""
parser = argparse.ArgumentParser(
- description='Use @ to read commands from a file.',
+ description="""
+ Read, optionally process, and Write Geomag Timeseries data.
+ Use @ to read arguments from a file.""",
fromfile_prefix_chars='@',)
- parser.add_argument('--starttime',
- type=UTCDateTime,
- default=None,
- help='UTC date YYYY-MM-DD HH:MM:SS')
- parser.add_argument('--endtime',
- type=UTCDateTime,
- default=None,
- help='UTC date YYYY-MM-DD HH:MM:SS')
+ # Input group
+ input_group = parser.add_argument_group('Input', 'How data is read.')
- parser.add_argument('--observatory',
- default=(None,),
- help='Observatory code ie BOU, CMO, etc.' +
- ' CAUTION: Using multiple observatories is not' +
- ' recommended in most cases; especially with' +
- ' single observatory formats like IAGA and PCDCP.',
+ input_type_group = input_group.add_mutually_exclusive_group(required=True)
+ input_type_group.add_argument('--input',
+ choices=(
+ 'edge',
+ 'goes',
+ 'iaga2002',
+ 'imfv122',
+ 'imfv283',
+ 'miniseed',
+ 'pcdcp'
+ ),
+ default='edge',
+ help='Input format (Default "edge")')
+
+ input_group.add_argument('--input-file',
+ help='Read from specified file',
+ metavar='FILE')
+ input_group.add_argument('--input-host',
+ default='cwbpub.cr.usgs.gov',
+ help='Hostname or IP address (Default "cwbpub.cr.usgs.gov")',
+ metavar='HOST')
+ input_group.add_argument('--input-interval',
+ default=None,
+ choices=['day', 'hour', 'minute', 'second', 'tenhertz'],
+ help="Default same as --interval",
+ metavar='INTERVAL')
+ input_group.add_argument('--input-port',
+ default=2060,
+ help='Port number (Default 2060)',
+ metavar='PORT',
+ type=int)
+ input_group.add_argument('--input-stdin',
+ action='store_true',
+ default=False,
+ help='Read from standard input')
+ input_group.add_argument('--input-url',
+ help='Read from a url or url pattern.',
+ metavar='URL')
+ input_group.add_argument('--input-url-interval',
+ default=86400,
+ help="""
+ Seconds of data each url request should return
+ (default 86400) used to map requests across multiple files
+ or make multiple requests for chunks of data.
+ """,
+ metavar='N',
+ type=int)
+
+ input_group.add_argument('--inchannels',
nargs='*',
- type=str)
- parser.add_argument('--output-observatory',
- default=None,
- help='Defaults to valur of --observatory argument.' +
- ' Observatory code ie BOU, CMO, etc.' +
- ' CAUTION: Using multiple observatories is not' +
- ' recommended in most cases; especially with' +
- ' single observatory formats like IAGA and PCDCP.',
+ help='Channels H, E, Z, etc',
+ metavar='CHANNEL')
+ input_group.add_argument('--interval',
+ default='minute',
+ choices=['day', 'hour', 'minute', 'second', 'tenhertz'],
+ help='Data interval, default "minute"',
+ metavar='INTERVAL')
+ input_group.add_argument('--locationcode',
+ help="""
+ Use explicit location code, e.g. "R0", "R1",
+ instead of "--type"
+ """,
+ metavar='CODE',
+ type=edge.LocationCode)
+ input_group.add_argument('--observatory',
+ default=(None,),
+ help="""
+ Observatory code ie BOU, CMO, etc.
+ CAUTION: Using multiple observatories is not
+ recommended in most cases; especially with
+ single observatory formats like IAGA and PCDCP.
+ """,
+ metavar='OBS',
nargs='*',
- type=str)
- parser.add_argument('--observatory-foreach',
+ type=str,
+ required=True)
+ input_group.add_argument('--observatory-foreach',
action='store_true',
default=False,
help='When specifying multiple observatories, process'
' each observatory separately')
- parser.add_argument('--inchannels',
- nargs='*',
- help='Channels H, E, Z, etc')
- parser.add_argument('--outchannels',
- nargs='*',
- default=None,
- help='Channels H, E, Z, etc')
- parser.add_argument('--type',
+ input_group.add_argument('--rename-input-channel',
+ action='append',
+ help="""
+ Rename an input channel after it is read,
+ before it is processed
+ """,
+ metavar=('FROM', 'TO'),
+ nargs=2)
+ input_group.add_argument('--type',
default='variation',
choices=['variation',
'reported',
'provisional',
'adjusted',
'quasi-definitive',
- 'definitive'])
- parser.add_argument('--rename-input-channel',
- action='append',
- help='Rename an input channel after it is read',
- metavar=('FROM', 'TO'),
- nargs=2)
- parser.add_argument('--rename-output-channel',
+ 'definitive'],
+ help='Data type, default "variation"')
+ # time range
+ input_group.add_argument('--starttime',
+ type=UTCDateTime,
+ default=None,
+ help='UTC date time YYYY-MM-DD HH:MM:SS',
+ metavar='ISO8601')
+ input_group.add_argument('--endtime',
+ type=UTCDateTime,
+ default=None,
+ help='UTC date time YYYY-MM-DD HH:MM:SS',
+ metavar='ISO8601')
+ input_group.add_argument('--realtime',
+ default=False,
+ const=True,
+ help="""
+ Run the last N seconds.
+ Default 3600 (last hour) when interval is minute,
+ Default 600 (last 10 minutes) otherwise.
+ """,
+ metavar='N',
+ nargs='?',
+ type=int)
+
+ # conversion from bins/volts to nT
+ input_group.add_argument('--convert-voltbin',
+ nargs='*',
+ default=None,
+ metavar='CHANNEL',
+ help="""
+ Convert channels from bins/volts to nT.
+ Example: "
+ --inchannels U_Bin U_Volt
+ --interval tenhertz
+ --type variation
+ --convert-voltbin U
+ --outchannels U
+ "
+ """)
+ input_group.add_argument('--volt-conversion',
+ default=100.0,
+ metavar='NT',
+ help='Conversion factor (nT/V) for volts')
+ input_group.add_argument('--bin-conversion',
+ default=500.0,
+ metavar='NT',
+ help='Conversion factor (nT/bin) for bins')
+
+ # Output group
+ output_group = parser.add_argument_group('Output', 'How data is written.')
+ output_type_group = output_group.add_mutually_exclusive_group(
+ required=True)
+
+ # output arguments
+ output_type_group.add_argument('--output',
+ choices=(
+ 'binlog',
+ 'edge',
+ 'iaga2002',
+ 'imfjson',
+ 'miniseed',
+ 'pcdcp',
+ 'plot',
+ 'temperature',
+ 'vbf'
+ ),
+ # TODO: set default to 'iaga2002'
+ help='Output format')
+
+ output_group.add_argument('--outchannels',
+ nargs='*',
+ default=None,
+ help='Defaults to --inchannels',
+ metavar='CHANNEL')
+ output_group.add_argument('--output-file',
+ help='Write to specified file',
+ metavar='FILE')
+ output_group.add_argument('--output-host',
+ default='cwbpub.cr.usgs.gov',
+ help='Write to specified host',
+ metavar='HOST')
+ output_group.add_argument('--output-interval',
+ default=None,
+ choices=['day', 'hour', 'minute', 'second', 'tenhertz'],
+ help="Default same as --interval",
+ metavar='INTERVAL')
+ output_group.add_argument('--output-observatory',
+ default=None,
+ help='Defaults to value of --observatory argument.',
+ metavar='OBS',
+ nargs='*',
+ type=str)
+ output_group.add_argument('--output-port',
+ default=7981,
+ help='Write to specified port',
+ metavar='PORT',
+ type=int)
+ output_group.add_argument('--output-read-port',
+ default=2060,
+ help='Read from specified port',
+ metavar='PORT',
+ type=int)
+ output_group.add_argument('--output-stdout',
+ action='store_true',
+ default=False,
+ help='Write to standard output')
+ output_group.add_argument('--output-url',
+ help='Write to a file:// url pattern',
+ metavar='URL')
+ output_group.add_argument('--output-url-interval',
+ default=86400,
+ help='Output interval in seconds',
+ metavar='INTERVAL',
+ type=int)
+ output_group.add_argument('--rename-output-channel',
action='append',
help='Rename an output channel before it is written',
metavar=('FROM', 'TO'),
nargs=2)
- parser.add_argument('--locationcode',
- help='EDGE location code, e.g. "R0", "R1"',
+ output_group.add_argument('--outlocationcode',
+ help='Defaults to --locationcode',
+ metavar='CODE',
type=edge.LocationCode)
- parser.add_argument('--outlocationcode',
- help='EDGE output location code'
- ' (if different from --locationcode)',
- type=edge.LocationCode)
- parser.add_argument('--interval',
- default='minute',
- choices=['day', 'hour', 'minute', 'second', 'tenhertz'])
- parser.add_argument('--input-interval',
- default=None,
- choices=['day', 'hour', 'minute', 'second', 'tenhertz'])
- parser.add_argument('--output-interval',
- default=None,
- choices=['day', 'hour', 'minute', 'second', 'tenhertz'])
- parser.add_argument('--update',
+ output_group.add_argument('--output-edge-forceout',
+ action='store_true',
+ default=False,
+ help='Used when writing to EDGE, to close miniseed immediately.')
+ output_group.add_argument('--output-edge-tag',
+ default='GEOMAG',
+ help='Used when writing to EDGE, to identify source of data.',
+ metavar='TAG')
+
+ # Processing group
+ processing_group = parser.add_argument_group(
+ 'Processing',
+ 'How data is processed.')
+ processing_group.add_argument('--algorithm',
+ choices=[k for k in algorithms],
+ default='identity',
+ help='Default is "identity", which skips processing')
+ for k in algorithms:
+ algorithms[k].add_arguments(processing_group)
+ processing_group.add_argument('--update',
action='store_true',
default=False,
- help='Used to update data')
- parser.add_argument('--update-limit',
+ help="""
+ Check for gaps in output,
+ and merge new data into existing.
+ """)
+ processing_group.add_argument('--update-limit',
type=int,
default=0,
- help='Used to limit the number of iterations update will recurse')
- parser.add_argument('--no-trim',
+ help="""
+ Update mode checks for gaps and will step backwards
+ to gap fill, if the start of the current interval is a gap,
+ when limit is set to more than 0.
+ """,
+ metavar='N')
+ processing_group.add_argument('--no-trim',
+ action='store_true',
+ default=False,
+ help='Ensures output data will not be trimmed down')
+
+ # GOES parameters
+ goes_group = parser.add_argument_group(
+ 'GOES parameters',
+ 'Used to configure "--input goes"')
+ goes_group.add_argument('--input-goes-directory',
+ default='.',
+ help='Directory for support files for goes input of imfv283 data',
+ metavar='PATH')
+ goes_group.add_argument('--input-goes-getdcpmessages',
+ default='',
+ help='Location of getDcpMessages.',
+ metavar='PATH')
+ goes_group.add_argument('--input-goes-password',
+ default='',
+ help='Password for goes user',
+ metavar='PASSWORD')
+ goes_group.add_argument('--input-goes-server',
+ nargs='*',
+ help='The server name(s) to retrieve the GOES data from',
+ metavar='HOST')
+ goes_group.add_argument('--input-goes-user',
+ default='GEOMAG',
+ help='The user name to use to retrieve data from GOES',
+ metavar='USER')
+
+ # still allow deprecated arguments for now, but hide behind opt in flag
+ deprecated = parser.add_argument_group('Deprecated')
+ deprecated.add_argument('--enable-deprecated-arguments',
action='store_true',
default=False,
- help='Ensures output data will not be trimmed down'),
+ help="enable support for deprecated arguments")
+ # check for this argument before adding deprecated args to usage
+ if '--enable-deprecated-arguments' in args:
+ add_deprecated_args(deprecated, input_type_group, output_type_group)
+
+ return parser.parse_args(args)
+
+
+def add_deprecated_args(parser, input_group, output_group):
+ print('WARNING: you are enabling deprecated arguments,' +
+ ' please update your usage', file=sys.stderr)
+
+ # argument options for inputs and outputs,
+ # replaced with less TYPE specific options
parser.add_argument('--input-edge-port',
type=int,
default=2060,
- help='deprecated. \
- Input port # for edge input, defaults to 2060')
+ help='(Deprecated) \
+ Use "--input-port".',
+ metavar='PORT')
parser.add_argument('--output-edge-port',
type=int,
dest='edge_write_port',
default=7981,
- help='deprecated. \
- Edge port for writing realtime data, defaults to 7981')
+ help='(Deprecated) \
+ Use "--output-port".',
+ metavar='PORT')
parser.add_argument('--output-edge-cwb-port',
type=int,
dest='edge_write_port',
- default='7981',
- help='deprecated. \
- Edge port for writing older data. Not used by geomag.')
+ default=7981,
+ help='(Deprecated) \
+ Use "--output miniseed" and "--output-port PORT".',
+ metavar='PORT')
parser.add_argument('--output-edge-read-port',
type=int,
default=2060,
- help='deprecated. \
- Edge port for reading output data, defaults to 2060')
- parser.add_argument('--output-edge-tag',
- default='GEOMAG',
- help='ID Tag for edge connections, defaults to GEOMAG')
- parser.add_argument('--output-edge-forceout',
- action='store_true',
- default=False,
- help='Flag to force data into miniseed blocks. Should only ' +
- 'be used when certain the data is self contained.')
- # parser.add_argument('--realtime',
- # action='store_true',
- # default=False,
- # help='Flag to run the last hour if interval is minute, ' +
- # 'or the last 10 minutes if interval is seconds')
- parser.add_argument('--realtime',
- default=False,
- const=True,
- type=int,
- nargs='?',
- help='Flag to run the last hour if interval is minute, ' +
- 'the last 10 minutes if interval is seconds, ' +
- 'or the last N seconds if integer N is specified.')
- parser.add_argument('--input-goes-directory',
- default='.',
- help='Directory for support files for goes input of imfv283 data')
- parser.add_argument('--input-goes-getdcpmessages',
- default='',
- help='Location of getDcpMessages.')
- parser.add_argument('--input-goes-password',
- default='',
- help='Password for goes user')
- parser.add_argument('--input-goes-server',
- nargs='*',
- help='The server name(s) to retrieve the GOES data from')
- parser.add_argument('--input-goes-user',
- default='GEOMAG',
- help='The user name to use to retrieve data from GOES')
-
- # Input group
- input_group = parser.add_mutually_exclusive_group(required=True)
- input_group.add_argument('--input',
- help='Input format',
- choices=(
- 'edge',
- 'goes',
- 'iaga2002',
- 'imfv122',
- 'imfv283',
- 'miniseed',
- 'pcdcp'))
-
- # conversion factors for volts/bins
- parser.add_argument('--volt-conversion',
- default=100,
- help='Conversion factor for volts')
-
- parser.add_argument('--bin-conversion',
- default=500,
- help='Conversion factor for bins')
-
- # conversion from bins/volts to nT
- parser.add_argument('--convert-voltbin',
- nargs='*',
- default=None,
- help='Convert channels from bins/volts to nT')
-
- parser.add_argument('--input-file',
- help='Read from specified file')
- parser.add_argument('--input-host',
- default='cwbpub.cr.usgs.gov',
- help='Hostname or IP address')
- parser.add_argument('--input-port',
- default=2060,
- help='Port number',
- type=int)
- parser.add_argument('--input-stdin',
- action='store_true',
- default=False,
- help='Read from standard input')
- parser.add_argument('--input-url',
- help='Read from a url pattern')
- parser.add_argument('--input-url-interval',
- default=86400,
- help='Read url interval in seconds',
- type=int)
+ help='(Deprecated) \
+ Use "--output-read-port".',
+ metavar='PORT')
+ # input arguments (generally use "--input TYPE")
input_group.add_argument('--input-edge',
- help='deprecated. \
- Host IP #, see --input-edge-port for optional args')
+ help='(Deprecated) \
+ Use "--input edge" and "--input-host HOST".',
+ metavar='HOST')
input_group.add_argument('--input-iaga-file',
- help='deprecated. Reads from the specified file.')
+ help='(Deprecated) \
+ Use "--input iaga2002" and "--input-file FILE".',
+ metavar='FILE')
input_group.add_argument('--input-iaga-stdin',
action='store_true',
default=False,
- help='deprecated. \
- Pass in an iaga file using redirection from stdin.')
+ help='(Deprecated) \
+ Use "--input iaga2002" and "--input-stdin".')
input_group.add_argument('--input-iaga-url',
- help='deprecated. \
- Example: file://./%%(obs)s%%(ymd)s%%(t)s%%(i)s.%%(i)s')
+ help='(Deprecated) \
+ Use "--input iaga2002" and "--input-url URL".',
+ metavar='URL')
input_group.add_argument('--input-imfv283-file',
- help='deprecated. Reads from the specified file.')
+ help='(Deprecated) \
+ Use "--input imfv283" and "--input-file FILE".',
+ metavar='FILE')
input_group.add_argument('--input-imfv283-stdin',
action='store_true',
default=False,
- help='deprecated. \
- Pass in a file using redirection from stdin')
+ help='(Deprecated) \
+ Use "--input imfv283" and "--input-stdin"')
input_group.add_argument('--input-imfv283-url',
- help='deprecated. Example file://./')
+ help='(Deprecated) \
+ Use "--input iaga2002" and "--input-url URL".',
+ metavar='URL')
input_group.add_argument('--input-imfv283-goes',
action='store_true',
default=False,
- help='deprecated. \
- Retrieves data directly from a goes server to read')
+ help='(Deprecated) \
+ Use "--input goes".')
input_group.add_argument('--input-pcdcp-file',
- help='deprecated. Reads from the specified file.')
+ help='(Deprecated) \
+ Use "--input pcdcp" and "--input-file FILE".',
+ metavar='FILE')
input_group.add_argument('--input-pcdcp-stdin',
action='store_true',
default=False,
- help='deprecated. \
- Pass in an pcdcp file using redirection from stdin.')
+ help='(Deprecated) \
+ Use "--input pcddp" and "--input-stdin".')
input_group.add_argument('--input-pcdcp-url',
- help='deprecated. Example: file://./%%(obs)s%%(Y)s%%(j)s.%%(i)s')
-
- # Output group
- output_group = parser.add_mutually_exclusive_group(required=True)
+ help='(Deprecated) \
+ Use "--input pcdcp" and "--input-url URL".',
+ metavar='URL')
+ # output arguments (generally use "--output TYPE")
output_group.add_argument('--output-iaga-file',
- help='deprecated. Write to a single iaga file.')
+ help='(Deprecated) \
+ Use "--output iaga2002" and "--output-file FILE".',
+ metavar='FILE')
output_group.add_argument('--output-iaga-stdout',
action='store_true', default=False,
- help='deprecated. Write to stdout.')
+ help='(Deprecated) \
+ Use "--output iaga2002" and "--output-stdout".')
output_group.add_argument('--output-iaga-url',
- help='deprecated. \
- Example: file://./%%(obs)s%%(ymd)s%%(t)s%%(i)s.%%(i)s')
+ help='(Deprecated) \
+ Use "--output iaga2002" and "--output-url URL".',
+ metavar='URL')
output_group.add_argument('--output-pcdcp-file',
- help='deprecated. Write to a single pcdcp file.')
+ help='(Deprecated) \
+ Use "--output pcdcp" and "--output-file FILE".',
+ metavar='FILE')
output_group.add_argument('--output-pcdcp-stdout',
action='store_true', default=False,
- help='deprecated. Write to stdout.')
+ help='(Deprecated) \
+ Use "--output pcdcp" and "--output-stdout".')
output_group.add_argument('--output-pcdcp-url',
- help='deprecated. Example: file://./%%(obs)s%%(Y)s%%(j)s.%%(i)s')
+ help='(Deprecated) \
+ Use "--output pcdcp" and "--output-url URL".',
+ metavar='URL')
output_group.add_argument('--output-edge',
- help='deprecated. \
- Edge IP #. See --output-edge-* for other optional arguments')
+ help='(Deprecated) \
+ Use "--output edge" and "--output-host HOST".',
+ metavar='HOST')
output_group.add_argument('--output-plot',
action='store_true',
default=False,
- help='deprecated. Plot the algorithm output using matplotlib')
-
- # output arguments
- output_group.add_argument('--output',
- choices=(
- 'binlog',
- 'edge',
- 'iaga2002',
- 'imfjson',
- 'miniseed',
- 'pcdcp',
- 'plot',
- 'temperature',
- 'vbf'
- ),
- # TODO: set default to 'iaga2002'
- help='Output format')
-
- parser.add_argument('--output-file',
- help='Write to specified file')
- parser.add_argument('--output-host',
- default='cwbpub.cr.usgs.gov',
- help='Write to specified host')
- parser.add_argument('--output-port',
- default=7981,
- help='Write to specified port',
- type=int)
- parser.add_argument('--output-read-port',
- default=2061,
- help='Read from specified port',
- type=int)
- parser.add_argument('--output-stdout',
- action='store_true',
- default=False,
- help='Write to standard output')
- parser.add_argument('--output-url',
- help='Write to a file:// url pattern')
- parser.add_argument('--output-url-interval',
- default=86400,
- help='Output interval in seconds',
- type=int)
+ help='(Deprecated) \
+ Use "--output plot".')
- # Algorithms group
- parser.add_argument('--algorithm',
- choices=[k for k in algorithms],
- default='identity')
- for k in algorithms:
- algorithms[k].add_arguments(parser)
+def parse_deprecated_arguments(args):
+ # TODO: remove argument mapping in future version
+ # map legacy input arguments
+ usingDeprecated = False
+ if args.input_edge is not None:
+ args.input = 'edge'
+ args.input_host = args.input_edge
+ args.input_port = args.input_edge_port
+ usingDeprecated = True
+ elif args.input_iaga_file is not None:
+ args.input = 'iaga2002'
+ args.input_file = args.input_iaga_file
+ usingDeprecated = True
+ elif args.input_iaga_stdin:
+ args.input = 'iaga2002'
+ args.input_stdin = True
+ usingDeprecated = True
+ elif args.input_iaga_url is not None:
+ args.input = 'iaga2002'
+ args.input_url = args.input_iaga_url
+ usingDeprecated = True
+ elif args.input_imfv283_file is not None:
+ args.input = 'imfv283'
+ args.input_file = args.input_imfv283_file
+ usingDeprecated = True
+ elif args.input_imfv283_url is not None:
+ args.input = 'imfv283'
+ args.input_url = args.input_imfv283_url
+ usingDeprecated = True
+ elif args.input_imfv283_goes:
+ args.input = 'goes'
+ usingDeprecated = True
+ # map legacy output arguments
+ if args.output_edge is not None:
+ args.output = 'edge'
+ args.output_host = args.output_edge
+ args.output_port = args.edge_write_port
+ usingDeprecated = True
+ elif args.output_iaga_file is not None:
+ args.output = 'iaga2002'
+ args.output_file = args.output_iaga_file
+ usingDeprecated = True
+ elif args.output_iaga_stdout:
+ args.output = 'iaga2002'
+ args.output_stdout = True
+ usingDeprecated = True
+ elif args.output_iaga_url is not None:
+ args.output = 'iaga2002'
+ args.output_url = args.output_iaga_url
+ usingDeprecated = True
+ elif args.output_pcdcp_file is not None:
+ args.output = 'pcdcp'
+ args.output_file = args.output_pcdcp_file
+ usingDeprecated = True
+ elif args.output_pcdcp_stdout:
+ args.output = 'pcdcp'
+ args.output_stdout = True
+ usingDeprecated = True
+ elif args.output_pcdcp_url is not None:
+ args.output = 'pcdcp'
+ args.output_url = args.output_pcdcp_url
+ usingDeprecated = True
+ elif args.output_plot:
+ args.output = 'plot'
+ usingDeprecated = True
- return parser.parse_args(args)
+ if usingDeprecated:
+ print('WARNING: you are using deprecated arguments,' +
+ ' please update your usage', file=sys.stderr)
diff --git a/geomagio/ObservatoryMetadata.py b/geomagio/ObservatoryMetadata.py
index d7bf9d0c979da1c3183221e4572692dcd15e398b..a35776b8e1c037c6f7c943322671ebb083371e0a 100644
--- a/geomagio/ObservatoryMetadata.py
+++ b/geomagio/ObservatoryMetadata.py
@@ -1063,5 +1063,6 @@ class ObservatoryMetadata(object):
interval_specific = \
self.metadata[observatory]['interval_specific']
# stats['data_interval_type'] = data_interval_type[interval]
- for key in interval_specific[interval]:
- stats[key] = interval_specific[interval][key]
+ if interval in interval_specific:
+ for key in interval_specific[interval]:
+ stats[key] = interval_specific[interval][key]
diff --git a/geomagio/edge/EdgeFactory.py b/geomagio/edge/EdgeFactory.py
index 9b672df4d95b40abdba97306be47d1f37bdd8d7d..6940ee8c28243a81d34aa5cbc425f892a2f69e33 100644
--- a/geomagio/edge/EdgeFactory.py
+++ b/geomagio/edge/EdgeFactory.py
@@ -11,20 +11,11 @@ Edge is the USGS earthquake hazard centers replacement for earthworm.
from __future__ import absolute_import
import sys
-from io import BytesIO
import numpy
import numpy.ma
import obspy.core
from datetime import datetime
-# try:
-# # obspy 1.x
-# from obspy.clients import earthworm
-# except:
-# # obspy 0.x
-# from obspy import earthworm
-
-# use local version of earthworm client to test memory leak fix
-from . import client as earthworm
+from obspy.clients import earthworm
from .. import ChannelConverter, TimeseriesUtility
from ..TimeseriesFactory import TimeseriesFactory
@@ -138,24 +129,19 @@ class EdgeFactory(TimeseriesFactory):
raise TimeseriesFactoryException(
'Starttime before endtime "%s" "%s"' % (starttime, endtime))
- # need this until https://github.com/obspy/obspy/pull/1179
- # replace stdout
+ # obspy factories sometimes write to stdout, instead of stderr
original_stdout = sys.stdout
- temp_stdout = BytesIO()
try:
- sys.stdout = temp_stdout
+ # send stdout to stderr
+ sys.stdout = sys.stderr
# get the timeseries
timeseries = obspy.core.Stream()
for channel in channels:
data = self._get_timeseries(starttime, endtime, observatory,
channel, type, interval)
timeseries += data
- # restore stdout
finally:
- output = temp_stdout.getvalue()
- if output:
- sys.stderr.write(str(output))
- temp_stdout.close()
+ # restore stdout
sys.stdout = original_stdout
self._post_process(timeseries, starttime, endtime, channels)
@@ -474,6 +460,9 @@ class EdgeFactory(TimeseriesFactory):
type, interval)
data = self.client.get_waveforms(network, station, location,
edge_channel, starttime, endtime)
+ # make sure data is 32bit int
+ for trace in data:
+ trace.data = trace.data.astype('i4')
data.merge()
if data.count() == 0:
data += TimeseriesUtility.create_empty_trace(
diff --git a/geomagio/edge/MiniSeedFactory.py b/geomagio/edge/MiniSeedFactory.py
index aabf673b2d79d5791ab203ced018825659b7c864..9fea3bcb89446f9e1bf84982e2334fe1e8334e95 100644
--- a/geomagio/edge/MiniSeedFactory.py
+++ b/geomagio/edge/MiniSeedFactory.py
@@ -11,7 +11,6 @@ Edge is the USGS earthquake hazard centers replacement for earthworm.
from __future__ import absolute_import
import sys
-from io import BytesIO
import numpy
import numpy.ma
@@ -22,6 +21,7 @@ from .. import ChannelConverter, TimeseriesUtility
from ..TimeseriesFactory import TimeseriesFactory
from ..TimeseriesFactoryException import TimeseriesFactoryException
from ..ObservatoryMetadata import ObservatoryMetadata
+from .MiniSeedInputClient import MiniSeedInputClient
class MiniSeedFactory(TimeseriesFactory):
@@ -69,7 +69,6 @@ class MiniSeedFactory(TimeseriesFactory):
TimeseriesFactory.__init__(self, observatory, channels, type, interval)
self.client = miniseed.Client(host, port)
-
self.observatoryMetadata = observatoryMetadata or ObservatoryMetadata()
self.locationCode = locationCode
self.interval = interval
@@ -79,6 +78,7 @@ class MiniSeedFactory(TimeseriesFactory):
self.convert_channels = convert_channels
self.volt_conv = volt_conv
self.bin_conv = bin_conv
+ self.write_client = MiniSeedInputClient(self.host, self.write_port)
def get_timeseries(self, starttime, endtime, observatory=None,
channels=None, type=None, interval=None):
@@ -119,25 +119,19 @@ class MiniSeedFactory(TimeseriesFactory):
raise TimeseriesFactoryException(
'Starttime before endtime "%s" "%s"' % (starttime, endtime))
- # need this until https://github.com/obspy/obspy/pull/1179
- # replace stdout
+ # obspy factories sometimes write to stdout, instead of stderr
original_stdout = sys.stdout
- temp_stdout = BytesIO()
try:
- sys.stdout = temp_stdout
+ # send stdout to stderr
+ sys.stdout = sys.stderr
# get the timeseries
timeseries = obspy.core.Stream()
for channel in channels:
data = self._get_timeseries(starttime, endtime, observatory,
channel, type, interval)
timeseries += data
-
- # restore stdout
finally:
- output = temp_stdout.getvalue()
- if output:
- sys.stderr.write(str(output))
- temp_stdout.close()
+ # restore stdout
sys.stdout = original_stdout
if self.convert_channels is not None:
diff --git a/geomagio/edge/client.py b/geomagio/edge/client.py
deleted file mode 100644
index 15dd81592869fe7a6336fb0be561009ec06f58dd..0000000000000000000000000000000000000000
--- a/geomagio/edge/client.py
+++ /dev/null
@@ -1,234 +0,0 @@
-# -*- coding: utf-8 -*-
-"""
-Earthworm Wave Server client for ObsPy.
-
-:copyright:
- The ObsPy Development Team (devs@obspy.org) & Victor Kress
-:license:
- GNU Lesser General Public License, Version 3
- (https://www.gnu.org/copyleft/lesser.html)
-
-.. seealso:: http://www.isti2.com/ew/PROGRAMMER/wsv_protocol.html
-"""
-from __future__ import (absolute_import, division, print_function,
- unicode_literals)
-from future.builtins import * # NOQA @UnusedWildImport
-
-from fnmatch import fnmatch
-
-from obspy import Stream, UTCDateTime
-from .waveserver import get_menu, read_wave_server_v
-
-
-class Client(object):
- """
- A Earthworm Wave Server client.
-
- :type host: str
- :param host: Host name of the remote Earthworm Wave Server server.
- :type port: int
- :param port: Port of the remote Earthworm Wave Server server.
- :type timeout: int, optional
- :param timeout: Seconds before a connection timeout is raised (default is
- ``None``).
- :type debug: bool, optional
- :param debug: Enables verbose output of the connection handling (default is
- ``False``).
- """
- def __init__(self, host, port, timeout=None, debug=False):
- """
- Initializes a Earthworm Wave Server client.
-
- See :class:`obspy.clients.earthworm.client.Client` for all parameters.
- """
- self.host = host
- self.port = port
- self.timeout = timeout
- self.debug = debug
-
- def get_waveforms(self, network, station, location, channel, starttime,
- endtime, cleanup=True):
- """
- Retrieves waveform data from Earthworm Wave Server and returns an ObsPy
- Stream object.
-
- :type filename: str
- :param filename: Name of the output file.
- :type network: str
- :param network: Network code, e.g. ``'UW'``.
- :type station: str
- :param station: Station code, e.g. ``'TUCA'``.
- :type location: str
- :param location: Location code, e.g. ``'--'``.
- :type channel: str
- :param channel: Channel code, e.g. ``'BHZ'``. Last character (i.e.
- component) can be a wildcard ('?' or '*') to fetch `Z`, `N` and
- `E` component.
- :type starttime: :class:`~obspy.core.utcdatetime.UTCDateTime`
- :param starttime: Start date and time.
- :type endtime: :class:`~obspy.core.utcdatetime.UTCDateTime`
- :param endtime: End date and time.
- :return: ObsPy :class:`~obspy.core.stream.Stream` object.
- :type cleanup: bool
- :param cleanup: Specifies whether perfectly aligned traces should be
- merged or not. See :meth:`obspy.core.stream.Stream.merge` for
- ``method=-1``.
-
- .. rubric:: Example
-
- >>> from obspy.clients.earthworm import Client
- >>> client = Client("pubavo1.wr.usgs.gov", 16022)
- >>> dt = UTCDateTime() - 2000 # now - 2000 seconds
- >>> st = client.get_waveforms('AV', 'ACH', '', 'EHE', dt, dt + 10)
- >>> st.plot() # doctest: +SKIP
- >>> st = client.get_waveforms('AV', 'ACH', '', 'EH*', dt, dt + 10)
- >>> st.plot() # doctest: +SKIP
-
- .. plot::
-
- from obspy.clients.earthworm import Client
- from obspy import UTCDateTime
- client = Client("pubavo1.wr.usgs.gov", 16022, timeout=5)
- dt = UTCDateTime() - 2000 # now - 2000 seconds
- st = client.get_waveforms('AV', 'ACH', '', 'EHE', dt, dt + 10)
- st.plot()
- st = client.get_waveforms('AV', 'ACH', '', 'EH*', dt, dt + 10)
- st.plot()
- """
- # replace wildcards in last char of channel and fetch all 3 components
- if channel[-1] in "?*":
- st = Stream()
- for comp in ("Z", "N", "E"):
- channel_new = channel[:-1] + comp
- st += self.get_waveforms(network, station, location,
- channel_new, starttime, endtime,
- cleanup=cleanup)
- return st
- if location == '':
- location = '--'
- scnl = (station, channel, network, location)
- # fetch waveform
- tbl = read_wave_server_v(self.host, self.port, scnl, starttime,
- endtime, timeout=self.timeout)
- # create new stream
- st = Stream()
- for tb in tbl:
- st.append(tb.get_obspy_trace())
- if cleanup:
- st._cleanup()
- st.trim(starttime, endtime)
- return st
-
- def save_waveforms(self, filename, network, station, location, channel,
- starttime, endtime, format="MSEED", cleanup=True):
- """
- Writes a retrieved waveform directly into a file.
-
- :type filename: str
- :param filename: Name of the output file.
- :type network: str
- :param network: Network code, e.g. ``'UW'``.
- :type station: str
- :param station: Station code, e.g. ``'TUCA'``.
- :type location: str
- :param location: Location code, e.g. ``''``.
- :type channel: str
- :param channel: Channel code, e.g. ``'BHZ'``. Last character (i.e.
- component) can be a wildcard ('?' or '*') to fetch `Z`, `N` and
- `E` component.
- :type starttime: :class:`~obspy.core.utcdatetime.UTCDateTime`
- :param starttime: Start date and time.
- :type endtime: :class:`~obspy.core.utcdatetime.UTCDateTime`
- :param endtime: End date and time.
- :type format: str, optional
- :param format: Output format. One of ``"MSEED"``, ``"GSE2"``,
- ``"SAC"``, ``"SACXY"``, ``"Q"``, ``"SH_ASC"``, ``"SEGY"``,
- ``"SU"``, ``"WAV"``. See the Supported Formats section in method
- :meth:`~obspy.core.stream.Stream.write` for a full list of
- supported formats. Defaults to ``'MSEED'``.
- :type cleanup: bool
- :param cleanup: Specifies whether perfectly aligned traces should be
- merged or not. See :meth:`~obspy.core.stream.Stream.merge`,
- `method` -1 or :meth:`~obspy.core.stream.Stream._cleanup`.
- :return: None
-
- .. rubric:: Example
-
- >>> from obspy.clients.earthworm import Client
- >>> client = Client("pubavo1.wr.usgs.gov", 16022)
- >>> t = UTCDateTime() - 2000 # now - 2000 seconds
- >>> client.save_waveforms('AV.ACH.--.EHE.mseed',
- ... 'AV', 'ACH', '', 'EHE',
- ... t, t + 10, format='MSEED') # doctest: +SKIP
- """
- st = self.get_waveforms(network, station, location, channel, starttime,
- endtime, cleanup=cleanup)
- st.write(filename, format=format)
-
- def get_availability(self, network="*", station="*", location="*",
- channel="*"):
- """
- Gets a list of data available on the server.
-
- This method returns information about what time series data is
- available on the server. The query can optionally be restricted to
- specific network, station, channel and/or location criteria.
-
- :type network: str
- :param network: Network code, e.g. ``'UW'``, wildcards allowed.
- :type station: str
- :param station: Station code, e.g. ``'TUCA'``, wildcards allowed.
- :type location: str
- :param location: Location code, e.g. ``'--'``, wildcards allowed.
- :type channel: str
- :param channel: Channel code, e.g. ``'BHZ'``, wildcards allowed.
- :rtype: list
- :return: List of tuples with information on the available data. One
- tuple consists of network, station, location, channel
- (all strings), start time and end time
- (both as :class:`~obspy.core.utcdatetime.UTCDateTime`).
-
- .. rubric:: Example
-
- >>> from obspy.clients.earthworm import Client
- >>> client = Client("pubavo1.wr.usgs.gov", 16022, timeout=5)
- >>> response = client.get_availability(
- ... network="AV", station="ACH", channel="EH*")
- >>> print(response) # doctest: +ELLIPSIS +NORMALIZE_WHITESPACE
- [('AV',
- 'ACH',
- '--',
- 'EHE',
- UTCDateTime(...),
- UTCDateTime(...)),
- ('AV',
- 'ACH',
- '--',
- 'EHN',
- UTCDateTime(...),
- UTCDateTime(...)),
- ('AV',
- 'ACH',
- '--',
- 'EHZ',
- UTCDateTime(...),
- UTCDateTime(...))]
- """
- # build up possibly wildcarded trace id pattern for query
- if location == '':
- location = '--'
- pattern = ".".join((network, station, location, channel))
- # get overview of all available data, winston wave servers can not
- # restrict the query via network, station etc. so we do that manually
- response = get_menu(self.host, self.port, timeout=self.timeout)
- # reorder items and convert time info to UTCDateTime
- response = [(x[3], x[1], x[4], x[2], UTCDateTime(x[5]),
- UTCDateTime(x[6])) for x in response]
- # restrict results according to user input
- response = [x for x in response if fnmatch(".".join(x[:4]), pattern)]
- return response
-
-
-if __name__ == '__main__':
- import doctest
- doctest.testmod(exclude_empty=True)
diff --git a/geomagio/edge/waveserver.py b/geomagio/edge/waveserver.py
deleted file mode 100644
index 47ac57c5df5eb359e717856eecaf36447de8c943..0000000000000000000000000000000000000000
--- a/geomagio/edge/waveserver.py
+++ /dev/null
@@ -1,290 +0,0 @@
-# -*- coding: utf-8 -*-
-"""
-Low-level Earthworm Wave Server tools.
-
-:copyright:
- The ObsPy Development Team (devs@obspy.org) & Victor Kress
-:license:
- GNU Lesser General Public License, Version 3
- (https://www.gnu.org/copyleft/lesser.html)
-"""
-from __future__ import (absolute_import, division, print_function,
- unicode_literals)
-from future.builtins import * # NOQA @UnusedWildImport
-from future.utils import native_str
-
-import socket
-import struct
-import sys
-
-import numpy as np
-
-from obspy import Stream, Trace, UTCDateTime
-from obspy.core import Stats
-
-
-RETURNFLAG_KEY = {
- 'F': 'success',
- 'FR': 'requested data right (later) than tank contents',
- 'FL': 'requested data left (earlier) than tank contents',
- 'FG': 'requested data lie in tank gap',
- 'FB': 'syntax error in request',
- 'FC': 'data tank corrupt',
- 'FN': 'requested tank not found',
- 'FU': 'unknown error'
-}
-
-DATATYPE_KEY = {
- b't4': '>f4', b't8': '>f8',
- b's4': '>i4', b's2': '>i2',
- b'f4': '<f4', b'f8': '<f8',
- b'i4': '<i4', b'i2': '<i2'
-}
-
-
-def get_numpy_type(tpstr):
- """
- given a TraceBuf2 type string from header,
- return appropriate numpy.dtype object
- """
- dtypestr = DATATYPE_KEY[tpstr]
- tp = np.dtype(native_str(dtypestr))
- return tp
-
-
-class TraceBuf2(object):
- """
- """
- byteswap = False
- ndata = 0 # number of samples in instance
- inputType = None # NumPy data type
-
- def read_tb2(self, tb2):
- """
- Reads single TraceBuf2 packet from beginning of input byte array tb.
- returns number of bytes read or 0 on read fail.
- """
- if len(tb2) < 64:
- return 0 # not enough array to hold header
- head = tb2[:64]
- self.parse_header(head)
- nbytes = 64 + self.ndata * self.inputType.itemsize
- if len(tb2) < nbytes:
- return 0 # not enough array to hold data specified in header
- dat = tb2[64:nbytes]
- self.parse_data(dat)
- return nbytes
-
- def parse_header(self, head):
- """
- Parse tracebuf header into class variables
- """
- pack_str = b'2i3d7s9s4s3s2s3s2s2s'
- dtype = head[-7:-5]
- if dtype[0:1] in b'ts':
- endian = b'>'
- elif dtype[0:1] in b'if':
- endian = b'<'
- else:
- raise ValueError
- self.inputType = get_numpy_type(dtype)
- (self.pinno, self.ndata, ts, te, self.rate, self.sta, self.net,
- self.chan, self.loc, self.version, tp, self.qual, _pad) = \
- struct.unpack(endian + pack_str, head)
- if not tp.startswith(dtype):
- msg = 'Error parsing header: %s!=%s'
- print(msg % (dtype, tp), file=sys.stderr)
- self.start = UTCDateTime(ts)
- self.end = UTCDateTime(te)
- return
-
- def parse_data(self, dat):
- """
- Parse tracebuf char array data into self.data
- """
- self.data = np.fromstring(dat, self.inputType)
- ndat = len(self.data)
- if self.ndata != ndat:
- msg = 'data count in header (%d) != data count (%d)'
- print(msg % (self.nsamp, ndat), file=sys.stderr)
- self.ndata = ndat
- return
-
- def get_obspy_trace(self):
- """
- Return class contents as obspy.Trace object
- """
- stat = Stats()
- stat.network = self.net.split(b'\x00')[0].decode()
- stat.station = self.sta.split(b'\x00')[0].decode()
- location = self.loc.split(b'\x00')[0].decode()
- if location == '--':
- stat.location = ''
- else:
- stat.location = location
- stat.channel = self.chan.split(b'\x00')[0].decode()
- stat.starttime = UTCDateTime(self.start)
- stat.sampling_rate = self.rate
- stat.npts = len(self.data)
- return Trace(data=self.data, header=stat)
-
-
-def send_sock_req(server, port, req_str, timeout=None):
- """
- Sets up socket to server and port, sends req_str
- to socket and returns open socket
- """
- s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
- s.settimeout(timeout)
- s.connect((server, port))
- if req_str[-1:] == b'\n':
- s.send(req_str)
- else:
- s.send(req_str + b'\n')
- return s
-
-
-def get_sock_char_line(sock, timeout=10.):
- """
- Retrieves one newline terminated string from input open socket
- """
- sock.settimeout(timeout)
- chunks = []
- indat = b'^'
- try:
- while indat[-1:] != b'\n':
- # see https://github.com/obspy/obspy/issues/383
- # indat = sock.recv(8192)
- indat = sock.recv(1)
- if not indat:
- break
- chunks.append(indat)
- except socket.timeout:
- print('socket timeout in get_sock_char_line()', file=sys.stderr)
- return None
- if chunks:
- response = b''.join(chunks)
- return response
- else:
- return None
-
-
-def get_sock_bytes(sock, nbytes, timeout=None):
- """
- Listens for nbytes from open socket.
- Returns byte array as python string or None if timeout
- """
- sock.settimeout(timeout)
- chunks = []
- btoread = nbytes
- try:
- while btoread:
- indat = sock.recv(min(btoread, 8192))
- if not indat:
- break
- btoread -= len(indat)
- chunks.append(indat)
- except socket.timeout:
- print('socket timeout in get_sock_bytes()', file=sys.stderr)
- return None
- if chunks:
- response = b''.join(chunks)
- return response
- else:
- return None
-
-
-def get_menu(server, port, scnl=None, timeout=None):
- """
- Return list of tanks on server
- """
- rid = 'get_menu'
- if scnl:
- # only works on regular waveservers (not winston)
- getstr = 'MENUSCNL: %s %s %s %s %s\n' % (
- rid, scnl[0], scnl[1], scnl[2], scnl[3])
- else:
- # added SCNL not documented but required
- getstr = 'MENU: %s SCNL\n' % rid
- sock = send_sock_req(server, port, getstr.encode('ascii', 'strict'),
- timeout=timeout)
- r = get_sock_char_line(sock, timeout=timeout)
- sock.close()
- if r:
- # XXX: we got here from bytes to utf-8 to keep the remaining code
- # intact
- tokens = str(r.decode()).split()
- if tokens[0] == rid:
- tokens = tokens[1:]
- flag = tokens[-1]
- if flag in ['FN', 'FC', 'FU']:
- msg = 'request returned %s - %s'
- print(msg % (flag, RETURNFLAG_KEY[flag]), file=sys.stderr)
- return []
- if tokens[7].encode() in DATATYPE_KEY:
- elen = 8 # length of return entry if location included
- elif tokens[6].encode() in DATATYPE_KEY:
- elen = 7 # length of return entry if location omitted
- else:
- print('no type token found in get_menu', file=sys.stderr)
- return []
- outlist = []
- for p in range(0, len(tokens), elen):
- l = tokens[p:p + elen]
- if elen == 8:
- outlist.append((int(l[0]), l[1], l[2], l[3], l[4],
- float(l[5]), float(l[6]), l[7]))
- else:
- outlist.append((int(l[0]), l[1], l[2], l[3], '--',
- float(l[4]), float(l[5]), l[6]))
- return outlist
- return []
-
-
-def read_wave_server_v(server, port, scnl, start, end, timeout=None):
- """
- Reads data for specified time interval and scnl on specified waveserverV.
-
- Returns list of TraceBuf2 objects
- """
- rid = 'rwserv'
- scnlstr = '%s %s %s %s' % scnl
- reqstr = 'GETSCNLRAW: %s %s %f %f\n' % (rid, scnlstr, start, end)
- sock = send_sock_req(server, port, reqstr.encode('ascii', 'strict'),
- timeout=timeout)
- r = get_sock_char_line(sock, timeout=timeout)
- if not r:
- return []
- tokens = str(r.decode()).split()
- flag = tokens[6]
- if flag != 'F':
- msg = 'read_wave_server_v returned flag %s - %s'
- print(msg % (flag, RETURNFLAG_KEY[flag]), file=sys.stderr)
- return []
- nbytes = int(tokens[-1])
- dat = get_sock_bytes(sock, nbytes, timeout=timeout)
- sock.close()
- tbl = []
- new = TraceBuf2() # empty..filled below
- bytesread = 1
- p = 0
- while bytesread and p < len(dat):
- bytesread = new.read_tb2(dat[p:])
- if bytesread:
- tbl.append(new)
- new = TraceBuf2() # empty..filled on next iteration
- p += bytesread
- return tbl
-
-
-def trace_bufs2obspy_stream(tbuflist):
- """
- Returns obspy.Stream object from input list of TraceBuf2 objects
- """
- if not tbuflist:
- return None
- tlist = []
- for tb in tbuflist:
- tlist.append(tb.get_obspy_trace())
- strm = Stream(tlist)
- return strm