wavespectra 4.4.3__tar.gz → 4.5.0__tar.gz

{wavespectra-4.4.3/wavespectra.egg-info → wavespectra-4.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wavespectra
-Version: 4.4.3
+Version: 4.5.0
 Summary: Library for ocean wave spectra
 Author-email: Wavespectra Developers <r.guedes@oceanum.science>
 Maintainer-email: Rafael Guedes <r.guedes@oceanum.science>, Tom Durrant <t.durrant@oceanum.science>

{wavespectra-4.4.3 → wavespectra-4.5.0}/pyproject.toml

@@ -56,6 +56,7 @@ wavespectra = "wavespectra.cli:main"
 [project.entry-points."xarray.backends"]
 era5 = "wavespectra.input.era5:ERA5BackendEntrypoint"
 funwave = "wavespectra.input.funwave:FunwaveBackendEntrypoint"
+funwave_new = "wavespectra.input.funwave_new:FunwaveNewBackendEntrypoint"
 json = "wavespectra.input.json:JsonBackendEntrypoint"
 ncswan = "wavespectra.input.ncswan:NCSwanBackendEntrypoint"
 ndbc = "wavespectra.input.ndbc:NDBCBackendEntrypoint"

{wavespectra-4.4.3 → wavespectra-4.5.0}/wavespectra/__init__.py

@@ -14,7 +14,7 @@ except ImportError:
     warnings.warn("Cannot import accessors at the main module level")
 
 
-__version__ = "4.4.3"
+__version__ = "4.5.0"
 
 
 def _import_functions(pkgname="input", prefix="read"):

wavespectra-4.5.0/wavespectra/input/funwave_new.py

@@ -0,0 +1,104 @@
+"""Read Funwave WK_NEW_DATA2D Wave Maker files"""
+
+from xarray.backends import BackendEntrypoint
+import numpy as np
+import xarray as xr
+
+from wavespectra import SpecArray
+from wavespectra.input import read_ascii_or_binary
+from wavespectra.core.attributes import attrs, set_spec_attributes
+
+
+def read_funwave_new(filename_or_obj):
+    """Read Spectra in Funwave WK_NEW_DATA2D wavemaker format.
+
+    Args:
+        - filename_or_obj (str, filelike): Funwave WaveCompFile to read.
+
+    Returns:
+        - dset (SpecDataset): spectra dataset object read from funwave file.
+
+    Note:
+        - Format description: https://fengyanshi.github.io/build/html/wavemaker_coherence.html.
+        - The file describes individual wave components, the gridded spectrum is
+          reconstructed by summing component energies :math:`a^2/2` falling in each
+          frequency-direction bin defined by the unique frequencies and directions.
+        - Directions converted from Cartesian (0E, CCW, to) to wavespectra (0N, CW, from).
+        - A 1D :math:`E(f)` spectrum is returned if all directions are equal.
+        - Phases are ignored if present.
+
+    """
+    data = read_ascii_or_binary(filename_or_obj, mode="r")
+
+    # Remove any empty rows
+    data = [row for row in data if row != "\n"]
+
+    # Number of wave components
+    nc = int(data.pop(0).split()[0])
+
+    # Tp
+    tp = float(data.pop(0).split()[0])
+
+    # Wave component blocks
+    values = [float(row.split()[0]) for row in data]
+    freq = np.array(values[:nc])
+    dir = np.array(values[nc : 2 * nc])
+    amp = np.array(values[2 * nc : 3 * nc])
+
+    # Bin component energies onto the spectral grid
+    freqs = np.unique(freq)
+    dirs = np.unique(dir)
+    ifreq = np.searchsorted(freqs, freq)
+    idir = np.searchsorted(dirs, dir)
+    energy = np.zeros((freqs.size, dirs.size))
+    np.add.at(energy, (ifreq, idir), amp**2 / 2)
+
+    if dirs.size == 1:
+        coords = {attrs.FREQNAME: freqs}
+        dims = (attrs.FREQNAME,)
+        energy = energy.squeeze(axis=1)
+    else:
+        # Convert dir from cartesian to wavespectra convention
+        dirs = (270 - dirs) % 360
+
+        # Turn zero dir into 360 for continuity
+        i0 = np.where(dirs == 0)[0]
+        if i0.size > 0:
+            dirs[i0] = 360.0
+
+        coords = {attrs.FREQNAME: freqs, attrs.DIRNAME: dirs}
+        dims = (attrs.FREQNAME, attrs.DIRNAME)
+    darr = xr.DataArray(data=energy, coords=coords, dims=dims)
+
+    # Energy density spectrum
+    darr = darr / (darr.spec.df * darr.spec.dd)
+
+    # Define output dataset
+    dset = darr.to_dataset(name=attrs.SPECNAME)
+    if dirs.size > 1:
+        dset = dset.sortby(attrs.DIRNAME)
+    dset["tp"] = tp
+    set_spec_attributes(dset)
+    return dset
+
+
+class FunwaveNewBackendEntrypoint(BackendEntrypoint):
+    """Funwave WK_NEW_DATA2D backend engine."""
+
+    def open_dataset(
+        self,
+        filename_or_obj,
+        *,
+        drop_variables=None,
+    ):
+        return read_funwave_new(filename_or_obj)
+
+    def guess_can_open(self, filename_or_obj):
+        return False
+
+    description = (
+        "Open Funwave WK_NEW_DATA2D ASCII wave component files as a wavespectra "
+        "dataset."
+    )
+
+    url = "https://github.com/wavespectra/wavespectra"

{wavespectra-4.4.3 → wavespectra-4.5.0}/wavespectra/output/funwave.py

@@ -33,6 +33,46 @@ def to_funwave(
           zip archive defined by replacing the extension of `filename` by ".zip".
 
     """
+    _write_funwave(self, filename, clip, funwave_spectrum)
+
+
+def to_funwave_new(
+    self,
+    filename,
+    clip=True,
+    phases=True,
+):
+    """Write spectra in Funwave WK_NEW_DATA2D wavemaker format.
+
+    Args:
+        - filename (str): Name for output Funwave file.
+        - clip (bool): Clip directions outside [-90, 90] range in cartesian convention.
+        - phases (bool): Write random phases for each wave component, if False the
+          phase block is omitted and Funwave generates random phases itself.
+
+    Note:
+        - Format description: https://fengyanshi.github.io/build/html/wavemaker_coherence.html.
+        - Unlike the gridded WK_DATA2D format written by `to_funwave`, this format
+          describes individual wave components, one per spectral bin.
+        - Directions converted from  wavespectra (0N, CW, from) to Cartesian (0E, CCW, to).
+        - Funwave only deals with directions in the [-90, 90] range in cartesian
+          convention (components outside it are discarded by the model), use
+          clip=True to clip spectra outside that range.
+        - Both 2D :math:`E(f,d)` and 1d :math:`E(f)` spectra are supported.
+        - If the SpecArray has more than one spectrum, multiple files are created in a
+          zip archive defined by replacing the extension of `filename` by ".zip".
+
+    """
+    _write_funwave(
+        self,
+        filename,
+        clip,
+        lambda darr, fname: funwave_new_spectrum(darr, fname, phases=phases),
+    )
+
+
+def _write_funwave(self, filename, clip, spectrum_writer):
+    """Write one or multiple spectra using the given single-spectrum writer."""
     darr = self.efth.copy(deep=True)
 
     # Convert directions to Cartesian, going-to convention
@@ -50,7 +90,7 @@ def to_funwave(
 
     if not stack_dims or dimsizes == {1}:
         # Single spectrum in object, write directly to txt file
-        funwave_spectrum(darr, filename)
+        spectrum_writer(darr, filename)
 
     else:
         # Multiple spectra in object, write each txt file in a zip archive
@@ -71,7 +111,7 @@ def to_funwave(
                 # Write spectrum to zip archive
                 fname = os.path.basename(fpath) + "-" + prefix + fext
                 logger.debug(f"Write {fname} to {zipname}")
-                spectrum = funwave_spectrum(darr, None).getvalue()
+                spectrum = spectrum_writer(darr, None).getvalue()
                 zstream.writestr(fname, spectrum)
 
 
@@ -120,3 +160,72 @@ def funwave_spectrum(darr, filename):
             fid.write(s.getvalue())
 
     return s
+
+
+def funwave_new_spectrum(darr, filename, phases=True):
+    """Funwave WK_NEW_DATA2D spectrum memory buffer.
+
+    Args:
+        darr (SpecArray): Spectrum to write (only `freq`, `dir` dims are allowed).
+        filename (str): Name of file to save spectrum to, choose `None` if you don't
+            want to save it to file but only return the memory buffer.
+        phases (bool): Write random phases for each wave component, if False the
+            phase block is omitted and Funwave generates random phases itself.
+
+    Returns:
+        StringIO memory buffer with spectrum object.
+
+    Note:
+        The file describes one wave component per spectral bin, with blocks of
+        frequency (Hz), direction (degrees, cartesian) and amplitude (m) values,
+        optionally followed by a block of phases (degrees):
+
+        .. code-block:: none
+
+            NumFreq
+            PeakPeriod
+            Freq(1..NumFreq)
+            Dire(1..NumFreq)
+            Amp(1..NumFreq)
+            Phase(1..NumFreq)
+
+    """
+    # Ensure direction dim exists for 1D spectrum and has value 0
+    if attrs.DIRNAME not in darr.dims:
+        darr = darr.expand_dims({attrs.DIRNAME: [0]}, axis=-1)
+    elif darr[attrs.DIRNAME].size == 1:
+        darr = darr.assign_coords({attrs.DIRNAME: [0]})
+
+    # Component amplitudes from spectral bins
+    amp = np.sqrt(darr * darr.spec.df * darr.spec.dd * 8) / 2
+    amp = amp.transpose(attrs.FREQNAME, attrs.DIRNAME)
+
+    # Unpack bins into individual wave components
+    freq, dire = np.meshgrid(
+        darr[attrs.FREQNAME].values, darr[attrs.DIRNAME].values, indexing="ij"
+    )
+    freq = freq.ravel()
+    dire = dire.ravel()
+    amp = amp.values.ravel()
+    nc = freq.size
+
+    # Peak wave period
+    tp = float(darr.spec.tp())
+
+    # Create spectrum in memory buffer
+    s = StringIO()
+    s.write(f"{nc:>5d}   - NumFreq\n")
+    s.write(f"{tp:>10.3f}   - PeakPeriod\n")
+    s.write(nc * "%10.5f   - Freq\n" % tuple(freq))
+    s.write(nc * "%10.3f   - Dire\n" % tuple(dire))
+    s.write(nc * "%12.8f   - Amp\n" % tuple(amp))
+    if phases:
+        phi = np.random.uniform(0, 360.0, nc)
+        s.write(nc * "%12.3f   - Phase\n" % tuple(phi))
+
+    # Save to file
+    if filename is not None:
+        with open(filename, "w") as fid:
+            fid.write(s.getvalue())
+
+    return s

{wavespectra-4.4.3 → wavespectra-4.5.0/wavespectra.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wavespectra
-Version: 4.4.3
+Version: 4.5.0
 Summary: Library for ocean wave spectra
 Author-email: Wavespectra Developers <r.guedes@oceanum.science>
 Maintainer-email: Rafael Guedes <r.guedes@oceanum.science>, Tom Durrant <t.durrant@oceanum.science>

{wavespectra-4.4.3 → wavespectra-4.5.0}/wavespectra.egg-info/SOURCES.txt

@@ -37,6 +37,7 @@ wavespectra/input/dataset.py
 wavespectra/input/datawell.py
 wavespectra/input/era5.py
 wavespectra/input/funwave.py
+wavespectra/input/funwave_new.py
 wavespectra/input/json.py
 wavespectra/input/ncswan.py
 wavespectra/input/ndbc.py

{wavespectra-4.4.3 → wavespectra-4.5.0}/wavespectra.egg-info/entry_points.txt

@@ -4,6 +4,7 @@ wavespectra = wavespectra.cli:main
 [xarray.backends]
 era5 = wavespectra.input.era5:ERA5BackendEntrypoint
 funwave = wavespectra.input.funwave:FunwaveBackendEntrypoint
+funwave_new = wavespectra.input.funwave_new:FunwaveNewBackendEntrypoint
 json = wavespectra.input.json:JsonBackendEntrypoint
 ncswan = wavespectra.input.ncswan:NCSwanBackendEntrypoint
 ndbc = wavespectra.input.ndbc:NDBCBackendEntrypoint