grdwindinversion 0.3.9__py3-none-any.whl → 1.0.1__py3-none-any.whl

grdwindinversion/main.py

@@ -20,7 +20,6 @@ def processor_starting_point():
 
     from grdwindinversion.inversion import makeL2
     from grdwindinversion.utils_memory import get_memory_usage
-    from grdwindinversion.load_config import config_path
     import grdwindinversion
 
     parser = argparse.ArgumentParser(
@@ -68,8 +67,6 @@ def processor_starting_point():
         )
     t0 = time.time()
 
-    logging.info("config path: %s", config_path)
-
     input_file = args.input_file.rstrip("/")
     logging.info("input file: %s", input_file)
 
@@ -84,7 +81,7 @@ def processor_starting_point():
     if resolution == "full":
         resolution = None
 
-    out_file, outputds = makeL2(
+    out_file, outputds, return_status = makeL2(
         input_file,
         out_folder,
         config_file,
@@ -97,6 +94,8 @@ def processor_starting_point():
     logging.info("current memory usage: %s ", get_memory_usage(var="current"))
     logging.info("done in %1.3f min", (time.time() - t0) / 60.0)
 
+    sys.exit(return_status)
+
 
 if __name__ == "__main__":
     processor_starting_point()

grdwindinversion/utils.py

@@ -21,12 +21,12 @@ except ImportError:
 def convert_polarization_name(pol):
     """
     Convert polarization name to the format used in the output filename
-    
+
     Parameters
     ----------
     pol : str
         polarization name
-        
+
     Returns
     ------- 
     str
@@ -43,6 +43,7 @@ def convert_polarization_name(pol):
     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.
@@ -80,8 +81,8 @@ def check_incidence_range(incidence, models, **kwargs):
         if inc_range[0] >= lut_range[0] and inc_range[1] <= lut_range[1]:
             rets.append(True)
         else:
-            logging.warn(
-                f"incidence range {inc_range} is not within the range of the LUT of the model {model_name} {lut_range} : inversion will be approximate using LUT minmium|maximum incidences"
+            logging.warning(
+                f"check_incidence_range warning : incidence range {inc_range} is not within the range of the LUT of the model {model_name} {lut_range} : inversion will be approximate using LUT minmium|maximum incidences"
             )
             rets.append(False)
 
@@ -115,7 +116,7 @@ def get_pol_ratio_name(model_co):
                     vvgmf, res, polrationame = match.groups()
                     return polrationame
                 else:
-                    logging.warn(
+                    logging.warning(
                         f"String format is not correct for polarization ratio name = {s}\nReturning '/'"
                     )
                     return "/"
@@ -145,10 +146,114 @@ def timing(logger=logger.debug):
             if mem_monitor:
                 endrss = process.memory_info().rss
                 mem_str = "mem: %+.1fMb" % ((endrss - startrss) / (1024**2))
-            logger("timing %s : %.2fs. %s" % (f.__name__, endtime - starttime, mem_str))
+            logger("timing %s : %.2fs. %s" %
+                   (f.__name__, endtime - starttime, mem_str))
             return result
 
         wrapper.__doc__ = f.__doc__
         return wrapper
 
     return decorator
+
+
+def test_config(config):
+    """
+    Validate configuration structure.
+
+    Checks that the configuration contains all required fields:
+    - ancillary_sources (with ecmwf or era5)
+    - nc_luts_path (required)
+    - lut_cmod7_path (optional - required only if using gmf_cmod7)
+    - lut_ms1ahw_path (optional - required only if using gmf_cmodms1ahw)
+    - masks (optional)
+
+    Note: If you use predefined LUTs (gmf_cmod7, gmf_cmodms1ahw, etc.),
+    they must be loaded with the corresponding path keywords:
+    - gmf_cmod7 requires lut_cmod7_path
+    - gmf_cmodms1ahw requires lut_ms1ahw_path
+
+    Parameters
+    ----------
+    config : dict
+        Configuration dictionary to validate
+
+    Raises
+    ------
+    ValueError
+        If configuration is missing required fields or has invalid structure
+    """
+    # Check ancillary_sources
+    if 'ancillary_sources' not in config:
+        raise ValueError("Configuration must contain 'ancillary_sources'")
+
+    if not isinstance(config['ancillary_sources'], dict):
+        raise ValueError("'ancillary_sources' must be a dictionary")
+
+    if not config['ancillary_sources']:
+        raise ValueError("'ancillary_sources' must not be empty")
+
+    # Check that at least ecmwf or era5 is configured
+    has_ecmwf = 'ecmwf' in config['ancillary_sources']
+    has_era5 = 'era5' in config['ancillary_sources']
+    if not (has_ecmwf or has_era5):
+        raise ValueError(
+            "'ancillary_sources' must contain at least 'ecmwf' or 'era5'")
+
+    # Validate ancillary sources structure
+    for ancillary_type, sources in config['ancillary_sources'].items():
+        if not isinstance(sources, list):
+            raise ValueError(
+                f"'ancillary_sources.{ancillary_type}' must be a list")
+        if not sources:
+            raise ValueError(
+                f"'ancillary_sources.{ancillary_type}' must not be empty")
+
+        for source in sources:
+            if 'name' not in source:
+                raise ValueError(
+                    f"Each source in 'ancillary_sources.{ancillary_type}' must have a 'name' field")
+            if 'path' not in source:
+                raise ValueError(
+                    f"Each source in 'ancillary_sources.{ancillary_type}' must have a 'path' field")
+    # Check LUT paths
+    if 'nc_luts_path' not in config:
+        raise ValueError("Configuration must contain 'nc_luts_path'")
+    else:
+        logger.debug(f"nc_luts_path found: {config['nc_luts_path']}")
+
+    # Optional LUT paths (only needed if using specific GMFs)
+    if 'lut_cmod7_path' in config:
+        logger.debug(f"lut_cmod7_path found: {config['lut_cmod7_path']}")
+    if 'lut_ms1ahw_path' in config:
+        logger.debug(f"lut_ms1ahw_path found: {config['lut_ms1ahw_path']}")
+
+    # Validate masks structure if present (optional)
+    if 'masks' in config:
+        if not isinstance(config['masks'], dict):
+            raise ValueError("'masks' must be a dictionary")
+
+        for category, mask_list in config['masks'].items():
+            if not isinstance(mask_list, list):
+                raise ValueError(f"'masks.{category}' must be a list")
+
+            for mask in mask_list:
+                if 'name' not in mask:
+                    raise ValueError(
+                        f"Each mask in 'masks.{category}' must have a 'name' field")
+                if 'path' not in mask:
+                    raise ValueError(
+                        f"Each mask in 'masks.{category}' must have a 'path' field")
+
+        logger.debug(f"Masks configured: {list(config['masks'].keys())}")
+    else:
+        logger.info("No masks configured (optional)")
+
+    # Check which sensors are configured
+    supported_sensors = ['S1A', 'S1B', 'S1C', 'S1D', 'RS2', 'RCM']
+    configured_sensors = [sensor for sensor in supported_sensors if sensor in config]
+    if configured_sensors:
+        logger.info(f"Sensors configured: {', '.join(configured_sensors)}")
+    else:
+        logger.warning("No sensors configured - at least one sensor (S1A, S1B, S1C, S1D, RS2, RCM) should be present")
+
+    logger.info("Configuration validation passed")

{grdwindinversion-0.3.9.dist-info → grdwindinversion-1.0.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: grdwindinversion
-Version: 0.3.9
+Version: 1.0.1
 Summary: Package to perform Wind inversion from GRD Level-1 SAR images
 Author-email: Antoine Grouazel <antoine.grouazel@ifremer.fr>
 License: MIT

grdwindinversion-1.0.1.dist-info/RECORD

@@ -0,0 +1,20 @@
+grdwindinversion/.gitignore,sha256=vmDRHGeESYckUdUztsPr7u6ZNfBYMCVR3GE3AJCBnsY,1204
+grdwindinversion/__init__.py,sha256=WElmPGXfKJ2BbiiBiFLyJObZHEmglAgKZcso7Pl7NhU,331
+grdwindinversion/config_prod_recal.yaml,sha256=Dg8VBZRIEVF0ASC6XLPbv06kwLgNzF13cUwwkjVLW-A,4533
+grdwindinversion/config_prod_recal_streaks_nrcsmod.yaml,sha256=bMdnQnqLvwXVxymCAT0a19mYAgAVjeZgJP8OUHMDIMg,4531
+grdwindinversion/config_prod_streaks.yaml,sha256=II4r-PIgtzAmjw4s307UQGkrfTwmgpympxC9Pmzhulw,4539
+grdwindinversion/config_prod_streaks_nrcsmod.yaml,sha256=k18T5rXS7LRV3n69AOPrhBYWl1io9z4juJ-Z3cjo8ps,4537
+grdwindinversion/config_prod_v3.yaml,sha256=BNXi8r5cF3GkdD126g7y1tAnSpyZwwWoThh87xIP6bQ,4540
+grdwindinversion/gradientFeatures.py,sha256=NIeAJzb1zrlJPBq1th7wjEZoNJMxwqDpNHLMWP6FQN0,18198
+grdwindinversion/inversion.py,sha256=R2PtzY8b94ouGRFLluwNP6_igGAg4YerqRhD1LGI-F8,73167
+grdwindinversion/main.py,sha256=4i5ecjt_hkSYUavS7CxsqR0OfLaWUoxrxambzMWyPbA,3191
+grdwindinversion/utils.py,sha256=9pQEyi6R3JUD0Deq3dJMOPnetyQZii7y8fgPO6wlIok,8496
+grdwindinversion/utils_memory.py,sha256=NA0bvkpCTkEiqCcJuldG1XsrP40-3AQUUt3HLeoRpbY,1432
+grdwindinversion/.github/ISSUE_TEMPLATE.md,sha256=qiM_a7CCUz3fSrz3Q20Se1nwPNFS8QCc8tkwK_0DSCo,327
+grdwindinversion-1.0.1.dist-info/licenses/AUTHORS.rst,sha256=C9EFY6YdOu5qAe6pNIvCvviXH91vCej-WxOobYftoMk,155
+grdwindinversion-1.0.1.dist-info/licenses/LICENSE,sha256=-B8mBiTeY3J7OLuayiV1myqmc7yeijBc7s34kc8RTmg,1075
+grdwindinversion-1.0.1.dist-info/METADATA,sha256=eTuwlA87-8eB9gF3irr5qiyRiNFHocBfoBrbGEx9fdg,2529
+grdwindinversion-1.0.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+grdwindinversion-1.0.1.dist-info/entry_points.txt,sha256=2rjvlVCy0iasRXjOz3kOIGuy2OCGQ-VTNuwuViQ6cMM,95
+grdwindinversion-1.0.1.dist-info/top_level.txt,sha256=z6lPix3QPEYOo37qq8plA2hY7S3C8MQZY81agRlksMI,17
+grdwindinversion-1.0.1.dist-info/RECORD,,

{grdwindinversion-0.3.9.dist-info → grdwindinversion-1.0.1.dist-info}/licenses/AUTHORS.rst

@@ -5,10 +5,6 @@ Authors
 Development Lead
 ----------------
 
-* Vincent Lheureux <vincent.lheureux@ifremer.fr>
+* Vincent Lheureux <vinc.lheureux@gmail.com>
 * Antoine Grouazel <antoine.grouazel@ifremer.fr>
 
-Contributors
-------------
-
-None yet. Why not be the first?

grdwindinversion/config_prod.yaml

@@ -1,52 +0,0 @@
-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"
-    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"
-    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_v2"
-    dsig_VH_NAME: "gmf_rs2_v2"
-    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_noaa"
-    dsig_VH_NAME: "gmf_s1_v2"
-    apply_flattening: True
-    recalibration: False
-    ancillary: "ecmwf"
-    inc_step: 0.1
-    wspd_step: 0.1
-    phi_step: 1.0
-    resolution: "high"

grdwindinversion/data_config.yaml

@@ -1,8 +0,0 @@
-'ecmwf_0100_1h': '../ecmwf/forecast/hourly/0100deg/netcdf_light_REPRO_tree/%Y/%j/ECMWF_FORECAST_0100_%Y%m%d%H%M_10U_10V.nc'
-'ecmwf_0125_1h': '../ecmwf/0.125deg/1h/forecasts/%Y/%j/ecmwf_%Y%m%d%H%M.nc'
-
-
-unit_test_s1_product: './sentinel-1a/L1/IW/S1A_IW_GRDH_1S/2021/252/S1A_IW_GRDH_1SDV_20210909T130650_20210909T130715_039605_04AE83_C34F.SAFE'
-unit_test_rcm_product: './l1/rcm/rcm-1/sclnd/2023/273/RCM1_OK2767220_PK2769320_1_SCLND_20230930_214014_VV_VH_GRD'
-unit_test_rs2_product: './L1/VV_VH/2022/247/RS2_OK141302_PK1242223_DK1208537_SCWA_20220904_093402_VV_VH_SGF'
-

grdwindinversion/load_config.py

@@ -1,30 +0,0 @@
-from yaml import load
-import logging
-import os
-import grdwindinversion
-from yaml import CLoader as Loader
-
-local_config_potential_path1 = os.path.expanduser(
-    "~/.grdwindinversion/data_config.yaml"
-)
-local_config_potential_path2 = os.path.join(
-    os.path.dirname(grdwindinversion.__file__), "local_data_config.yaml"
-)
-if os.path.exists(local_config_potential_path1):
-    config_path = local_config_potential_path1
-elif os.path.exists(local_config_potential_path2):
-    config_path = local_config_potential_path2
-else:
-    config_path = os.path.join(
-        os.path.dirname(grdwindinversion.__file__), "data_config.yaml"
-    )
-stream = open(config_path, "r")
-conf = load(stream, Loader=Loader)
-
-
-def getConf():
-    """
-    if local_config_potential_path exists it will superseed config_path
-    :return:
-    """
-    return conf

grdwindinversion-0.3.9.dist-info/RECORD

@@ -1,23 +0,0 @@
-grdwindinversion/.gitignore,sha256=vmDRHGeESYckUdUztsPr7u6ZNfBYMCVR3GE3AJCBnsY,1204
-grdwindinversion/__init__.py,sha256=LEeSGGPADHTtjujV48PD3lRVXxe-dg5_z1zWQTvBJNw,415
-grdwindinversion/config_prod.yaml,sha256=VEAgtJt894v3u4AhYOlcCWjb379vPDMfwBb4PKeDmAw,1314
-grdwindinversion/config_prod_recal.yaml,sha256=74n2J4tzSx1I5vaat3ydwig1jyfDgxGTGDxxw8ALC-U,1222
-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=YdIYJcQhX8bM2vhU4pDmT4BI8O0Mn4DVSS_LvB0CbgI,3136
-grdwindinversion/data_config.yaml,sha256=FnglUHbAtGwHWg8w86hwZt3-vo-dY8uIjxqyI1jZpv8,567
-grdwindinversion/gradientFeatures.py,sha256=NIeAJzb1zrlJPBq1th7wjEZoNJMxwqDpNHLMWP6FQN0,18198
-grdwindinversion/inversion.py,sha256=D8HQ4Ch2FvWXs7vkNfcSSl_ox1tf3WoemJZ9vZbR-Ww,62409
-grdwindinversion/load_config.py,sha256=ZPozOWt0rf2Pmyc6P2D75cE_9wKUfKfr7RUzlE3WoiY,833
-grdwindinversion/main.py,sha256=Cwmxxz-PEt53JvpTL0Jx1WKLJpWvlIXZ9xtnyGKrGHY,3254
-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.9.dist-info/licenses/AUTHORS.rst,sha256=KmhW_5LBKGTIGwWEVkoTm1qx_bvdDR3yYL-1cwbDOFQ,218
-grdwindinversion-0.3.9.dist-info/licenses/LICENSE,sha256=-B8mBiTeY3J7OLuayiV1myqmc7yeijBc7s34kc8RTmg,1075
-grdwindinversion-0.3.9.dist-info/METADATA,sha256=6Om_Kjm7yZYOylA7puJhcumBy9UwmIIq0xoxf_3W5d0,2529
-grdwindinversion-0.3.9.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-grdwindinversion-0.3.9.dist-info/entry_points.txt,sha256=2rjvlVCy0iasRXjOz3kOIGuy2OCGQ-VTNuwuViQ6cMM,95
-grdwindinversion-0.3.9.dist-info/top_level.txt,sha256=z6lPix3QPEYOo37qq8plA2hY7S3C8MQZY81agRlksMI,17
-grdwindinversion-0.3.9.dist-info/RECORD,,