wavespectra 4.3.0__tar.gz → 4.4.0__tar.gz

{wavespectra-4.3.0/wavespectra.egg-info → wavespectra-4.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: wavespectra
-Version: 4.3.0
+Version: 4.4.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>
@@ -76,6 +76,7 @@ Requires-Dist: sphinx; extra == "docs"
 Requires-Dist: sphinx-autobuild; extra == "docs"
 Requires-Dist: sphinx-autodoc-typehints; extra == "docs"
 Requires-Dist: sphinx-gallery; extra == "docs"
+Dynamic: license-file
 
 wavespectra
 ===========

{wavespectra-4.3.0 → wavespectra-4.4.0}/wavespectra/__init__.py

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

{wavespectra-4.3.0 → wavespectra-4.4.0}/wavespectra/core/utils.py

@@ -15,6 +15,21 @@ D2R = np.pi / 180.0
 R2D = 180.0 / np.pi
 
 
+def create_frequencies(f0: float, nf: int, df: float = 1.1) -> np.ndarray:
+    """Create an array of logarithmically spaced frequencies.
+
+    Args:
+        - f0 (float): First frequency value in Hz (e.g., 0.03453)
+        - nf (int): Number of frequencies to generate
+        - df (float, optional): Multiplicative increment between frequencies. Defaults to 1.1.
+
+    Returns:
+        - np.ndarray: Array of frequencies in Hz
+
+    """
+    return f0 * (df ** np.arange(nf))
+
+
 def angle(dir1, dir2):
     """Relative angle between two directions.
 

wavespectra-4.4.0/wavespectra/input/era5.py

@@ -0,0 +1,114 @@
+"""Read ERA5 2D Wave Spectra NetCDF files"""
+
+import numpy as np
+import xarray as xr
+from xarray.backends import BackendEntrypoint
+
+from wavespectra.core.utils import create_frequencies
+from wavespectra.core.attributes import attrs, set_spec_attributes
+
+
+MAPPING = {
+    "time": attrs.TIMENAME,
+    "valid_time": attrs.TIMENAME,
+    "frequency": attrs.FREQNAME,
+    "frequencyNumber": attrs.FREQNAME,
+    "direction": attrs.DIRNAME,
+    "directionNumber": attrs.DIRNAME,
+    "d2fd": attrs.SPECNAME,
+    "longitude": attrs.LONNAME,
+    "latitude": attrs.LATNAME,
+}
+
+
+def read_era5(filename_or_fileglob, chunks={}, f0=0.03453, df=1.1, as_site=False):
+    """Read Spectra from ECMWF ERA5 netCDF format.
+
+    Args:
+        - filename_or_fileglob (str, list, filelike): filename, fileglob specifying multiple
+          files, or filelike object to read.
+        - chunks (dict): chunk sizes for dimensions in dataset. By default
+          dataset is loaded using single chunk for all dimensions (see
+          xr.open_mfdataset documentation).
+        - f0 (float): First frequency value in Hz (e.g., 0.03453)
+        - df (float): Multiplicative increment between frequencies.
+        - as_site (bool): If True locations are defined by 1D site dimension.
+
+    Returns:
+        - dset (SpecDataset): spectra dataset object read from netcdf file.
+
+    Note:
+        - This reader also supports ECMWF spectra from the operational forecast.
+        - Documentation describing how to construct the spectral grid can be found at
+          https://www.ecmwf.int/en/forecasts/documentation-and-support/2d-wave-spectra.
+        - If file is large to fit in memory, consider specifying chunks for
+          'time' and/or 'latitude/longitude' dims.
+
+    """
+
+    dset = xr.open_dataset(filename_or_fileglob).chunk(chunks)
+    return from_era5(dset, f0=f0, df=df, as_site=as_site)
+
+
+def from_era5(dset, f0=0.03453, df=1.1, as_site=False):
+    """Format ERA5 netcdf dataset to receive wavespectra accessor.
+
+    Args:
+        - dset (xr.Dataset): Dataset created from a ERA5 netcdf file.
+        - f0 (float): First frequency value in Hz (e.g., 0.03453)
+        - df (float): Multiplicative increment between frequencies.
+        - as_site (bool): If True locations are defined by 1D site dimension.
+
+    Returns:
+        - Formated dataset with the SpecDataset accessor in the `spec` namespace.
+
+    """
+
+    mapping = {k: v for k, v in MAPPING.items() if k != v and k in dset.variables}
+    dset = dset.rename(mapping).reset_coords(drop=True)
+
+    # Convert ERA5 format to wavespectra format
+    dset[attrs.SPECNAME] = 10 ** dset[attrs.SPECNAME] * np.pi / 180
+    dset[attrs.SPECNAME] = dset[attrs.SPECNAME].fillna(0)
+
+    # Assign the logarithmic frequency grid
+    dset[attrs.FREQNAME] = create_frequencies(f0, dset[attrs.FREQNAME].size, df)
+
+    # Assign the coming-from direction grid
+    dd = 360 / dset[attrs.DIRNAME].size
+    dset[attrs.DIRNAME] = ((np.arange(0, 360, dd) + dd / 2) + 180) % 360
+
+    # Stack lat/lon dimensions if as_site is True
+    if as_site:
+        dset = (
+            dset.stack(site=[attrs.LATNAME, attrs.LONNAME], create_index=False)
+            .reset_coords()
+            .transpose(attrs.TIMENAME, attrs.SITENAME, attrs.FREQNAME, attrs.DIRNAME)
+        )
+
+    # Setting standard attributes
+    set_spec_attributes(dset)
+
+    return dset
+
+
+class ERA5BackendEntrypoint(BackendEntrypoint):
+    """ERA5 backend engine."""
+
+    def open_dataset(
+        self,
+        filename_or_obj,
+        *,
+        drop_variables=None,
+        f0=0.03453,
+        df=1.1,
+        as_site=False,
+    ):
+        return read_era5(filename_or_obj, f0=f0, df=df)
+
+    def guess_can_open(self, filename_or_obj):
+        return False
+
+    description = "Open ERA5 netcdf spectra files as a wavespectra dataset."
+
+    url = "https://github.com/wavespectra/wavespectra"

{wavespectra-4.3.0 → wavespectra-4.4.0/wavespectra.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: wavespectra
-Version: 4.3.0
+Version: 4.4.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>
@@ -76,6 +76,7 @@ Requires-Dist: sphinx; extra == "docs"
 Requires-Dist: sphinx-autobuild; extra == "docs"
 Requires-Dist: sphinx-autodoc-typehints; extra == "docs"
 Requires-Dist: sphinx-gallery; extra == "docs"
+Dynamic: license-file
 
 wavespectra
 ===========

wavespectra-4.3.0/wavespectra/input/era5.py

@@ -1,92 +0,0 @@
-"""Read ERA5 2D Wave Spectra NetCDF files"""
-
-import numpy as np
-from xarray.backends import BackendEntrypoint
-
-from wavespectra.core.attributes import attrs, set_spec_attributes
-from wavespectra.input.netcdf import read_netcdf
-
-
-DEFAULT_FREQS = np.full(30, 0.03453) * (1.1 ** np.arange(0, 30))
-DEFAULT_DIRS = (np.arange(7.5, 352.5 + 15, 15) + 180) % 360
-
-
-def read_era5(filename_or_fileglob, chunks={}, freqs=None, dirs=None):
-    """Read Spectra from ECMWF ERA5 netCDF format.
-
-    Args:
-        - filename_or_fileglob (str, list, filelike): filename, fileglob specifying multiple
-          files, or filelike object to read.
-        - chunks (dict): chunk sizes for dimensions in dataset. By default
-          dataset is loaded using single chunk for all dimensions (see
-          xr.open_mfdataset documentation).
-        - freqs (list): list of frequencies. By default use all 30 ERA5 frequencies.
-        - dirs (list): list of directions. By default use all 24 ERA5 directions.
-
-    Returns:
-        - dset (SpecDataset): spectra dataset object read from netcdf file.
-
-    Note:
-        - Frequency and diirection coordinates seem to have only integer positions
-          which is why they are allowed to be specified as a parameter.
-        - If file is large to fit in memory, consider specifying chunks for
-          'time' and/or 'station' dims.
-
-    """
-
-    dset = read_netcdf(
-        filename_or_fileglob,
-        specname="d2fd",
-        freqname="frequency",
-        dirname="direction",
-        lonname="longitude",
-        latname="latitude",
-        timename="time",
-        chunks=chunks,
-    )
-    return from_era5(dset, freqs=freqs, dirs=dirs)
-
-
-def from_era5(dset, freqs=None, dirs=None):
-    """Format ERA5 netcdf dataset to receive wavespectra accessor.
-
-    Args:
-        - dset (xr.Dataset): Dataset created from a SWAN netcdf file.
-
-    Returns:
-        - Formated dataset with the SpecDataset accessor in the `spec` namespace.
-
-    """
-
-    # Convert ERA5 format to wavespectra format
-    dset = 10**dset * np.pi / 180
-    dset = dset.fillna(0)
-
-    dset[attrs.FREQNAME] = freqs if freqs else DEFAULT_FREQS
-    dset[attrs.DIRNAME] = dirs if dirs else DEFAULT_DIRS
-
-    # Setting standard attributes
-    set_spec_attributes(dset)
-
-    return dset
-
-
-class ERA5BackendEntrypoint(BackendEntrypoint):
-    """ERA5 backend engine."""
-
-    def open_dataset(
-        self,
-        filename_or_obj,
-        *,
-        drop_variables=None,
-        freqs=None,
-        dirs=None,
-    ):
-        return read_era5(filename_or_obj, freqs=freqs, dirs=dirs)
-
-    def guess_can_open(self, filename_or_obj):
-        return False
-
-    description = "Open ERA5 netcdf spectra files as a wavespectra dataset."
-
-    url = "https://github.com/wavespectra/wavespectra"