grdwindinversion 0.3.3__py3-none-any.whl → 0.3.6__py3-none-any.whl

grdwindinversion/load_config.py

@@ -3,19 +3,22 @@ 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')
+    "~/.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')
-logging.info('config path: %s', config_path)
-stream = open(config_path, 'r')
+    config_path = os.path.join(
+        os.path.dirname(grdwindinversion.__file__), "data_config.yaml"
+    )
+stream = open(config_path, "r")
 conf = load(stream, Loader=Loader)
 
 

grdwindinversion/main.py

@@ -1,40 +1,77 @@
-from grdwindinversion.inversion import makeL2
-from grdwindinversion.utils_memory import get_memory_usage
-import grdwindinversion
 import time
 import logging
+import sys
+from importlib.metadata import version
 
 
 def processor_starting_point():
     import argparse
 
+    pre_parser = argparse.ArgumentParser(add_help=False)
+    pre_parser.add_argument(
+        "-v", "--version", action="store_true", help="Print version"
+    )
+    pre_args, remaining_args = pre_parser.parse_known_args()
+
+    # Handle the version argument right away
+    if pre_args.version:
+        print(version("grdwindinversion"))
+        sys.exit()
+
+    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(
-        description='Perform inversion from S1(L1-GRD) SAFE, L1-RCM, L1-RS2 ; using xsar/xsarsea tools')
-    parser.add_argument('--input_file', help='input file path', required=True)
-    parser.add_argument('--config_file',
-                        help='config file path [if not provided will take config file based on input file]', required=True)
-    parser.add_argument('--resolution', required=False, default='1000m',
-                        help='set resolution ["full" | "1000m" | "xXxm"]')
+        description="Perform inversion from S1(L1-GRD) SAFE, L1-RCM, L1-RS2 ; using xsar/xsarsea tools"
+    )
+    parser.add_argument("--input_file", help="input file path", required=True)
+    parser.add_argument(
+        "--config_file",
+        help="config file path [if not provided will take config file based on input file]",
+        required=True,
+    )
+    parser.add_argument(
+        "--resolution",
+        required=False,
+        default="1000m",
+        help='set resolution ["full" | "1000m" | "xXxm"]',
+    )
 
-    parser.add_argument('--outputdir', required=True)
-    parser.add_argument('--verbose', action='store_true', default=False)
-    parser.add_argument('--overwrite', action='store_true', default=False,
-                        help='overwrite existing .nc files [default is False]', required=False)
+    parser.add_argument("--outputdir", required=True)
+    parser.add_argument("--verbose", action="store_true", default=False)
+    parser.add_argument(
+        "--overwrite",
+        action="store_true",
+        default=False,
+        help="overwrite existing .nc files [default is False]",
+        required=False,
+    )
 
-    parser.add_argument('--no_generate_csv', action='store_false',
-                        help="En cas d'activation, désactive la génération du .csv")
+    parser.add_argument(
+        "--no_generate_csv",
+        action="store_false",
+        help="En cas d'activation, désactive la génération du .csv",
+    )
 
     args = parser.parse_args()
-    fmt = '%(asctime)s %(levelname)s %(filename)s(%(lineno)d) %(message)s'
+
+    fmt = "%(asctime)s %(levelname)s %(filename)s(%(lineno)d) %(message)s"
     if args.verbose:
-        logging.basicConfig(level=logging.DEBUG, format=fmt,
-                            datefmt='%d/%m/%Y %H:%M:%S', force=True)
+        logging.basicConfig(
+            level=logging.DEBUG, format=fmt, datefmt="%d/%m/%Y %H:%M:%S", force=True
+        )
     else:
-        logging.basicConfig(level=logging.INFO, format=fmt,
-                            datefmt='%d/%m/%Y %H:%M:%S', force=True)
+        logging.basicConfig(
+            level=logging.INFO, format=fmt, datefmt="%d/%m/%Y %H:%M:%S", force=True
+        )
     t0 = time.time()
