Skip to content

Commit

Permalink
Docs: small cosmetic fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
claudiodsf committed May 3, 2024
1 parent c755ae5 commit ac7f90e
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 13 deletions.
6 changes: 2 additions & 4 deletions docs/performances.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
Performances
------------

*
``requake scan_catalog`` took 53 minutes on my 2.7 GHz i7 MacBook Pro to
* ``requake scan_catalog`` took 53 minutes on my 2.7 GHz i7 MacBook Pro to
process 14,100,705 earthquake pairs.
Dowloaded traces are cached in memory to speed up execution. Processing is not
yet parallel: some improvements might come in future versions, when
parallelization will be implemented.

*
``requake build_families`` is fast™.
* ``requake build_families`` is fast™.
14 changes: 7 additions & 7 deletions docs/running.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Currently supported verbs are:
read_catalog read an event catalog from web services or from a file
print_catalog print the event catalog to screen
scan_catalog scan an existing catalog for earthquake pairs
print_pairs print pairs to screen
print_pairs print pairs to screen
plot_pair plot traces for a given event pair
build_families build families of repeating earthquakes from a catalog
of pairs
Expand All @@ -40,13 +40,13 @@ Currently supported verbs are:
templates
Certain running modes (e.g., ``plot_pair``\ ) require further arguments (use, e.g.,
``requake plot_pair -h`` to get help).
Certain running modes (e.g., ``plot_pair``\ ) require further arguments
(use, e.g., ``requake plot_pair -h`` to get help).

Requake supports command line tab completion for arguments, thanks to
`argcomplete <https://kislyuk.github.io/argcomplete/>`_.
To enable command line tab completion, add the following line to your ``.bashrc``
or ``.zshrc``\ :
To enable command line tab completion, add the following line to your
``.bashrc`` or ``.zshrc``:

.. code-block::
Expand Down Expand Up @@ -86,8 +86,8 @@ Now, build the catalog of event pairs with:
requake scan_catalog
Once done (\ `it will take time! <performances.html#performances>`_\ ), you are ready to build
repeating earthquake families:
Once done (\ `it will take time! <performances.html#performances>`_\ ),
you are ready to build repeating earthquake families:

.. code-block::
Expand Down
4 changes: 2 additions & 2 deletions docs/slip_models.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ Their model for fault slip :math:`d` (in :math:`\cm`) is the following:
\right]
where :math:`\Delta\sigma` is the static stress drop (in :math:`\MPa`),
:math:`\mu` is the rigidity (in :math:`\MPa`), :math:`M_0` is the seismic moment
(in :math:`\Nm`), and :math:`C` is the strain hardening coefficient
:math:`\mu` is the rigidity (in :math:`\MPa`), :math:`M_0` is the seismic
moment (in :math:`\Nm`), and :math:`C` is the strain hardening coefficient
(in :math:`\MPacm`).

This formula is selected by setting the ``mag_to_slip_model`` parameter to
Expand Down

0 comments on commit ac7f90e

Please sign in to comment.