grdwindinversion 0.3.5__py3-none-any.whl → 0.3.8__py3-none-any.whl

grdwindinversion/config_prod_v3.yaml

@@ -0,0 +1,70 @@
+no_subdir: True
+winddir_convention: "meteorological"
+add_gradientsfeatures: False
+add_nrcs_model: False
+S1A:
+    GMF_HH_NAME: "nc_lut_gmf_cmod5n_Rhigh_hh_mouche1"
+    GMF_VV_NAME: "gmf_cmod5n"
+    GMF_VH_NAME: "gmf_s1_v2"
+    dsig_VH_NAME: "gmf_s1_v2"
+    dsig_cr_step: "nrcs"
+    apply_flattening: True
+    S1_EW_calG>20190731:
+        GMF_HH_NAME: "nc_lut_gmf_cmod5n_Rhigh_hh_mouche1"
+        GMF_VV_NAME: "gmf_cmod5n"
+        GMF_VH_NAME: "gmf_s1_v3_ew_rec"
+        dsig_VH_NAME: "dsig_wspd_s1_ew_rec_v3"
+        dsig_cr_step: "wspd"
+        apply_flattening: True
+    recalibration: False
+    ancillary: "ecmwf"
+    inc_step: 0.1
+    wspd_step: 0.1
+    phi_step: 1.0
+    resolution: "high"
+S1B:
+    GMF_HH_NAME: "nc_lut_gmf_cmod5n_Rhigh_hh_mouche1"
+    GMF_VV_NAME: "gmf_cmod5n"
+    GMF_VH_NAME: "gmf_s1_v2"
+    dsig_VH_NAME: "gmf_s1_v2"
+    dsig_cr_step: "nrcs"
+    apply_flattening: True
+    S1_EW_calG>20190731:
+        GMF_HH_NAME: "nc_lut_gmf_cmod5n_Rhigh_hh_mouche1"
+        GMF_VV_NAME: "gmf_cmod5n"
+        GMF_VH_NAME: "gmf_s1_v3_ew_rec"
+        dsig_VH_NAME: "dsig_wspd_s1_ew_rec_v3"
+        dsig_cr_step: "wspd"
+        apply_flattening: True
+    recalibration: False
+    ancillary: "ecmwf"
+    inc_step: 0.1
+    wspd_step: 0.1
+    phi_step: 1.0
+    resolution: "high"
+RS2:
+    GMF_HH_NAME: "nc_lut_gmf_cmod5n_Rhigh_hh_mouche1"
+    GMF_VV_NAME: "gmf_cmod5n"
+    GMF_VH_NAME: "gmf_rs2_v3"
+    dsig_VH_NAME: "dsig_wspd_rs2_v3"
+    dsig_cr_step: "wspd"
+    apply_flattening: False
+    recalibration: False
+    ancillary: "ecmwf"
+    inc_step: 0.1
+    wspd_step: 0.1
+    phi_step: 1.0
+    resolution: "high"
+RCM:
+    GMF_HH_NAME: "nc_lut_gmf_cmod5n_Rhigh_hh_mouche1"
+    GMF_VV_NAME: "gmf_cmod5n"
+    GMF_VH_NAME: "gmf_rcm_v3"
+    dsig_VH_NAME: "dsig_wspd_rcm_v3"
+    dsig_cr_step: "wspd"
+    apply_flattening: True
+    recalibration: False
+    ancillary: "ecmwf"
+    inc_step: 0.1
+    wspd_step: 0.1
+    phi_step: 1.0
+    resolution: "high"

grdwindinversion/inversion.py

@@ -14,7 +14,7 @@ import yaml
 from scipy.ndimage import binary_dilation
 import re
 import string
-from grdwindinversion.utils import check_incidence_range, get_pol_ratio_name, timing
+from grdwindinversion.utils import check_incidence_range, get_pol_ratio_name, timing, convert_polarization_name
 from grdwindinversion.load_config import getConf
 import logging
 import os