-    input_file = args.input_file.rstrip('/')
-    logging.info('input file: %s', input_file)
+
+    logging.info("config path: %s", config_path)
+
+    input_file = args.input_file.rstrip("/")
+    logging.info("input file: %s", input_file)
 
     # if '1SDV' not in input_file and '_VV_VH' not in input_file:
     #     raise Exception('this processor only handle dual polarization acquisitions VV+VH for now.')
@@ -47,13 +84,19 @@ def processor_starting_point():
     if resolution == "full":
         resolution = None
 
-    out_file, outputds = makeL2(input_file, out_folder, config_file,
-                                overwrite=args.overwrite, resolution=resolution, generateCSV=args.no_generate_csv)
+    out_file, outputds = makeL2(
+        input_file,
+        out_folder,
+        config_file,
+        overwrite=args.overwrite,
+        resolution=resolution,
+        generateCSV=args.no_generate_csv,
+    )
 
-    logging.info('out_file: %s', out_file)
-    logging.info('current memory usage: %s ', get_memory_usage(var='current'))
-    logging.info('done in %1.3f min', (time.time() - t0) / 60.)
+    logging.info("out_file: %s", out_file)
+    logging.info("current memory usage: %s ", get_memory_usage(var="current"))
+    logging.info("done in %1.3f min", (time.time() - t0) / 60.0)
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     processor_starting_point()

grdwindinversion/utils.py

@@ -4,9 +4,10 @@ import logging
 import xsarsea
 
 
-logging.basicConfig(level=logging.INFO,
-                    format='%(asctime)s - %(name)s - %(levelname)s - %(message)s')
-logger = logging.getLogger('grdwindinversion')
+logging.basicConfig(
+    level=logging.INFO, format="%(asctime)s - %(name)s - %(levelname)s - %(message)s"
+)
+logger = logging.getLogger("grdwindinversion")
 
 
 mem_monitor = True
@@ -17,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.
@@ -44,17 +70,19 @@ def check_incidence_range(incidence, models, **kwargs):
     rets = []
     for model_name in models:
         lut_range = xsarsea.windspeed.get_model(model_name).inc_range
-        if 'inc_range' in kwargs:
+        if "inc_range" in kwargs:
             logging.debug(
-                f"GMF {model_name} inc_range will be changed by kwargs to {kwargs['inc_range']}")
-            lut_range = kwargs['inc_range']
+                f"GMF {model_name} inc_range will be changed by kwargs to {kwargs['inc_range']}"
+            )
+            lut_range = kwargs["inc_range"]
 
         inc_range = [incidence.min(), incidence.max()]
-        if (inc_range[0] >= lut_range[0] and inc_range[1] <= lut_range[1]):
+        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")
+                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"
+            )
             rets.append(False)
 
     return rets
