Wavespectra

___________________

New Features
------------
* Support for CSV Spotter files in `read_spotter`_ by by `ryancoe`_ (`PR77 <https://github.com/wavespectra/wavespectra/pull/77>`_).
* New reader `read_ndbc` for NDBC netcdf datasets (`PR80 <https://github.com/wavespectra/wavespectra/pull/80>`_).

Bug Fixes
---------
* Fix bug in 2D spectra construction in `read_ndbc_ascii`_ due to wrong scaling (`GH70 <https://github.com/wavespectra/wavespectra/issues/70>`_).
* Ensure directions are continuous when reading from Funwave file with split directions.

Internal Changes
----------------
* New github action to test and publish package on new releases.

Deprecation
-----------
* Replace previous NDBC ASCII reader `read_ndbc` by `read_ndbc_ascii`.

.. _`ryancoe`: https://github.com/ryancoe
.. _`read_spotter`: https://github.com/wavespectra/wavespectra/blob/master/wavespectra/input/spotter.py
.. _`read_ndbc_ascii`: https://github.com/wavespectra/wavespectra/blob/master/wavespectra/input/ndbc_ascii.py

___________________

Internal Changes
-----------------
* Fix numpy pre-install requirement by `cmichelenstrofer`_ (`PR75 <https://github.com/wavespectra/wavespectra/pull/75>`_).

.. _`cmichelenstrofer`: https://github.com/cmichelenstrofer

___________________

New Features
------------
* Improve installation section in the docs to mention pre-install requirements of numpy and Fortran compiler.

Bug Fixes
---------
* Fix bug caused by fixed numpy version (`PR72 <https://github.com/wavespectra/wavespectra/pull/72>`_).

Internal Changes
----------------
* Import Fortran partition code inside function so the library can still be imported if the module does not build.
* Remove Hypothesis from requirements.

___________________

New Features
------------
* New reader for Octopus file format by `Ruben de Bruin`_ (`PR65 <https://github.com/wavespectra/wavespectra/pull/65>`_).

Bug Fixes
---------
* Fix bug in direction calculation caused by changes in xr ufuncs (`PR59 <https://github.com/wavespectra/wavespectra/pull/59>`_).
* Fix nrecs in test octopus file.
* Fix to zarr testing by `Ruben de Bruin`_ (`PR55 <https://github.com/wavespectra/wavespectra/pull/55>`_).

Internal Changes
----------------
* Only interpolate with inverse distance weighting if 2 or more neighbour sites are found within tolerance (`PR62 <https://github.com/wavespectra/wavespectra/pull/62>`_).
* Allow pathlib objects in read_swan (`PR64 <https://github.com/wavespectra/wavespectra/pull/64>`_).
* Increase float precision in Octopus writer.
* Make zarr, fsspec and gcsfs extra dependencies instead of default.
* Remove `get_mapper` call from zarr opener.

___________________

New Features
------------
* New option in `read_triaxys` to allow providing the magnitic declination to correct.
* New spectral regridding capability by `Ruben de Bruin`_. The function is wrapped in `SpecArray.interp`
and `SpecArray.interp_by` which mimic the behaviour in the respective counterparts from xarray.
* Replace plot api by a simple wrapper around xarray plotting capability. The new wrapper
no longer duplicate internal functions from xarray and should better integrate any upstream
changes. The new api also handles logarithmic axes and masking in a more natural way
(`PR48 <https://github.com/wavespectra/wavespectra/pull/48>`_).
* New Orcaflex export function by `Ruben de Bruin`_ (`PR37 <https://github.com/wavespectra/wavespectra/pull/37>`_).
* New `wavespectra.core.utils.unique_indices` function (unique_times will be deprecated in future releases.


Bug Fixes
---------
* Fix plot bug with the new plot api (`GH44 <https://github.com/wavespectra/wavespectra/issues/44>`_).
* Fix bug in `scale_by_hs` when run on dask datasets.


Internal Changes
----------------
* Fixed sphinx-gallery dependency by by `Ruben de Bruin`_ (`PR41 <https://github.com/wavespectra/wavespectra/pull/41>`_).
* Add new funwave functiont to docs.
* Update authors list.
* Allow pathlib objects in read_triaxys.


Deprecation
-----------
* Calling the plot kind as a method from `SpecArray.plot`, e.g. `SpecArray.plot.contourf`
is deprecated with the new plotting api. Now `kind` needs to be provided as an argument.
* Arguments `show_radius_label` and `show_direction_label` are deprecated from `SpecArray.plot`.
Labels are no longer drawn as they fall on top of ticks. In order to show it the axes
properties now must be manually defined from the axis.
* Argument `as_log10` from the old plot api to plot the log10(efth) is deprecated in the new
api. Similar result can be achieved in the new api by manually converting efth before plotting.
* Remove deprecated methods `_strictly_increasing` and `_collapse_array` and `_twod`.
* Remove `dfarr` attribute from SpecArray, replaced by `df`.
* Remove unused functions `to_datetime` and `dnum_to_datetime`.
* The "mask" argument has been removed from `SpecArray.sw` method.

.. _`Paul Branson`: https://github.com/pbranson

__________________

New Features
------------
* Funwave spectra reader `read_funwave`_ (`PR36 <https://github.com/wavespectra/wavespectra/pull/36>`_).
* Funwave spectra writer `to_funwave`_ (`PR36 <https://github.com/wavespectra/wavespectra/pull/36>`_).

.. _`read_funwave`: https://github.com/wavespectra/wavespectra/blob/master/wavespectra/input/funwave.py
.. _`to_funwave`: https://github.com/wavespectra/wavespectra/blob/master/wavespectra/output/funwave.py