Skip to content
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

Add IGRF-14 reference. Remove deprecated IGRF-12 and CHAOS-6 #119

Merged
merged 1 commit into from
Dec 18, 2024
Merged

Add IGRF-14 reference. Remove deprecated IGRF-12 and CHAOS-6 #119

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions docs/release_notes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ Release notes
Change log
----------

Changes from 0.12.0 to 0.12.1
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

- VirES now uses CHAOS-8 and IGRF-14 magnetic models. These models are referred to as ``"CHAOS"`` and ``"IGRF"`` - older versions are not available.

Changes from 0.11.8 to 0.12.0
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Expand Down
2 changes: 1 addition & 1 deletion src/viresclient/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@
from ._config import ClientConfig, set_token
from ._data_handling import ReturnedData, ReturnedDataFile

__version__ = "0.12.1-alpha"
__version__ = "0.12.1"
38 changes: 3 additions & 35 deletions src/viresclient/_client_swarm.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,13 +40,8 @@

MODEL_REFERENCES = {
"IGRF": (
" International Geomagnetic Reference Field: the thirteenth generation, (https://doi.org/10.1186/s40623-020-01288-x) ",
" https://www.ngdc.noaa.gov/IAGA/vmod/igrf.html ",
),
"IGRF12": (
" International Geomagnetic Reference Field: the 12th generation, https://doi.org/10.1186/s40623-015-0228-9 ",
" https://www.ngdc.noaa.gov/IAGA/vmod/igrf.html "
" deprecated model identifier, use IGRF instead",
" International Geomagnetic Reference Field 14 (https://doi.org/10.5281/zenodo.14012302) ",
" https://www.ncei.noaa.gov/products/international-geomagnetic-reference-field ",
),
"CHAOS-Core": (
"CHAOS-8 Core field (SH degrees 1-20)",
Expand All @@ -64,22 +59,6 @@
"CHAOS-8 Secondary (internal) magnetospheric field",
" http://www.spacecenter.dk/files/magnetic-models/CHAOS-8/ ",
),
"CHAOS-6-Core": (
"CHAOS Core field",
" deprecated model identifier, use CHAOS-Core instead",
),
"CHAOS-6-Static": (
"CHAOS crust field",
" deprecated model identifier, use CHAOS-Static instead",
),
"CHAOS-6-MMA-Primary": (
"CHAOS Primary (external) magnetospheric field",
" deprecated model identifier, use CHAOS-MMA-Primary instead",
),
"CHAOS-6-MMA-Secondary": (
"CHAOS-Secondary (internal) magnetospheric field",
" deprecated model identifier, use CHAOS-MMA-Secondary instead",
),
"MF7": (
"MF7 crustal field model, derived from CHAMP satellite observations",
" http://geomag.org/models/MF7.html",
Expand Down Expand Up @@ -158,13 +137,7 @@
),
}

DEPRECATED_MODELS = {
"IGRF12": "Use IGRF instead.",
"CHAOS-6-Core": "Use CHAOS-Core instead.",
"CHAOS-6-Static": "Use CHAOS-Static instead.",
"CHAOS-6-MMA-Primary": "Use CHAOS-MMA-Primary instead.",
"CHAOS-6-MMA-Secondary": "Use CHAOS-MMA-Secondary instead.",
}
DEPRECATED_MODELS = {}

COLLECTION_REFERENCES = {
"MAG": (
Expand Down Expand Up @@ -1341,17 +1314,12 @@ class SwarmRequest(ClientRequest):

MAGNETIC_MODELS = [
"IGRF",
"IGRF12",
"LCS-1",
"MF7",
"CHAOS-Core",
"CHAOS-Static",
"CHAOS-MMA-Primary",
"CHAOS-MMA-Secondary",
"CHAOS-6-Core",
"CHAOS-6-Static",
"CHAOS-6-MMA-Primary",
"CHAOS-6-MMA-Secondary",
"MCO_SHA_2C",
"MCO_SHA_2D",
"MLI_SHA_2C",
Expand Down
Loading