@@ -76,26 +104,28 @@ def get_pol_ratio_name(model_co):
     """
 
     model = xsarsea.windspeed.get_model(model_co)
-    if model.pol == 'HH':
+    if model.pol == "HH":
         try:
             import re
 
             def check_format(s):
-                pattern = r'^([a-zA-Z0-9]+)_R(high|low)_hh_([a-zA-Z0-9_]+)$'
+                pattern = r"^([a-zA-Z0-9]+)_R(high|low)_hh_([a-zA-Z0-9_]+)$"
                 match = re.match(pattern, s)
                 if match:
                     vvgmf, res, polrationame = match.groups()
                     return polrationame
                 else:
                     logging.warn(
-                        f"String format is not correct for polarization ratio name = {s}\nReturning '/'")
+                        f"String format is not correct for polarization ratio name = {s}\nReturning '/'"
+                    )
                     return "/"
+
             get_pol_ratio_name = check_format(model_co)
             return get_pol_ratio_name
         except AttributeError:
             return "not_written_in_lut"
     else:
-        return '/'
+        return "/"
 
 
 def timing(logger=logger.debug):
@@ -104,7 +134,7 @@ def timing(logger=logger.debug):
     def decorator(f):
         # @wraps(f)
         def wrapper(*args, **kwargs):
-            mem_str = ''
+            mem_str = ""
             process = None
             if mem_monitor:
                 process = Process(os.getpid())
@@ -114,10 +144,11 @@ def timing(logger=logger.debug):
             endtime = time.time()
             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))
+                mem_str = "mem: %+.1fMb" % ((endrss - startrss) / (1024**2))
+            logger("timing %s : %.2fs. %s" % (f.__name__, endtime - starttime, mem_str))
             return result
+
         wrapper.__doc__ = f.__doc__
         return wrapper
+
     return decorator

grdwindinversion/utils_memory.py

@@ -1,46 +1,44 @@
-def get_memory_usage(unit='Go', var='ru_maxrss', force_psutil=False):
+def get_memory_usage(unit="Go", var="ru_maxrss", force_psutil=False):
     """
     var str: ru_maxrss or ru_ixrss or ru_idrss or ru_isrss or current
     Returns
     -------
 
     """
-    if unit == 'Go':
-        factor = 1000000.
-    elif unit == 'Mo':
-        factor = 1000.
-    elif unit == 'Ko':
-        factor = 1.
+    if unit == "Go":
+        factor = 1000000.0
+    elif unit == "Mo":
+        factor = 1000.0
+    elif unit == "Ko":
+        factor = 1.0
     else:
-        raise Exception('not handle unit')
+        raise Exception("not handle unit")
 
     try:
         if force_psutil:
             on_purpose_error
         import resource
+
         mems = {}
-        mems['ru_maxrss'] = resource.getrusage(
-            resource.RUSAGE_SELF).ru_maxrss / factor
-        mems['ru_ixrss'] = resource.getrusage(
-            resource.RUSAGE_SELF).ru_ixrss / factor
-        mems['ru_idrss'] = resource.getrusage(
-            resource.RUSAGE_SELF).ru_idrss / factor
-        mems['ru_isrss'] = resource.getrusage(
-            resource.RUSAGE_SELF).ru_isrss / factor
-        mems['current'] = getCurrentMemoryUsage() / factor
+        mems["ru_maxrss"] = resource.getrusage(resource.RUSAGE_SELF).ru_maxrss / factor
+        mems["ru_ixrss"] = resource.getrusage(resource.RUSAGE_SELF).ru_ixrss / factor
+        mems["ru_idrss"] = resource.getrusage(resource.RUSAGE_SELF).ru_idrss / factor
+        mems["ru_isrss"] = resource.getrusage(resource.RUSAGE_SELF).ru_isrss / factor
+        mems["current"] = getCurrentMemoryUsage() / factor
         # memory_used_go = resource.getrusage(resource.RUSAGE_SELF).get(var) /factor
         memory_used_go = mems[var]
     except:  # on windows resource is not usable
         import psutil
-        memory_used_go = psutil.virtual_memory().used / factor / 1000.
-    str_mem = 'RAM usage: %1.1f %s' % (memory_used_go, unit)
+
+        memory_used_go = psutil.virtual_memory().used / factor / 1000.0
+    str_mem = "RAM usage: %1.1f %s" % (memory_used_go, unit)
     return str_mem
 
 
 def getCurrentMemoryUsage():
-    ''' Memory usage in kB '''
+    """Memory usage in kB"""
 
-    with open('/proc/self/status') as f:
-        memusage = f.read().split('VmRSS:')[1].split('\n')[0][:-3]
+    with open("/proc/self/status") as f:
+        memusage = f.read().split("VmRSS:")[1].split("\n")[0][:-3]
 
     return int(memusage.strip())

{grdwindinversion-0.3.3.dist-info → grdwindinversion-0.3.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: grdwindinversion
-Version: 0.3.3
+Version: 0.3.6
 Summary: Package to perform Wind inversion from GRD Level-1 SAR images
 Author-email: Antoine Grouazel <antoine.grouazel@ifremer.fr>
 License: MIT
@@ -35,7 +35,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.6.dist-info/RECORD

@@ -0,0 +1,22 @@
+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/data_config.yaml,sha256=FnglUHbAtGwHWg8w86hwZt3-vo-dY8uIjxqyI1jZpv8,567
+grdwindinversion/gradientFeatures.py,sha256=NIeAJzb1zrlJPBq1th7wjEZoNJMxwqDpNHLMWP6FQN0,18198
+grdwindinversion/inversion.py,sha256=gCjuhTbLRvh_vHdx1Ut9XluuqaBPSPOgMYiGTnnrNc4,56099
+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.6.dist-info/AUTHORS.rst,sha256=KmhW_5LBKGTIGwWEVkoTm1qx_bvdDR3yYL-1cwbDOFQ,218
+grdwindinversion-0.3.6.dist-info/LICENSE,sha256=-B8mBiTeY3J7OLuayiV1myqmc7yeijBc7s34kc8RTmg,1075
+grdwindinversion-0.3.6.dist-info/METADATA,sha256=XifamxABLa3IIQ7oyioa6ozPB3qQFDXFThmKM2TPUY0,2475
+grdwindinversion-0.3.6.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
+grdwindinversion-0.3.6.dist-info/entry_points.txt,sha256=2rjvlVCy0iasRXjOz3kOIGuy2OCGQ-VTNuwuViQ6cMM,95
+grdwindinversion-0.3.6.dist-info/top_level.txt,sha256=z6lPix3QPEYOo37qq8plA2hY7S3C8MQZY81agRlksMI,17
+grdwindinversion-0.3.6.dist-info/RECORD,,

{grdwindinversion-0.3.3.dist-info → grdwindinversion-0.3.6.dist-info}/WHEEL

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

grdwindinversion-0.3.3.dist-info/RECORD

@@ -1,22 +0,0 @@
-grdwindinversion/.gitignore,sha256=vmDRHGeESYckUdUztsPr7u6ZNfBYMCVR3GE3AJCBnsY,1204
-grdwindinversion/__init__.py,sha256=VQc2V_j124NX2Gp06Go1oSZDSF4lBIVPYT-W9ZkNBXE,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/data_config.yaml,sha256=FnglUHbAtGwHWg8w86hwZt3-vo-dY8uIjxqyI1jZpv8,567
-grdwindinversion/gradientFeatures.py,sha256=pBmsk6L8V9OrfSaAlFnxWztowSMEq2uoNdK93-drCuQ,17234
-grdwindinversion/inversion.py,sha256=iqUTEFfYh_PU9AGeKs6PasDHDovsABpznruTKk9SnYM,54437
-grdwindinversion/load_config.py,sha256=o0zVRpw3cIk-0fAsgOAb5JYzbHd3wdKmFskT8B3FAok,875
-grdwindinversion/main.py,sha256=0DLDW0i14CWhDKAGegzOKlWnCkag_cGn3vzMIAKcv4g,2658
-grdwindinversion/utils.py,sha256=bowCr2wKqXE7j0Uo5xkFMjWkr7NhnmjCaPFTO4MYNV4,3803
-grdwindinversion/utils_memory.py,sha256=1N3Kh4qVZPELPU6I4onbmkur1CZd7EHZqfbSAa6eaVc,1480
-grdwindinversion/.github/ISSUE_TEMPLATE.md,sha256=qiM_a7CCUz3fSrz3Q20Se1nwPNFS8QCc8tkwK_0DSCo,327
-grdwindinversion-0.3.3.dist-info/AUTHORS.rst,sha256=KmhW_5LBKGTIGwWEVkoTm1qx_bvdDR3yYL-1cwbDOFQ,218
-grdwindinversion-0.3.3.dist-info/LICENSE,sha256=-B8mBiTeY3J7OLuayiV1myqmc7yeijBc7s34kc8RTmg,1075
-grdwindinversion-0.3.3.dist-info/METADATA,sha256=smWjGdzzyLLXJa8Ugz0xfAoI6udjTpy3VDLvZnSXiJ4,2441
-grdwindinversion-0.3.3.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-grdwindinversion-0.3.3.dist-info/entry_points.txt,sha256=2rjvlVCy0iasRXjOz3kOIGuy2OCGQ-VTNuwuViQ6cMM,95
-grdwindinversion-0.3.3.dist-info/top_level.txt,sha256=z6lPix3QPEYOo37qq8plA2hY7S3C8MQZY81agRlksMI,17
-grdwindinversion-0.3.3.dist-info/RECORD,,