Skip to content

Adding new CHAOS-8 MIO model. #128

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
smithara merged 4 commits into from
Dec 4, 2025
Merged

Adding new CHAOS-8 MIO model. #128

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
889c3c6
Adding new CHAOS-8 MIO model.
pacesm Apr 23, 2025
6b9e41a
Add CHAOS-MIO to docs
smithara Dec 4, 2025
7c844bf
Merge branch 'staging' into chaos_mio
smithara Dec 4, 2025
94249e5
Begin changelog for v0.14
smithara Dec 4, 2025
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
3 changes: 2 additions & 1 deletion docs/available_parameters.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,7 @@ Models are evaluated along the satellite track at the positions of the time seri
``models=["'CHAOS-full' = 'CHAOS-Core' + 'CHAOS-Static' + 'CHAOS-MMA-Primary' + 'CHAOS-MMA-Secondary'"]``
`(click for more info) <https://github.com/klaundal/notebooks/blob/master/get_external_field.ipynb>`_

This composed model can also be accessed by an alias: ``models=["CHAOS"]`` which represents the full CHAOS model
This composed model (core + crust + magnetosphere) can also be accessed by an alias: ``models=["CHAOS"]``. Note that this does not include the ionospheric part (``"CHAOS-MIO"``) which was added to the CHAOS series in `CHAOS-8 <http://www.spacecenter.dk/files/magnetic-models/CHAOS-8/>`_.

See `Magnetic Earth <https://magneticearth.org/pages/models.html>`_ for an introduction to geomagnetic models.

Expand All @@ -326,6 +326,7 @@ Models are evaluated along the satellite track at the positions of the time seri
CHAOS-Core, # Core
CHAOS-Static, # Lithosphere
CHAOS-MMA-Primary, CHAOS-MMA-Secondary # Magnetosphere
CHAOS-MIO # Polar ionosphere

# Other lithospheric models:
MF7, LCS-1
Expand Down
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.13.0 to 0.14.0
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

- Added ``"CHAOS-MIO"`` magnetic model - the new ionospheric part of CHAOS. Note that the alias ``"CHAOS"`` does not include this ``"CHAOS-MIO"``

Changes from 0.12.3 to 0.13.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.13.0"
__version__ = "0.14.0"
5 changes: 5 additions & 0 deletions src/viresclient/_client_swarm.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,10 @@
"CHAOS-8 Secondary (internal) magnetospheric field",
" http://www.spacecenter.dk/files/magnetic-models/CHAOS-8/ ",
),
"CHAOS-MIO": (
"CHAOS-8 Ionospheric field",
" http://www.spacecenter.dk/files/magnetic-models/CHAOS-8/ ",
),
"MF7": (
"MF7 crustal field model, derived from CHAMP satellite observations",
" http://geomag.org/models/MF7.html",
Expand Down Expand Up @@ -1549,6 +1553,7 @@ class SwarmRequest(ClientRequest):
"CHAOS-Static",
"CHAOS-MMA-Primary",
"CHAOS-MMA-Secondary",
"CHAOS-MIO",
"MCO_SHA_2C",
"MCO_SHA_2D",
"MLI_SHA_2C",
Expand Down