From a01269a6b7c6287fbd7aaf097716397a8852ac9c Mon Sep 17 00:00:00 2001 From: Ashley Smith Date: Wed, 18 Dec 2024 20:24:52 +0000 Subject: [PATCH] Add IGRF-14 reference. Remove deprecated IGRF-12 and CHAOS-6 --- docs/release_notes.rst | 5 +++++ src/viresclient/__init__.py | 2 +- src/viresclient/_client_swarm.py | 38 +++----------------------------- 3 files changed, 9 insertions(+), 36 deletions(-) diff --git a/docs/release_notes.rst b/docs/release_notes.rst index 7209e8f..06a526e 100644 --- a/docs/release_notes.rst +++ b/docs/release_notes.rst @@ -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 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/src/viresclient/__init__.py b/src/viresclient/__init__.py index 86e8cfe..44d9efc 100644 --- a/src/viresclient/__init__.py +++ b/src/viresclient/__init__.py @@ -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" diff --git a/src/viresclient/_client_swarm.py b/src/viresclient/_client_swarm.py index 3d0df5f..8fd16ba 100644 --- a/src/viresclient/_client_swarm.py +++ b/src/viresclient/_client_swarm.py @@ -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)", @@ -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", @@ -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": ( @@ -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",