@@ -101,8 +101,9 @@ def getOutputName(
             "(...)_(..)_(...)(.)_(.)(.)(..)_(........T......)_(........T......)_(......)_(......)_(....).SAFE"
         )
         template = string.Template(
-            "${MISSIONID}_${BEAM}_${PRODUCT}${RESOLUTION}_${LEVEL}${CLASS}${POL}_${STARTDATE}_${STOPDATE}_${ORBIT}_${TAKEID}_${PRODID}.SAFE"
+            "${MISSIONID}_${SWATH}_${PRODUCT}${RESOLUTION}_${LEVEL}${CLASS}${POLARIZATION}_${STARTDATE}_${STOPDATE}_${ORBIT}_${TAKEID}_${PRODID}.SAFE"
         )
+        # S1A_IW_GRDH_1SDV_20210909T130650_20210909T130715_039605_04AE83_C34F
         match = regex.match(basename_match)
         if not match:
             raise AttributeError(
@@ -111,25 +112,27 @@ def getOutputName(
 
         (
             MISSIONID,
-            BEAM,
+            SWATH,
             PRODUCT,
             RESOLUTION,
             LEVEL,
             CLASS,
-            POL,
+            POLARIZATION,
             STARTDATE,
             STOPDATE,
             ORBIT,
             TAKEID,
             PRODID,
         ) = match.groups()
-        new_format = f"{MISSIONID.lower()}-{BEAM.lower()}-owi-xx-{STARTDATE.lower()}-{STOPDATE.lower()}-{ORBIT}-{TAKEID}.nc"
+        # last two terms of polarization are removed
+        new_format = f"{MISSIONID.lower()}-{SWATH.lower()}-owi-{POLARIZATION.lower()}-{STARTDATE.lower()}-{STOPDATE.lower()}-{ORBIT}-{TAKEID}.nc"
     elif sensor == "RS2":
         regex = re.compile(
             "(RS2)_OK([0-9]+)_PK([0-9]+)_DK([0-9]+)_(....)_(........)_(......)_(.._?.?.?)_(S.F)"
         )
+        # RS2_OK141302_PK1242223_DK1208537_SCWA_20220904_093402_VV_VH_SGF
         template = string.Template(
-            "${MISSIONID}_OK${DATA1}_PK${DATA2}_DK${DATA3}_${DATA4}_${DATE}_${TIME}_${POLARIZATION}_${LAST}"
+            "${MISSIONID}_OK${DATA1}_PK${DATA2}_DK${DATA3}_${SWATH}_${DATE}_${TIME}_${POLARIZATION}_${LAST}"
         )
         match = regex.match(basename_match)
         if not match:
@@ -137,25 +140,27 @@ def getOutputName(
                 f"RC2 file {basename_match} does not match the expected pattern"
             )
 
-        MISSIONID, DATA1, DATA2, DATA3, DATA4, DATE, TIME, POLARIZATION, LAST = (
+        MISSIONID, DATA1, DATA2, DATA3, SWATH, DATE, TIME, POLARIZATION, LAST = (
             match.groups()
         )
-        new_format = f"{MISSIONID.lower()}--owi-xx-{meta_start_date.lower()}-{meta_stop_date.lower()}-_____-_____.nc"
+        new_format = f"{MISSIONID.lower()}-{SWATH.lower()}-owi-{convert_polarization_name(POLARIZATION)}-{meta_start_date.lower()}-{meta_stop_date.lower()}-_____-_____.nc"
     elif sensor == "RCM":
 
         regex = re.compile(
             r"(RCM[0-9])_OK([0-9]+)_PK([0-9]+)_([0-9]+)_([A-Z0-9]+)_(\d{8})_(\d{6})_([A-Z]{2}(?:_[A-Z]{2})?)_([A-Z]+)$"
         )
+        # RCM1_OK2767220_PK2769320_1_SCLND_20230930_214014_VV_VH_GRD
+
         match = regex.match(basename_match)
         if not match:
             raise AttributeError(
                 f"RCM file {basename_match} does not match the expected pattern"
             )
 
-        MISSIONID, DATA1, DATA2, DATA3, BEAM, DATE, TIME, POLARIZATION, PRODUCT = (
+        MISSIONID, DATA1, DATA2, DATA3, SWATH, DATE, TIME, POLARIZATION, PRODUCT = (
             match.groups()
         )
-        new_format = f"{MISSIONID.lower()}-{BEAM.lower()}-owi-xx-{meta_start_date.lower()}-{meta_stop_date.lower()}-_____-_____.nc"
+        new_format = f"{MISSIONID.lower()}-{SWATH.lower()}-owi-{convert_polarization_name(POLARIZATION)}-{meta_start_date.lower()}-{meta_stop_date.lower()}-_____-_____.nc"
 
     else:
         raise ValueError(
@@ -184,7 +189,6 @@ def getAncillary(meta, ancillary_name="ecmwf"):
     """
 
     if ancillary_name == "ecmwf":
-
         logging.debug("conf: %s", getConf())
         ec01 = getConf()["ecmwf_0100_1h"]
         ec0125 = getConf()["ecmwf_0125_1h"]
@@ -277,6 +281,93 @@ def getAncillary(meta, ancillary_name="ecmwf"):
             "ancillary_name must be ecmwf/era5, got %s" % ancillary_name)
 
 
+@timing(logger=logger.debug)
+def inverse_dsig_wspd(
+    dual_pol,
+    inc,
+    sigma0,
+    sigma0_dual,
+    ancillary_wind,
+    nesz_cr,
+    dsig_cr_name,
+    model_co,
+    model_cross,
+    **kwargs,
+):
+    """
+    Invert sigma0 to retrieve wind using model (lut or gmf).
+
+    Parameters
+    ----------
+    dual_pol: bool
+        True if dualpol, False if singlepol
+    inc: xarray.DataArray
+        incidence angle
+    sigma0: xarray.DataArray
+        sigma0 to be inverted
+    sigma0_dual: xarray.DataArray
+        sigma0 to be inverted for dualpol
+    ancillary_wind=: xarray.DataArray (numpy.complex28)
+        ancillary wind
+            | (for example ecmwf winds), in **ANTENNA convention**,
+    nesz_cr: xarray.DataArray
+        noise equivalent sigma0 | flattened or not 
+    dsig_cr_name:  str
+        dsig_cr name
+    model_co: str
+        model to use for VV or HH polarization.
+    model_cross: str
+        model to use for VH or HV polarization.
+
+    Returns
+    -------
+    xarray.DataArray 
+        inverted wind in copol in ** antenna convention** .
+    xarray.DataArray 
+        inverted wind in dualpol in ** antenna convention** .
+    xarray.DataArray 
+        inverted wind in crosspol in ** antenna convention** .
+    xarray.DataArray | array
+        alpha (ponderation between co and crosspol)
+
+    See Also
+    --------
+    xsarsea documentation
+    https://cerweb.ifremer.fr/datarmor/doc_sphinx/xsarsea/
+    """
+
+    # dsig_cr_step == "wspd":
+
+    wind_co = xsarsea.windspeed.invert_from_model(
+        inc,
+        sigma0,
+        ancillary_wind=ancillary_wind,
+        model=model_co,
+        **kwargs
+    )
+
+    if dual_pol:
+
+        wind_cross = windspeed.invert_from_model(
+            inc.values,
+            sigma0_dual.values,
+            model=model_cross,
+            **kwargs,
+        )
+
+        wspd_co = np.abs(wind_co)
+        wspd_cross = np.abs(wind_cross)
+        SNR_cross = sigma0_dual.values/nesz_cr.values
+        alpha = windspeed.get_dsig_wspd(dsig_cr_name, wind_cross, SNR_cross)
+
+        wpsd_dual = alpha * wspd_co + (1 - alpha) * wspd_cross
+        wind_dual = wpsd_dual * np.exp(1j * np.angle(wind_co))
+
+        return wind_co, wind_dual, wind_cross, alpha
+
+    return wind_co, None, None, None
+
+
 @timing(logger=logger.debug)
 def inverse(
     dual_pol,
@@ -316,8 +407,12 @@ def inverse(
 
     Returns
     -------
-    xarray.DataArray or tuple
-        inverted wind in ** antenna convention** .
+    xarray.DataArray 
+        inverted wind in copol in ** antenna convention** .
+    xarray.DataArray 
+        inverted wind in dualpol in ** antenna convention** .
+    xarray.DataArray 
+        inverted wind in crosspol in ** antenna convention** .
 
     See Also
     --------
@@ -514,8 +609,15 @@ def makeL2asOwi(xr_dataset, config):
         )
 
     if config["l2_params"]["dual_pol"]:
+        if config["dsig_cr_step"] == "nrcs":
+            xr_dataset = xr_dataset.rename({
+                'dsig_cross': 'owiDsig_cross',
+            })
+        else:
+            xr_dataset = xr_dataset.rename({
+                'alpha': 'owiAlpha',
+            })
         xr_dataset = xr_dataset.rename({
-            'dsig_cross': 'owiDsig_cross',
             'winddir_cross': 'owiWindDirection_cross',
             'winddir_dual': 'owiWindDirection',
             'windspeed_cross': 'owiWindSpeed_cross',
@@ -779,6 +881,7 @@ def preprocess(
         )
 
     try:
+        logging.info(f"recalibration = {recalibration}")
         if (recalibration) & ("SENTINEL" in sensor_longname):
             logging.info(
                 f"recalibration is {recalibration} : Kersten formula is applied"
@@ -850,8 +953,23 @@ def preprocess(
         copol_gmf = "HH"
         crosspol_gmf = "VH"
 
-    model_co = config["GMF_" + copol_gmf + "_NAME"]
-    model_cross = config["GMF_" + crosspol_gmf + "_NAME"]
+    cond_aux_cal = (sensor == "S1A" or sensor == "S1B") and (
+        xsar_dataset.dataset.attrs["aux_cal"].split("_")[-1][1:9] > '20190731')
+    if cond_aux_cal and xr_dataset.attrs["swath"] == "EW" and "S1_EW_calG>20190731" in config.keys():
+        model_co = config["S1_EW_calG>20190731"]["GMF_" + copol_gmf + "_NAME"]
+        model_cross = config["S1_EW_calG>20190731"]["GMF_" +
+                                                    crosspol_gmf + "_NAME"]
+        dsig_cr_name = config["S1_EW_calG>20190731"]["dsig_" +
+                                                     crosspol_gmf + "_NAME"]
+        apply_flattening = config["S1_EW_calG>20190731"]["apply_flattening"]
+        dsig_cr_step = config["S1_EW_calG>20190731"]["dsig_cr_step"]
+
+    else:
+        model_co = config["GMF_" + copol_gmf + "_NAME"]
+        model_cross = config["GMF_" + crosspol_gmf + "_NAME"]
+        dsig_cr_name = config["dsig_" + crosspol_gmf + "_NAME"]
+        apply_flattening = config["apply_flattening"]
+        dsig_cr_step = config["dsig_cr_step"]
 
     # register paramaters in config
     config["l2_params"]["dual_pol"] = dual_pol
@@ -863,6 +981,9 @@ def preprocess(
     config["l2_params"]["model_cross"] = model_cross
     config["sensor_longname"] = sensor_longname
     config["sensor"] = sensor
+    config["dsig_cr_step"] = dsig_cr_step
+    config["dsig_cr_name"] = dsig_cr_name
+    config["apply_flattening"] = apply_flattening
 
     # need to load LUTs before inversion
     nc_luts = [x for x in [model_co, model_cross] if x.startswith("nc_lut")]
@@ -1043,66 +1164,39 @@ def preprocess(
         xr_dataset['nesz_cross_flattened'].attrs[
             "comment"] = 'nesz has been flattened using windspeed.nesz_flattening'
 
-        if config["apply_flattening"]:
-            # dsig
-            xr_dataset["dsig_cross"] = windspeed.get_dsig(
-                config["dsig_" + crosspol_gmf + "_NAME"],
-                xr_dataset.incidence,
-                xr_dataset["sigma0_ocean"].sel(pol=crosspol),
-                xr_dataset.nesz_cross_flattened,
-            )
-
-            xr_dataset.dsig_cross.attrs["formula_used"] = config[
-                "dsig_" + crosspol_gmf + "_NAME"
-            ]
-
-        else:
+        if dsig_cr_step == "nrcs":
             # dsig
-            xr_dataset["dsig_cross"] = windspeed.get_dsig(
-                config["dsig_" + crosspol_gmf + "_NAME"],
-                xr_dataset.incidence,
-                xr_dataset["sigma0_ocean"].sel(pol=crosspol),
-                xr_dataset.nesz.sel(pol=crosspol),
-            )
-
-        xr_dataset.dsig_cross.attrs["comment"] = (
-            "variable used to ponderate copol and crosspol"
-        )
+            if apply_flattening:
+                xr_dataset["dsig_cross"] = windspeed.get_dsig(
+                    dsig_cr_name,
+                    xr_dataset.incidence,
+                    xr_dataset["sigma0_ocean"].sel(pol=crosspol),
+                    xr_dataset.nesz_cross_flattened,
+                )
 
-        xr_dataset.dsig_cross.attrs["apply_flattening"] = str(
-            config["apply_flattening"]
-        )
+                xr_dataset.dsig_cross.attrs["formula_used"] = config[
+                    "dsig_" + crosspol_gmf + "_NAME"
+                ]
 
-    if (recalibration) & ("SENTINEL" in sensor_longname):
-        xr_dataset.attrs["path_aux_pp1_new"] = os.path.basename(
-            os.path.dirname(
-                os.path.dirname(
-                    xsar_dataset.datatree["recalibration"].attrs["path_aux_pp1_new"]
-                )
-            )
-        )
-        xr_dataset.attrs["path_aux_cal_new"] = os.path.basename(
-            os.path.dirname(
-                os.path.dirname(
-                    xsar_dataset.datatree["recalibration"].attrs["path_aux_cal_new"]
+            else:
+                xr_dataset["dsig_cross"] = windspeed.get_dsig(
+                    dsig_cr_name,
+                    xr_dataset.incidence,
+                    xr_dataset["sigma0_ocean"].sel(pol=crosspol),
+                    xr_dataset.nesz.sel(pol=crosspol),
                 )
-            )
-        )
 
-        xr_dataset.attrs["path_aux_pp1_old"] = os.path.basename(
-            os.path.dirname(
-                os.path.dirname(
-                    xsar_dataset.datatree["recalibration"].attrs["path_aux_pp1_old"]
-                )
+            xr_dataset.dsig_cross.attrs["comment"] = (
+                "variable used to ponderate copol and crosspol. this ponderation is done will combining cost functions during inversion process"
             )
-        )
-        xr_dataset.attrs["path_aux_cal_old"] = os.path.basename(
-            os.path.dirname(
-                os.path.dirname(
-                    xsar_dataset.datatree["recalibration"].attrs["path_aux_cal_old"]
-                )
+
+            xr_dataset.dsig_cross.attrs["apply_flattening"] = str(
+                apply_flattening
             )
-        )
+
+    if (recalibration) & ("SENTINEL" in sensor_longname):
+        xr_dataset.attrs["aux_cal_recal"] = xsar_dataset.datatree["recalibration"].attrs["aux_cal_new"]
+        xr_dataset.attrs["aux_pp1_recal"] = xsar_dataset.datatree["recalibration"].attrs["aux_pp1_new"]
 
     if add_nrcs_model:
         # add timing
@@ -1276,6 +1370,7 @@ def makeL2(
         input filename
     outdir : str
         output folder
+
     config_path : str
         configuration file path
     overwrite : bool, optional
@@ -1311,10 +1406,15 @@ def makeL2(
     dual_pol = config["l2_params"]["dual_pol"]
     ancillary_name = config["ancillary"]
     sensor_longname = config["sensor_longname"]
-
+    dsig_cr_step = config["dsig_cr_step"]
+    dsig_cr_name = config["dsig_cr_name"]
+    apply_flattening = config["apply_flattening"]
     if dual_pol:
         sigma0_ocean_cross = xr_dataset["sigma0_ocean"].sel(pol=crosspol)
-        dsig_cross = xr_dataset["dsig_cross"]
+        if dsig_cr_step == "nrcs":
+            dsig_cross = xr_dataset["dsig_cross"]
+        else:
+            dsig_cross = 0.1
     else:
         sigma0_ocean_cross = None
         dsig_cross = 0.1  # default value set in xsarsea
@@ -1334,18 +1434,50 @@ def makeL2(
     inc_check_co, inc_check_cross = check_incidence_range(
         xr_dataset["incidence"], [model_co, model_cross], **kwargs
     )
+    if dsig_cr_step == "nrcs":
+        logging.info(
+            "dsig_cr_step is nrcs : polarization are mixed at cost function step")
+        wind_co, wind_dual, windspeed_cr = inverse(
+            dual_pol,
+            inc=xr_dataset["incidence"],
+            sigma0=xr_dataset["sigma0_ocean"].sel(pol=copol),
+            sigma0_dual=sigma0_ocean_cross,
+            ancillary_wind=xr_dataset["ancillary_wind"],
+            dsig_cr=dsig_cross,
+            model_co=model_co,
+            model_cross=model_cross,
+            **kwargs,
+        )
+    elif dsig_cr_step == "wspd":
+        logging.info(
+            "dsig_cr_step is wspd : polarization are mixed at winds speed step")
+
+        if apply_flattening:
+            nesz_cross = xr_dataset["nesz_cross_flattened"]
+        else:
+            nesz_cross = xr_dataset.nesz.sel(pol=crosspol)
+
+        wind_co, wind_dual, windspeed_cr, alpha = inverse_dsig_wspd(
+            dual_pol,
+            inc=xr_dataset["incidence"],
+            sigma0=xr_dataset["sigma0_ocean"].sel(pol=copol),
+            sigma0_dual=sigma0_ocean_cross,
+            ancillary_wind=xr_dataset["ancillary_wind"],
+            nesz_cr=nesz_cross,
+            dsig_cr_name=dsig_cr_name,
+            model_co=model_co,
+            model_cross=model_cross,
+            **kwargs
+        )
+        xr_dataset["alpha"] = xr.DataArray(
+            data=alpha, dims=xr_dataset["incidence"].dims, coords=xr_dataset["incidence"].coords)
+        xr_dataset["alpha"].attrs["apply_flattening"] = str(apply_flattening)
+        xr_dataset["alpha"].attrs["comments"] = "alpha used to ponderate copol and crosspol. this ponderation is done will combining wind speeds."
+
+    else:
+        raise ValueError(
+            f"dsig_cr_step must be 'nrcs' or 'wspd', got {dsig_cr_step}")
 
-    wind_co, wind_dual, windspeed_cr = inverse(
-        dual_pol,
-        inc=xr_dataset["incidence"],
-        sigma0=xr_dataset["sigma0_ocean"].sel(pol=copol),
-        sigma0_dual=sigma0_ocean_cross,
-        ancillary_wind=xr_dataset["ancillary_wind"],
-        dsig_cr=dsig_cross,
-        model_co=model_co,
-        model_cross=model_cross,
-        **kwargs,
-    )
     # windspeed_co
     xr_dataset["windspeed_co"] = np.abs(wind_co)
     xr_dataset["windspeed_co"].attrs["units"] = "m.s⁻1"
@@ -1373,8 +1505,11 @@ def makeL2(
             % (model_co, copol, model_cross, crosspol)
         )
         xr_dataset["windspeed_dual"].attrs["standart_name"] = "wind_speed"
-        xr_dataset["windspeed_dual"].attrs["model"] = wind_dual.attrs["model"]
-        del xr_dataset["windspeed_dual"].attrs["comment"]
+        xr_dataset["windspeed_dual"].attrs["model"] = (model_co, model_cross)
+        xr_dataset["windspeed_dual"].attrs["combining_method"] = dsig_cr_step
+
+        if "comment" in xr_dataset["windspeed_dual"].attrs:
+            del xr_dataset["windspeed_dual"].attrs["comment"]
 
         xr_dataset["winddir_dual"] = transform_winddir(
             wind_dual,
@@ -1477,12 +1612,7 @@ def makeL2(
         "coverage": xr_dataset.attrs["coverage"],
     }
 
-    for recalib_attrs in [
-        "path_aux_pp1_new",
-        "path_aux_pp1_old",
-        "path_aux_cal_new",
-        "path_aux_cal_old",
-    ]:
+    for recalib_attrs in ["aux_pp1_recal", "aux_pp1", "aux_cal_recal", "aux_cal"]:
         if recalib_attrs in xr_dataset.attrs:
             attrs[recalib_attrs] = xr_dataset.attrs[recalib_attrs]
 
@@ -1490,7 +1620,7 @@ def makeL2(
         if arg in xr_dataset.attrs:
             attrs["passDirection"] = xr_dataset.attrs[arg]
 
-    _S1_added_attrs = ["ipf", "platform_heading"]
+    _S1_added_attrs = ["ipf_version", "platform_heading"]
     _RCM_added_attrs = ["productId"]
 
     for sup_attr in _S1_added_attrs + _RCM_added_attrs:

grdwindinversion/utils.py

@@ -18,6 +18,31 @@ except ImportError:
     mem_monitor = False
 
 
+def convert_polarization_name(pol):
+    """
+    Convert polarization name to the format used in the output filename
+    
+    Parameters
+    ----------
+    pol : str
+        polarization name
+        
+    Returns
+    ------- 
+    str
+        polarization name in the format used in the output filename (dv/dh/sv/sh/xx)
+    """
+    if pol == "VV_VH":
+        return "dv"
+    elif pol == "HH_HV":
+        return "dh"
+    elif pol == "VV":
+        return "sv"
+    elif pol == "HH":
+        return "sh"
+    else:
+        return "xx"
+
 def check_incidence_range(incidence, models, **kwargs):
     """
     Check if the incidence range of the dataset is within the range of the LUT of the model.

{grdwindinversion-0.3.5.dist-info → grdwindinversion-0.3.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: grdwindinversion
-Version: 0.3.5
+Version: 0.3.8
 Summary: Package to perform Wind inversion from GRD Level-1 SAR images
 Author-email: Antoine Grouazel <antoine.grouazel@ifremer.fr>
 License: MIT
@@ -27,6 +27,8 @@ Requires-Dist: numpy
 Requires-Dist: scipy
 Requires-Dist: fsspec
 Requires-Dist: aiohttp
+Requires-Dist: xmlschema==3.4.3
+Dynamic: license-file
 
 
 [![Python Version](https://img.shields.io/pypi/pyversions/grdwindinversion.svg)](https://pypi.org/project/grdwindinversion/)
@@ -35,7 +37,7 @@ Requires-Dist: aiohttp
 Package to perform Wind inversion from GRD Level-1 SAR images
 
 -   Free software: MIT license
--   Documentation: https://grdwindinversion.readthedocs.io.
+-   Documentation: https://cerweb.ifremer.fr/datarmor/doc_sphinx/grdwindinversion/index.html.
 
 ## Usage
 

{grdwindinversion-0.3.5.dist-info → grdwindinversion-0.3.8.dist-info}/RECORD

@@ -5,18 +5,19 @@ grdwindinversion/config_prod_recal.yaml,sha256=74n2J4tzSx1I5vaat3ydwig1jyfDgxGTG
 grdwindinversion/config_prod_recal_streaks_nrcsmod.yaml,sha256=ob0YmzHrwkI4GLxaR9HzidYtXBrTOAlEYwPYdCK7AqA,1092
 grdwindinversion/config_prod_streaks.yaml,sha256=lJMl4qH6XYqO8ich7yW0WDQsQDrjmWThlLyx1xZy1DA,1313
 grdwindinversion/config_prod_streaks_nrcsmod.yaml,sha256=4yC4KcsC7rUumYHwhpKxM8_LDMe_Je-RIu4-9e1ayp8,1312
+grdwindinversion/config_prod_v3.yaml,sha256=J6lb8swIa7M-P4DjnTqKP1Bzp3b2XWNZp_E1FCrPGXQ,1953
 grdwindinversion/data_config.yaml,sha256=FnglUHbAtGwHWg8w86hwZt3-vo-dY8uIjxqyI1jZpv8,567
 grdwindinversion/gradientFeatures.py,sha256=NIeAJzb1zrlJPBq1th7wjEZoNJMxwqDpNHLMWP6FQN0,18198
-grdwindinversion/inversion.py,sha256=rRqmDDL0byTJPu5PZIalTALSaQBNiIXYJpdS2eGYDiI,56525
+grdwindinversion/inversion.py,sha256=4AM5CUyLexHW4yX7yMspfW2osA4DTGm8I0KTWZbPiUA,61752
 grdwindinversion/load_config.py,sha256=ZPozOWt0rf2Pmyc6P2D75cE_9wKUfKfr7RUzlE3WoiY,833
 grdwindinversion/main.py,sha256=Cwmxxz-PEt53JvpTL0Jx1WKLJpWvlIXZ9xtnyGKrGHY,3254
-grdwindinversion/utils.py,sha256=Jj2M433WC9z5Yk4yZaUxSnKwCskfCzB_EsIbVDW5PPw,3818
+grdwindinversion/utils.py,sha256=2BRq_UEbKbP5yCy_0X-nV-SQFmmp4aKrFaRgrs5MqJo,4347
 grdwindinversion/utils_memory.py,sha256=NA0bvkpCTkEiqCcJuldG1XsrP40-3AQUUt3HLeoRpbY,1432
 grdwindinversion/.github/ISSUE_TEMPLATE.md,sha256=qiM_a7CCUz3fSrz3Q20Se1nwPNFS8QCc8tkwK_0DSCo,327
-grdwindinversion-0.3.5.dist-info/AUTHORS.rst,sha256=KmhW_5LBKGTIGwWEVkoTm1qx_bvdDR3yYL-1cwbDOFQ,218
-grdwindinversion-0.3.5.dist-info/LICENSE,sha256=-B8mBiTeY3J7OLuayiV1myqmc7yeijBc7s34kc8RTmg,1075
-grdwindinversion-0.3.5.dist-info/METADATA,sha256=Ox0BIVGEoEmbnEyv9a3SH7fQLwAXfo_RV7VeTXgZh7g,2441
-grdwindinversion-0.3.5.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-grdwindinversion-0.3.5.dist-info/entry_points.txt,sha256=2rjvlVCy0iasRXjOz3kOIGuy2OCGQ-VTNuwuViQ6cMM,95
-grdwindinversion-0.3.5.dist-info/top_level.txt,sha256=z6lPix3QPEYOo37qq8plA2hY7S3C8MQZY81agRlksMI,17
-grdwindinversion-0.3.5.dist-info/RECORD,,
+grdwindinversion-0.3.8.dist-info/licenses/AUTHORS.rst,sha256=KmhW_5LBKGTIGwWEVkoTm1qx_bvdDR3yYL-1cwbDOFQ,218
+grdwindinversion-0.3.8.dist-info/licenses/LICENSE,sha256=-B8mBiTeY3J7OLuayiV1myqmc7yeijBc7s34kc8RTmg,1075
+grdwindinversion-0.3.8.dist-info/METADATA,sha256=Zhr0ANP7Ek5Kb5zzEBoh8cheWMmvI91EwfbclEOlens,2529
+grdwindinversion-0.3.8.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+grdwindinversion-0.3.8.dist-info/entry_points.txt,sha256=2rjvlVCy0iasRXjOz3kOIGuy2OCGQ-VTNuwuViQ6cMM,95
+grdwindinversion-0.3.8.dist-info/top_level.txt,sha256=z6lPix3QPEYOo37qq8plA2hY7S3C8MQZY81agRlksMI,17
+grdwindinversion-0.3.8.dist-info/RECORD,,

{grdwindinversion-0.3.5.dist-info → grdwindinversion-0.3.8.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.8.0)
+Generator: setuptools (78.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any