Skip to content

Commit

Permalink
Merge pull request #250 from rmodrak/master
Browse files Browse the repository at this point in the history
Revised docs
  • Loading branch information
rmodrak committed Feb 6, 2024
2 parents 90ad897 + 82f94d7 commit 568e49a
Show file tree
Hide file tree
Showing 7 changed files with 217 additions and 200 deletions.
4 changes: 3 additions & 1 deletion docs/install/issues.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,14 @@ We note that some versions of GMT and ObsPy do not plot `full moment tensors <ht
Speeding up conda installs
--------------------------

Sometimes the conda package manager can be very slow. To speed it up, older conda installations can be updated, making libmamba the default dependency solver:
Older versions of the conda package manager can be very slow. For a significant potential speed up, conda can be updated as follows:

.. code::
conda update -n base conda
For reference, the largest potential speed up comes from the new `mamba <https://conda.org/blog/2023-11-06-conda-23-10-0-release>`_ dependency solver, which was `adopted <https://conda.org/blog/2023-11-06-conda-23-10-0-release>`_ in the 23.10 release.



MTUQ installation on Apple M1 and Apple M2 Macs
Expand Down
2 changes: 1 addition & 1 deletion docs/user_guide/01.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Learning Python and ObsPy
=========================

To avoid reinventing the wheel, MTUQ makes extensive use of `ObsPy <https://github.com/obspy/obspy/wiki>`_, a Python package for seismology. If you're not familiar with Python or ObsPy, an excellent place to start is the `ObsPy tutorial <http://docs.obspy.org/tutorial/index.html>`_.
To avoid reinventing the wheel, MTUQ makes extensive use of `ObsPy <https://github.com/obspy/obspy/wiki>`_, a Python package for seismology. An excellent place to start, to become familiar with Python and ObsPy, is the `ObsPy tutorial <http://docs.obspy.org/tutorial/index.html>`_.



4 changes: 2 additions & 2 deletions docs/user_guide/03.rst
Original file line number Diff line number Diff line change
Expand Up @@ -79,9 +79,9 @@ Once opened, an AxiSEM or FK database client can be used to generate `GreensTens
Computing Green's functions from 3D Earth models
------------------------------------------------

MTUQ currently supports 3D Green's functions from SPECFEM3D.
MTUQ currently supports 3D Green's functions from SPECFEM3D/3D_GLOBE.

To generate a complete Green's function database for a given hypocenter and depth, six SPECFEM3D wavefield simulations are required. Output must be saved as SAC files at individual stations using the following filename convention, which comes from `GRD_CMT3D <https://github.com/UTCompSeismo/GRD_CMT3D/tree/master/cmt3d>`_. Place all SAC files corresponding to a single hypocenter and depth in the same directory as follows:
To generate a complete Green's function database for a given hypocenter and depth, six SPECFEM3D wavefield simulations are required. Output must be saved as/converted to SAC files at individual stations using the following filename convention, which comes from `GRD_CMT3D <https://github.com/UTCompSeismo/GRD_CMT3D/tree/master/cmt3d>`_. Place all SAC files corresponding to a single hypocenter and depth in the same directory as follows:

.. code ::
Expand Down
7 changes: 3 additions & 4 deletions docs/user_guide/04.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Data processing choices include filter type, window length, and many others. For



With `mtuq.ProcessData`, the choice of data processing parameters is clearly separated from the application of the data processing function to the seismic data, resulting in a two-step procedure.
With `mtuq.ProcessData`, the choice of data processing parameters is clearly separated from the application of the data processing function to seismic data, resulting in a two-step procedure.

In the first step, the user supplies parameters to create a data processing function:

Expand All @@ -37,8 +37,7 @@ Data processing can also be applied to an entire `Dataset` at once:
processed_data = mtuq.Dataset()
for stream in raw_data:
processed_stream = process_data(stream)
processed_data += processed_stream
processed_data += process_data(stream)
Or, more succinctly:
Expand All @@ -52,7 +51,7 @@ Or, more succinctly:
Requirements for processed data
-------------------------------

For computational efficiency and software engineering reasons, processed traces must satisfy:
Processed traces must satisfy:

1. all traces must have the same sampling rate and number of samples
2. all traces common to the same station must have the same startime and endtime
Expand Down
2 changes: 1 addition & 1 deletion mtuq/process_data.py
Original file line number Diff line number Diff line change
Expand Up @@ -726,7 +726,7 @@ def __call__(self, traces, station=None, origin=None, overwrite=False):
starttime += self.time_shift_min
endtime += self.time_shift_max

trace.stats.npts_padding_left = int(round(-self.time_shift_max/dt))
trace.stats.npts_padding_left = int(round(-self.time_shift_min/dt))
trace.stats.npts_padding_right = int(round(+self.time_shift_max/dt))


Expand Down
1 change: 1 addition & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ def run_tests(self):
'FK = mtuq.io.clients.FK_SAC:Client',
'FK_SAC = mtuq.io.clients.FK_SAC:Client',
'SPECFEM3D = mtuq.io.clients.SPECFEM3D_SAC:Client',
'SPECFEM3D_GLOBE = mtuq.io.clients.SPECFEM3D_SAC:Client',
'SPECFEM3D_SAC = mtuq.io.clients.SPECFEM3D_SAC:Client',
'SPECFEM3D_SGT = mtuq.io.clients.SPECFEM3D_SGT:Client',
'SPECFEM3D_PKL = mtuq.io.clients.SPECFEM3D_SGT:Client',
Expand Down
Loading

0 comments on commit 568e49a

Please sign in to comment.