Skip to content

Commit

Permalink
fix: formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
@lmizrahi
lmizrahi committed Aug 27, 2024
1 parent b3b02a1 commit cd83138
Showing 1 changed file with 13 additions and 11 deletions.
24 changes: 13 additions & 11 deletions seismostats/analysis/estimate_a.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ def estimate_a(magnitudes: np.ndarray,
times=None,
method: str = "classic",
) -> float:
"""Return the a-value of the Gutenberg-Richter (GR) law.
r"""Return the a-value of the Gutenberg-Richter (GR) law.
.. math::
N(m) = 10 ^ {a - b \cdot (m - m_{ref})}
where N(m) is the number of events with magnitude larger or equal to m
where N(m) is the number of events with magnitude larger or equal to m
that occurred in the timeframe of the catalog.
Args:
Expand All @@ -36,13 +36,13 @@ def estimate_a(magnitudes: np.ndarray,
mc: completeness magnitude.
If given, magnitudes below mc are disregarded.
If None, the catalog is assumed to be complete and
mc is set to the smallest magnitude in the catalog.
mc is set to the smallest magnitude in the catalog.
This is only relevant when m_ref is not None.
b_value: b-value of the Gutenberg-Richter law. Only relevant
when m_ref is not None.
delta_m: discretization of magnitudes. default is no discretization
times: vector of times of the events, in any format (datetime, float, etc.)
Only needed when method is "positive".
times: vector of times of the events, in any format (datetime,
float, etc.) Only needed when method is "positive".
method: Method to estimate the a-value. Options are "classic" and
"positive".
Expand Down Expand Up @@ -72,12 +72,12 @@ def estimate_a_classic(magnitudes: np.ndarray,
b_value: float | None = None,
delta_m: float = None,
) -> float:
"""Return the a-value of the Gutenberg-Richter (GR) law.
r"""Return the a-value of the Gutenberg-Richter (GR) law.
.. math::
N(m) = 10 ^ {a - b \cdot (m - m_{ref})}
where N(m) is the number of events with magnitude larger or equal to m
where N(m) is the number of events with magnitude larger or equal to m
that occurred in the timeframe of the catalog.
Args:
Expand All @@ -91,7 +91,7 @@ def estimate_a_classic(magnitudes: np.ndarray,
mc: completeness magnitude.
If given, magnitudes below mc are disregarded.
If None, the catalog is assumed to be complete and
mc is set to the smallest magnitude in the catalog.
mc is set to the smallest magnitude in the catalog.
This is only relevant when m_ref is not None.
b_value: b-value of the Gutenberg-Richter law. Only relevant
when m_ref is not None.
Expand Down Expand Up @@ -143,8 +143,10 @@ def estimate_a_positive(
Args:
magnitudes: vector of magnitudes, unsorted
times: vector of times of the events, in any format (datetime, float, etc.)
delta_m: discretization of the magnitudes. default is no discretization
times: vector of times of the events, in any format (datetime,
float, etc.)
delta_m: discretization of the magnitudes.
default is no discretization
dmc: minimum magnitude difference between consecutive events.
If None, the default value is delta_m.
scaling_factor: scaling factor. If given, this is used to normalize
Expand All @@ -156,7 +158,7 @@ def estimate_a_positive(
mc: completeness magnitude.
If given, magnitudes below mc are disregarded.
If None, the catalog is assumed to be complete and
mc is set to the smallest magnitude in the catalog.
mc is set to the smallest magnitude in the catalog.
This is only relevant when m_ref is not None.
b_value: b-value of the Gutenberg-Richter law. Only relevant
when m_ref is not None.
Expand Down

0 comments on commit cd83138

Please sign in to comment.