.. currentmodule:: gbspy

Changelog
=========

v1.7.1 (12 July 2022)
---------------------

- Fixed an issue preventing some documentation pages to be generated.

v1.7.0 (12 July 2022)
---------------------

- Removed the ``tests`` package. The functions are still available in the
  repository.
- Magnetic equilibria provided as text files are not longer loaded by default
  when opening simulations. You can retrieve the old behavior by loading them
  explicitely with :py:func:`~gbspy.utils.load_mag_field`.
- Added three new modules,

  - :py:mod:`.surfaces` provides the :py:func:`~.surfaces.get_line` routine to
    generate lines within the domain (e.g. a line perpendicular to flux
    surfaces, or following the magnetic field).
  - :py:mod:`.fits` which provides a wrapper to scipy's curve fitting routine:
    :py:func:`~.fits.fit`.
  - :py:mod:`.tutorial` which provides a way to load lightweight simulations
    from online storage. This allows, in particular, to generate reproducible
    documentation examples automatically with Sphinx.

- Refactored the gradient modules

  - Added "rolling" arrays to gradients or interpolation functions with a stencil
    aligned in the ``z`` direction, which allows to avoid ghost cells filled with
    ``np.NaN`` in the periodic direction.
  - Provide a single entry point for stencil computations.
  - Added tests for the refactored module with
    `pytest <https://docs.pytest.org/>`_.

- Added verbose plots for :py:func:`~.theta.theta_rhs`
- :py:class:`.Sim` now supports opening single result files. This will in
  particular be used in lightweight "tutorial" datasets. Opening a single
  result file also allows for quicker loading times, especially when working
  with large simulations.

v1.6.0 (20 June 2022)
---------------------

- Added contribution instructions, especially providing guides to help setup a
  Python environment.
- Added :py:mod:`.drifts` module, providing functions that compute common drift velocities.
- Replaced :py:func:`~matplotlib.pyplot.contourf` plots with
  :py:func:`~matplotlib.pyplot.pcolormesh`.
- Added package wide options that can be set with :py:class:`options.set_options`.
- "jet" is no longer the default colormap. If this bothers you, you can
  retrieve the previous behaviour by calling ``gbspy.set_options(cmap="jet")``
  after loading the package.