Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement review suggestions #22

Merged
merged 3 commits into from
Nov 5, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion joss/paper.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ of different components of the rotated seismogram.
``rf`` is a Python package for calculating receiver functions. It provides the ``RFStream`` class which extents Obspy's
``Stream`` class [@obspy] with functionality needed for receiver function calculation.
Among those are, waveform input/output with metadata preservation,
calculation of incidence angles for rotation of waves into LQT system,
calculation of incidence angles for rotation of waves into ZRT or LQT coordinate systems,
frequency domain or time domain deconvolution techniques, move-out correction,
calculation of and stacking by piercing points.
Receiver functions of S to P converted waves can also be calculated.
Expand Down
21 changes: 19 additions & 2 deletions rf/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@
Firstly, the S-wave field is separated from the P-wave field by a rotation
from the station coordinate system (ZNE - vertical, north, east)
to the wave coordinate system (LQT - P-wave polarization,
approx. SV-wave polarization, SH-wave polarization).
approx. SV-wave polarization, SH-wave polarization). Alternatively, it is
possible to rotate to the ZRT coordinate system (vertical, radial, transverse).
Secondly, the waveform on the L component is deconvolved from the other
components, which removes source side and propagation effects.
The resulting functions are the Q and T component of the P receiver function.
Expand Down Expand Up @@ -79,7 +80,9 @@
rf-runtests

For OSX the package ``gfortran_osx-64`` must be used instead of ``gfortran_linux-64``.
For Windows you need to install the FORTRAN compiler yourself (MinGW).
For Windows you need to install the FORTRAN compiler yourself (MinGW). Often, problems
with the compilation of Fortran codes (toeplitz package) can be solved by setting
``export NPY_DISTUTILS_APPEND_FLAGS=1``.

Using the Python module
-----------------------
Expand Down Expand Up @@ -188,6 +191,16 @@
RFStream provides the possibility to perform moveout correction,
piercing point calculation and profile stacking.

Tutorials
---------

The following Jupyter notebooks can be viewed online or downloaded
to be locally reproduced.

1. Calculate receiver functions - minimal example (notebook1_)
2. Calculate receiver functions and stack them by common conversion points
to create a profile (notebook2_)

Command line tool for batch processing
--------------------------------------

Expand Down Expand Up @@ -236,6 +249,10 @@
.. _pip: http://www.pip-installer.org/
.. _obspyh5: https://github.com/trichter/obspyh5/
.. _toeplitz: https://github.com/trichter/toeplitz/

.. _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

.. _GitHub: https://github.com/trichter/rf/
.. |buildstatus| image:: https://api.travis-ci.org/trichter/rf.png?
branch=master
Expand Down