___________________
This major release brings several new features and improvements including spectra
construction capability, a new partitioning api and replacement of the fortran
watershed algorithm with a new translated version in C freeing wavespectra from the
fortran dependency. The release also includes new methods for spectral statistics,
backend engines to open spectra files directly in xarray, and a new command line
interface to convert between spectra file formats and create netcdf files with
integrated spectral parameters from spectra files.
New Features
------------
Spectra construction
~~~~~~~~~~~~~~~~~~~~
* New functions to construct frequency spectra within the
`wavespectra.construct.frequency` module:
* pierson-moskowitz spectrum for fully developed seas (`Pierson and Moskowitz, 1964 <https://ui.adsabs.harvard.edu/abs/1964JGR....69.5181P/abstract>`_)
* jonswap spectrum for developing seas (`Hasselmann et al., 1973 <https://www.researchgate.net/publication/256197895_Measurements_of_wind-wave_growth_and_swell_decay_during_the_Joint_North_Sea_Wave_Project_JONSWAP>`_)
* tma spectrum for seas in finite depth (`Bouws et al., 1985 <https://www.researchgate.net/publication/256197895_Measurements_of_wind-wave_growth_and_swell_decay_during_the_Joint_North_Sea_Wave_Project_JONSWAP>`_)
* gaussian spectrum for swells (`Bunney et al., 2014 <https://www.icevirtuallibrary.com/doi/abs/10.1680/fsts.59757.114#:~:text=The%20technique%20can%20be%20summarised,method%2C%20associate%20the%20surrounding%20energy>`_)
* Directional spreading functions within the `wavespectra.construct.direction` module:
* cartwright cosine-square distribution (`Cartwright, 1963 <https://cir.nii.ac.jp/crid/1573387449115327232>`_)
* asymmetric distribution for turning wind seas (`Bunney et al., 2014 <https://www.icevirtuallibrary.com/doi/abs/10.1680/fsts.59757.114#:~:text=The%20technique%20can%20be%20summarised,method%2C%20associate%20the%20surrounding%20energy>`_)
* Methods for fitting Jonswap and Gaussian in SpecArray from existing spectra by
`Paul Branson`_ (`PR4 <https://github.com/oceanum/wavespectra/pull/4>`_).
Partitioning
~~~~~~~~~~~~
* New partition api with several new methods:
* ptm1
* ptm2
* ptm3
* ptm4
* ptm5
* bbox
* hp01
* New method to track watershed partitions `ptm1_track` by `Sebastien Dealaux`_
(`PR5 <https://github.com/oceanum/wavespectra/pull/5>`_).
Stats
~~~~~
* Method for non-linear gaussian fit in SpecArray by `Paul Branson`_
(`PR1 <https://github.com/oceanum/wavespectra/pull/3>`_).
* Methods to calculate stokes drift and the mean squared slope by `Paul Branson`_
(`PR1 <https://github.com/oceanum/wavespectra/pull/1>`_).
* Gaussian frequency width method `gw` in SpecArray.
* Jonswap peak enhancement factor method `gamma` in SpecArray.
* Jonswap fetch scaling coefficient method `alpha` in SpecArray.
* Peak directional spread method `dpspr` in SpecArray.
* Peak frequency method `fp` in SpecArray.
* Root-mean-square wave height method `hrms` in SpecArray.
* Root-mean-square error method `rmse` in SpecArray.
IO
~~~
* New xarray backend entrypoints for reading wavespectra datasets with xr.open_dataset.
* New input function to read xwaves mat format.
* New input function to read obscape buoy spectra by `Ruben de Bruin`_.
(`PR116 <https://github.com/wavespectra/wavespectra/pull/116>`_).
Command line interface
~~~~~~~~~~~~~~~~~~~~~~
* New CLI to convert between spectra file formats.
* New CLI to create netcdf file with integrated spectral parameters from spectra file.
* New CLI to Partition and reconstruct spectra from file
Other
~~~~~
* New Spectra smoothing capability.
* New method in SpecArray to rotate spectra.
Bug Fixes
---------
* Fix reading of ndbc-type dataset in read_dataset.
* Fix bug in the `spec.split()` method where direction slicing was not working correctly.
Internal Changes
----------------
* Watershed partitioning algorithm translated from fortran to C by `Sebastien Dealaux`_
(`PR121 <https://github.com/wavespectra/wavespectra/pull/121>`_). **Fortran is no
longer required to install wavespectra**. This also fixes a problem with trying to
install wavespectra in development mode.
* SpecArray.partition now longer is a method but a namespace to access the different
partitioning options.
* Change `ihmax` default from 200 to 100 in specpart (in line with WAVEWATCHIII),
options to redefine `ihmax` in the partition methods.
* Allow reading WW3 and SWAN files without winds and depth available.
* Optimised and simplified calculations in frequency and directional moments methods.
* Rename `SpecArray.dfarr` as `SpecArray.df`.
* wavenuma function now takes the cyclic frequency (Hz) instead of the angular
frequency omega.
* Ensure spectral attributes are defined in the interp method of SpecArray.
* Make `read_ndbc` return 1D spectra if any of the directional variables are missing.
* Support arbitrary kwargs in the `read_dataset` reader.
Deprecation
-----------
* Removed `wavespectra.SpecArray.dfarr` method, replaced by `wavespectra.SpecArray.df`.
* Removed the unused `wavespectra.core.utils.GAMMA` lambda function.
* Removed the deprecated `SpecArray.partition()` method; `SpecArray.partition` is now
a new namespace to access the different partitioning options. The legacy `partition`
method is now equivalent to `spec.partition.ptm1()` with the `ihmax` argument set to 200.
.. _`Sebastien Dealaux`: https://github.com/seboceanum