Chaosmagpy

| **Version of CHAOS:** CHAOS-7.2 (0702)

News
^^^^
The version identifier of the CHAOS model using ``x``, which stands for an
extension of the model, has been replaced in favor of a simple version
numbering. For example, ``CHAOS-6.x9`` is the 9th extension of the CHAOS-6
series. But starting with the release of the CHAOS-7 series, the format
``CHAOS-7.1`` has been adopted to indicate the first release of the series,
``CHAOS-7.2`` the second release (formerly the first extension) and so on.

Features
^^^^^^^^
* Updated RC-index file to RC_1997-2020_Feb_v4.dat.
* Removed version keyword of :class:`chaosmagpy.chaos.CHAOS` to avoid
confusion.
* Added ``verbose`` keyword to the ``call`` method of
:class:`chaosmagpy.chaos.CHAOS` class to avoid printing messages.
* Added :func:`chaosmagpy.data_utils.timestamp` function to convert modified
Julian date to NumPy's datetime format.
* Added more examples to the :class:`chaosmagpy.chaos.CHAOS` methods.
* Added optional ``nmin`` and ``mmax`` to
:func:`chaosmagpy.model_utils.design_gauss` and
:func:`chaosmagpy.model_utils.synth_values` (nmin has been redefined).
* Added optional derivative to :func:`chaosmagpy.model_utils.colloc_matrix`
of the B-Spline collocation.
New implementation does not have the missing endpoint problem.
* Added ``satellite`` keyword to change default satellite names when loading
CHAOS mat-file.

| **Version of CHAOS:** CHAOS-7.1 (0701)

Bugfixes
^^^^^^^^
* Corrected function :func:`chaosmagpy.coordinate_utils.zenith_angle` which was
computing the solar zenith angle from ``phi`` defined as the hour angle and
NOT the geographic longitude. The hour angle is measure positive towards West
and negative towards East.

| **Version of CHAOS:** CHAOS-7.1 (0701)

Features
^^^^^^^^
* Updated RC-index file to recent version (August 2019, v6)
* Added option ``nmin`` to :func:`chaosmagpy.model_utils.synth_values`.
* Vectorized :func:`chaosmagpy.data_utils.mjd2000`,
:func:`chaosmagpy.data_utils.mjd_to_dyear` and
:func:`chaosmagpy.data_utils.dyear_to_mjd`.
* New function :func:`chaosmagpy.coordinate_utils.local_time` for a simple
computation of the local time.
* New function :func:`chaosmagpy.coordinate_utils.zenith_angle` for computing
the solar zenith angle.
* New function :func:`chaosmagpy.coordinate_utils.gg_to_geo` and
:func:`chaosmagpy.coordinate_utils.geo_to_gg` for transforming geodetic and
geocentric coordinates.
* Added keyword ``start_date`` to
:func:`chaosmagpy.coordinate_utils.rotate_gauss_fft`
* Improved performance of :meth:`chaosmagpy.chaos.CHAOS.synth_coeffs_sm` and
:meth:`chaosmagpy.chaos.CHAOS.synth_coeffs_gsm`.
* Automatically import :func:`chaosmagpy.model_utils.synth_values`.

Deprecations
^^^^^^^^^^^^
* Rewrote :func:`chaosmagpy.data_utils.load_matfile`: now traverses matfile
and outputs dictionary.
* Removed ``breaks_euler`` and ``coeffs_euler`` from
:class:`chaosmagpy.chaos.CHAOS` class
attributes. Euler angles are now handled as :class:`chaosmagpy.chaos.Base`
class instance.

Bugfixes
^^^^^^^^
* Fixed collocation matrix for unordered collocation sites. Endpoint now
correctly taken into account.

| **Version of CHAOS:** CHAOS-6-x9

Features
^^^^^^^^
* New CHAOS class method :meth:`chaosmagpy.chaos.CHAOS.synth_euler_angles` to
compute Euler angles for the satellites from the CHAOS model (used to rotate
vectors from magnetometer frame to the satellite frame).
* Added CHAOS class methods :meth:`chaosmagpy.chaos.CHAOS.synth_values_tdep`,
:meth:`chaosmagpy.chaos.CHAOS.synth_values_static`,
:meth:`chaosmagpy.chaos.CHAOS.synth_values_gsm` and
:meth:`chaosmagpy.chaos.CHAOS.synth_values_sm` for field value computation.
* RC index file now stored in HDF5 format.
* Filepaths and other parameters are now handled by a configuration dictionary
called ``chaosmagpy.basicConfig``.
* Added extrapolation keyword to the BaseModel class
:meth:`chaosmagpy.chaos.Base.synth_coeffs`, linear by default.
* :func:`chaosmagpy.data_utils.mjd2000` now also accepts datetime class
instances.
* :func:`chaosmagpy.data_utils.load_RC_datfile` downloads latest RC-index file
from the website if no file is given.

Bugfixes
^^^^^^^^
* Resolved issue in :func:`chaosmagpy.model_utils.degree_correlation`.
* Changed the date conversion to include hours and seconds not just the day
when plotting the timeseries.

Features
^^^^^^^^
* New CHAOS class method :meth:`chaosmagpy.chaos.CHAOS.save_matfile` to output
MATLAB compatible files of the CHAOS model (using the ``hdf5storage``
package).
* Added ``epoch`` keyword to basevector input arguments of GSM, SM and MAG
coordinate systems.

Bugfixes
^^^^^^^^
* Fixed problem of the setup configuration for ``pip`` which caused importing
the package to fail although installation was indicated as successful.

Features
^^^^^^^^
* :func:`chaosmagpy.data_utils.mjd_to_dyear` and
:func:`chaosmagpy.data_utils.dyear_to_mjd` convert time with microseconds
precision to prevent round-off errors in seconds.
* Time conversion now uses built-in ``calendar`` module to identify leap year.

Bugfixes
^^^^^^^^
* Fixed wrong package requirement that caused the installation of
ChaosMagPy v0.1a1 to fail with ``pip``. If installation of v0.1a1 is needed,
use ``pip install --no-deps chaosmagpy==0.1a1`` to ignore faulty
requirements.