ChaosMagPy v0.15

Version 0.15

Date: July 4, 2025
Release: v0.15

News

Starting with CHAOS-8.3, the model of the ionospheric E-layer field
can be evaluated directly in ChaosMagPy
(see chaosmagpy.chaos.CHAOS.synth_values_ion) by simply loading the
MAT-file. However, this requires the installation of the optional package Apexpy.

Features

• Updated built-in RC-index file to RC_1997-2025_June25_v6_allLT.dat (used
  during the construction of CHAOS-8.3).
• Added method to evaluate the ionospheric E-layer field
  chaosmagpy.chaos.CHAOS.synth_values_ion.

Full Changelog: v0.14...v0.15

ChaosMagPy v0.14

Version 0.14

Date: June 21, 2024
Release: v0.14

News

At the moment, only Numpy <= 1.26 is supported due to a deprecation affecting
a ChaosMagPy dependency. This will hopefully be fixed soon.

Features

• Updated RC-index file to RC_1997-2024_June24_v5.dat (used during the
  construction of CHAOS-7.18).
• Increased precision of chaosmagpy.data_utils.timestamp and
  chaosmagpy.data_utils.mjd2000 to nanosecond.
• Added function to compute the unit base vector in the direction of the
  geomagetic north pole: chaosmagpy.coordinate_utils.dipole_to_vec.

ChaosMagPy v0.13.1

Version 0.13.1

Date: June 4, 2024
Release: v0.13.1

Features

• Made Matplotlib an optional dependency of ChaosMagPy.
• Added optional dependencies to pyproject.toml.

Bugfixes

• Removed deprecated matplotlib call to register a colormap. The previous
  version caused an ImportError with matplotlib >=3.9.

ChaosMagPy v0.13

Version 0.13

Date: January 31, 2023
Release: v0.13

Features

• Updated RC-index file to RC_1997-2023_Dec23_v5.dat (used during the
  construction of CHAOS-7.17).
• Extended chaosmagpy.coordinate_utils.geo_to_gg and
  chaosmagpy.coordinate_utils.gg_to_geo to also allow for the
  rotation of vector components.
• Removed Cartopy from the dependencies (basic map projections are done with
  Matplotlib and coastlines are loaded from Natural Earth). New dependency for
  reading the coastline shapefile is PyShp (>=2.3.1).
• Added function chaosmagpy.chaos.load_IGRF_txtfile to load the IGRF
  model from the coefficient TXT-file.

ChaosMagPy v0.12

Version 0.12

Date: April 27, 2023
Release: v0.12

Features

• Updated RC-index file to RC_1997-2023_Feb_v8_Dst_mod.dat (used during the
  construction of CHAOS-7.14).
• Plotting function do not return figure and axes handles any more. If needed,
  they can be accessed through matplotlib's gcf() and gca().
• Added function chaosmagpy.model_utils.sensitivity to compute the
  sensitivity of spherical harmonic coefficients.
• Changed the default colormap for the component maps to 'PuOr_r' (orange
  for positive values and purple for negative ones).

Bugfixes

• Fixed error in chaosmagpy.data_utils.load_shcfile when reading
  single piece, quadratic splines. Error was due to a failure to identify the
  shc-parameter line as the first non-comment line in the file.
• Fixed KeyError that is raised when no name is given to the
  chaosmagpy.chaos.CHAOS constructor. This only affected direct calls
  to the constructor due to an outdated config keyword.

ChaosMagPy v0.11

Version 0.11

Date: September 29, 2022
Release: v0.11
Version of CHAOS: CHAOS-7.12 (0712)

Features

• Updated RC-index file to RC_1997-2022_Sept_v3.dat.
• Improved time conversion paragraph in the usage section.
• Added option to chaosmagpy.coordinate_utils.sh_analysis to increase
  the grid size for the numerical integration.
• Made time conversion functions (chaosmagpy.data_utils.mjd2000, chaosmagpy.data_utils.timestamp, chaosmagpy.data_utils.dyear_to_mjd, chaosmagpy.data_utils.mjd_to_dyear) directly available upon import.
• Extended chaosmagpy.model_utils.power_spectrum to accept NumPy style
  axis keyword argument, and added new tests for this function.
• Added more detailed error message when requesting near-magnetospheric
  coefficients outside the domain covered by the RC-index file.
• Added input parameters rc_e and rc_i to the model call method.

ChaosMagPy v0.10

Version 0.10

Date: July 1, 2022
Release: v0.10
Version of CHAOS: CHAOS-7.11 (0711)

Features

• Updated RC-index file to RC_1997-2022_June_v3.

ChaosMagPy v0.9

Version 0.9

Date: April 1, 2022
Release: v0.9
Version of CHAOS: CHAOS-7.10 (0710)

Features

• Updated RC-index file to RC_1997-2022_Feb_v3.
• Changed the default leap year setting when loading/saving shc-files using
  the model classes to leap_year=False.
• Added function chaosmagpy.chaos.load_CALS7K_txtfile to read the
  CALS7K coefficients file.
• Function chaosmagpy.model_utils.design_gauss now accepts
  multidimensional shapes of input grids and preserves them in the output.
• Added new method chaosmagpy.chaos.Base.to_ppdict, which returns a
  dictionary of the pp-form compatible with MATLAB.
• Added support for calibration parameters.
• Renamed "params.version" in basicConfig to "params.CHAOS_version".

Bugfixes

• Functions chaosmagpy.data_utils.dyear_to_mjd and
  chaosmagpy.data_utils.mjd_to_dyear now correctly convert
  negative decimal years and negative modified Julian dates (erroneous offset
  of 1 day due to rounding to integer values).

ChaosMagPy v0.8

Version 0.8

Date: December 9, 2021
Release: v0.8
Version of CHAOS: CHAOS-7.9 (0709)

Features

• Updated RC-index file to RC_1997-2021_November_v3.
• Added ability to compute field components at the geographic poles.
• Removed cdot from SV, SA units in chasomagpy.data_utils.gauss_units.
• Added chaosmagpy.coordinate_utils.sh_analysis, which performs a
  spherical harmonic expansion on a callable.

Bugfixes

• Removed Euler pre-rotation, which was not correctly implemented, and added
  a warning.
• Fixed shc-file loader to correctly exclude extrapolation sites.
• Fixed numpy broadcasting error in chasomagpy.data_utils.mjd2000.

ChaosMagPy v0.7

Version 0.7

Date: August 05, 2021
Release: v0.7
Version of CHAOS: CHAOS-7.8 (0708)

Features

• Added matplotlib's plot_directive for sphinx and added more examples to a
  new gallery section in the documentation.
• Added chaosmagpy.model_utils.pp_from_bspline to convert the spline
  coefficients from B-spline to PP format.
• Changed the way piecewise polynomials are produced from the coefficients in
  shc-files. A B-spline representation is now created in an intermediate step
  to ensure coefficient time series that are smooth.
• Changed the number format to '16.8f' when writing shc-files to increase
  precision.
• Configuration parameters in chaosmagpy.basicConfig are now saved to and
  loaded from a json-formatted txt-file.
• Added keyword arguments to chaosmagpy.chaos.CHAOS.synth_coeffs_sm
  and chaosmagpy.chaos.CHAOS.synth_values_sm to provide the RC-index
  values directly instead of using the built-in RC-index file.