Skip to content

Commit

Permalink
Add a warning to docstrings of SC_REM models
Browse files Browse the repository at this point in the history
The `SC_REM_*` models are from a paper which has now been
retracted (https://doi.org/10.1093/gji/ggae004), so add a
warning to the docstrings for these models, and a note that
they may be removed in a breaking version change.
  • Loading branch information
anowacki committed Feb 12, 2024
1 parent 6a9cc6a commit e229b0b
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions src/Earth/sc_rem.jl
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,12 @@ let data_path = joinpath(@__DIR__, "..", "..", "data", "Earth", "SC_REM")
"""
# `$($model_name)`
!!! warning "Retracted model"
The $($model_name) model has been retracted by the authors and
is only retained in SeisModels to retain compatibility.
Future major versions of SeisModels may remove this model.
$($lower_upper) bound of the $($percent)% credible interval of the SC-REM model of
Kemper et al. (2023).
Expand All @@ -34,6 +40,9 @@ let data_path = joinpath(@__DIR__, "..", "..", "data", "Earth", "SC_REM")
## References
- Retraction of: Self-consistent models of Earth's mantle and core from long-period seismic and tidal constraints,
Geophysical Journal International, Volume 236, Issue 3, March 2024, Page 1439,
https://doi.org/10.1093/gji/ggae004
- Kemper, J., Khan, A., Helffrich, G., van Driel, M., Giardini, D., 2023.
Self-consistent models of Earth’s mantle and core from long-period seismic and tidal constraints.
Geophys J Int 235, 690–717.
Expand Down

0 comments on commit e229b0b

Please sign in to comment.