Wavespectra

___________________

This release adds deprecation warnings to functions and modules that will be removed or
redesigned in the next major release.

Bug Fixes
---------
* Fix reading of gzipped swan ascii files.

Internal Changes
----------------
* Add deprecation warnings to prepare for the next major release.

___________________

Internal Changes
----------------
* Redefine packaging via pyproject.toml to conform to PEP517/518 (`PR77 <https://github.com/wavespectra/wavespectra/pull/87>`_).
* All packaging metadata removed from setup.py and moved to pyproject.toml. The
setup.py file is now only used to build the Fortran module.
* Removed the MANIFEST.in file, package data now handled in pyproject.toml.
* Removed the requirements folder, requirements now handled in pyproject.toml.
* Removed some packaging attributes from `wavespectra.__init__.py`, now handled in
pyproject.toml.
* Replace docs the RTD by the PYDATA docs theme, this fixes issue with rtd not working with sphinx>=7.0.
* Add readthedocs config.

___________________

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 `RubendeBruin`_ (`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 `RubendeBruin`_ (`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.