Skip to content

Commit 1c6935d

Browse files
committed
Improve docstrings and messages in waveforms.py
Replace "download" with "get", since the waveforms are not always downloaded from the web, but can be read from local files.
1 parent 60d1387 commit 1c6935d

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

requake/waveforms/waveforms.py

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# -*- coding: utf8 -*-
22
# SPDX-License-Identifier: GPL-3.0-or-later
33
"""
4-
Functions for downloading and processing waveforms.
4+
Functions for fetching and processing waveforms.
55
66
:copyright:
77
2021-2025 Claudio Satriano <satriano@ipgp.fr>
@@ -164,7 +164,7 @@ def _get_event_waveform_from_client(evid, traceid, p_arrival_time):
164164
except NoWaveformError as err:
165165
msg = str(err).replace('\n', ' ')
166166
raise NoWaveformError(
167-
f'Unable to download waveform data for event {evid} '
167+
f'Unable to get waveform data for event {evid} '
168168
f'and trace_id {traceid}. '
169169
'Skipping event.\n'
170170
f'Error message: {msg}'
@@ -222,7 +222,8 @@ def _get_event_waveform_from_event_data_path(evid, traceid):
222222

223223
def get_event_waveform(ev):
224224
"""
225-
Download waveform for a given event and for trace_id defined in the config.
225+
Get waveform for a given event and for trace_id defined in the config
226+
or passed as a command line argument.
226227
227228
:param ev: an event
228229
:type ev: RequakeEvent
@@ -249,7 +250,7 @@ def get_event_waveform(ev):
249250
except MetadataMismatchError as err:
250251
msg = str(err).replace('\n', ' ')
251252
raise NoWaveformError(
252-
f'Unable to download waveform data for event {evid} '
253+
f'Unable to get waveform data for event {evid} '
253254
f'and trace_id {traceid}. '
254255
'Skipping event.\n'
255256
f'Error message: {msg}'
@@ -353,7 +354,7 @@ def process_waveforms(tr_or_st):
353354

354355
def get_waveform_pair(pair):
355356
"""
356-
Download traces for a given pair.
357+
Get waveforms for a given pair.
357358
358359
:param pair: pair of events
359360
:type pair: tuple of RequakeEvent

0 commit comments

Comments
 (0)