From c7e1f6f32481008b14666ad894c9aa893ab305b0 Mon Sep 17 00:00:00 2001 From: Hannah Mark Date: Thu, 9 May 2024 14:09:32 -0400 Subject: [PATCH] update docs for harmonics --- docs/index.rst | 5 +++++ rf/__init__.py | 6 +++++- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index af4463a..a533bfd 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -32,6 +32,11 @@ API Documentation .. automodule:: rf.simple_model +:mod:`!harmonics` Module +--------------------------- + +.. automodule:: rf.harmonics + :mod:`!util` Module ------------------------- diff --git a/rf/__init__.py b/rf/__init__.py index 4fc67d2..cd36b1b 100644 --- a/rf/__init__.py +++ b/rf/__init__.py @@ -190,7 +190,9 @@ Please see `.RFStream.rf()` for a more detailed description. RFStream provides the possibility to perform moveout correction, -piercing point calculation and profile stacking. +piercing point calculation and profile stacking. +There are also functions included for calculating back-azimuthal harmonics +from an RFStream. Tutorials --------- @@ -203,6 +205,7 @@ to create a profile (notebook2_) 3. Calculate and compare receiver functions calculated with different deconvolution methods (notebook3_) + 4. Harmonic deconvolution with synthetics - minimal example (notebook4_) Command line tool for batch processing -------------------------------------- @@ -264,6 +267,7 @@ .. _notebook1: http://nbviewer.jupyter.org/github/trichter/notebooks/blob/master/receiver_function_minimal_example.ipynb .. _notebook2: http://nbviewer.jupyter.org/github/trichter/notebooks/blob/master/receiver_function_profile_chile.ipynb .. _notebook3: https://nbviewer.jupyter.org/github/hfmark/notebooks/blob/main/rf_comparison.ipynb +.. _notebook4: https://nbviewer.jupyter.org/github/hfmark/notebooks/blob/main/rf_harmonics.ipynb .. _GitHub: https://github.com/trichter/rf/ """