Skip to content

Commit

Permalink
update docs for harmonics
Browse files Browse the repository at this point in the history
  • Loading branch information
hfmark committed May 22, 2024
1 parent 00c3d5a commit c7e1f6f
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
5 changes: 5 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,11 @@ API Documentation

.. automodule:: rf.simple_model

:mod:`!harmonics` Module
---------------------------

.. automodule:: rf.harmonics

:mod:`!util` Module
-------------------------

Expand Down
6 changes: 5 additions & 1 deletion rf/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
---------
Expand All @@ -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
--------------------------------------
Expand Down Expand Up @@ -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/
"""
Expand Down

0 comments on commit c7e1f6f

Please sign in to comment.