Skip to content

Commit

Permalink
Merge pull request #32 from trichter/fix_docbuild
Browse files Browse the repository at this point in the history
fix docs build on rtd
  • Loading branch information
trichter authored Jan 21, 2021
2 parents 18372d6 + fae75e7 commit 49d228b
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 4 deletions.
6 changes: 6 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
version: 2
python:
version: 3.8
install:
- requirements: docs/requirements.txt
6 changes: 3 additions & 3 deletions rf/deconvolve.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ def deconvolve(stream, method='time', func=None,
:param func: Custom deconvolution function with the following signature
def deconv_custom(rsp: RFStream, src: RFTrace, tshift=10,
**other_kwargs_possible) -> RFStream:
\*\*other_kwargs_possible) -> RFStream:
:param source_components: names of components identifying the source traces,
e.g. 'LZ' for P receiver functions and 'QR' for S receiver functions
Expand Down Expand Up @@ -547,8 +547,8 @@ def deconv_multitaper(rsp, src, nse, sampling_rate, tshift, gauss=0.5,
Deconvolve src from arrays in rsp.
Based on mtdecon.f by G. Helffrich with some slight modifications
References:
References:
Helffrich, G (2006). Extended-time multitaper frequency domain
cross-correlation receiver function estimation. Bulletin of the
Seismological Society of America, 96 (1).
Expand Down
3 changes: 2 additions & 1 deletion rf/rfstream.py
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,8 @@ def rf(self, method=None, filter=None, trim=None, downsample=None,
frequency domain multitaper deconvolution using the stream's
`deconvolve()`
method. See `~.deconvolve.deconvolve()`,
`.deconvt()`, `.deconvf()`, `deconv_iter()`, and `deconv_multi()`
`.deconv_time()`, `.deconv_waterlevel()`,
`.deconv_iterative()`, and `.deconv_multitaper()`
for further documentation.
:param source_components: parameter is passed to deconvolve.
If None, source components will be chosen depending on method.
Expand Down

0 comments on commit 49d228b

Please sign in to comment.