search

eqcorrscan / EQcorrscan

Earthquake detection and analysis in Python.
https://eqcorrscan.readthedocs.io/en/latest/
Other
167 stars 86 forks source link

DOC: clarification about the `return_stream` argument of the `detect` method, broken link, typo #590

Open zhong-yy opened 3 days ago

zhong-yy commented 3 days ago

Thank you for developing and maintaining this powerful tool. I just started to use this package and had some confusion when reading the tutorial.

(1) Is the data returned by client_detect preprocessed or raw?

In tutorial 5.1, in the explanation of the arguments of client_detect, setting return_stream to True is said to return a pre-processed stream. However, in the later processing, the stream is considered unprocessed. Which statement is correct?

After a bit investigation, I guess the raw data is returned? https://github.com/eqcorrscan/EQcorrscan/blob/fa424aae8905464e60f738f08245f169af85a7e4/eqcorrscan/core/match_filter/tribe.py#L1471 https://github.com/eqcorrscan/EQcorrscan/blob/fa424aae8905464e60f738f08245f169af85a7e4/eqcorrscan/core/match_filter/helpers/processes.py#L228-L229

(2) The link to the template creation notebook is broken: See here.

(3) typo in an example

https://eqcorrscan.readthedocs.io/en/latest/tutorials/matched-filter.html#:~:text=all%22%2C%0A%20%20%20%20process_len%3D3600%2C-,all_horix%3DTrue,-%2C%0A%20%20%20%20min_snr%3D4.0%2C%0A%20%20%20%20parallel'

Should all_horix be all_horiz?