Skip to content

Align moment magnitude overload defaults with the implementations #105

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.

Sign up for GitHub

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

Merged
lispandfound merged 2 commits into from
Sep 9, 2026
Merged

Align moment magnitude overload defaults with the implementations #105

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d420858
Align moment magnitude overload defaults with the implementations
lispandfound Sep 8, 2026
06856cb
Pass bold_m=False where an Mw is given to magnitude_to_moment
lispandfound Sep 8, 2026
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
8 changes: 4 additions & 4 deletions source_modelling/moment.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,11 +134,11 @@ def moment_rate_over_time_from_slip(

@typing.overload
def moment_to_magnitude(
moment: float, bold_m: typing.Literal[True]
moment: float, bold_m: typing.Literal[True] = True
) -> BoldM: ... # numpydoc ignore=GL08
@typing.overload
def moment_to_magnitude(
moment: float, bold_m: typing.Literal[False] = False
moment: float, bold_m: typing.Literal[False]
) -> Mw: ... # numpydoc ignore=GL08
def moment_to_magnitude(moment: float, bold_m: bool = True) -> BoldM | Mw:
"""Convert moment to magnitude.
Expand Down Expand Up @@ -189,11 +189,11 @@ def moment_to_magnitude(moment: float, bold_m: bool = True) -> BoldM | Mw:

@typing.overload
def magnitude_to_moment(
magnitude: BoldM, bold_m: typing.Literal[True]
magnitude: BoldM, bold_m: typing.Literal[True] = True
) -> float: ... # numpydoc ignore=GL08
@typing.overload
def magnitude_to_moment(
magnitude: Mw, bold_m: typing.Literal[False] = False
magnitude: Mw, bold_m: typing.Literal[False]
) -> float: ... # numpydoc ignore=GL08
def magnitude_to_moment(magnitude: BoldM | Mw, bold_m: bool = True) -> float:
"""Convert magnitude to moment.
Expand Down
2 changes: 1 addition & 1 deletion tests/test_moment.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ def test_point_source_slip_bad_dataframe():
}
)

moment_newton_metre = moment.magnitude_to_moment(Mw(5.0))
moment_newton_metre = moment.magnitude_to_moment(Mw(5.0), bold_m=False)

# Should raise KeyError when trying to access missing columns
with pytest.raises(KeyError):
Expand Down
Loading