grdwindinversion 0.2.3.post15__py3-none-any.whl

grdwindinversion/load_config.py

@@ -0,0 +1,24 @@
+from yaml import load
+import logging
+import os
+import grdwindinversion
+from yaml import CLoader as Loader
+local_config_potential_path = os.path.expanduser(
+    '~/.grdwindinversion/data_config.yaml')
+
+if os.path.exists(local_config_potential_path):
+    config_path = local_config_potential_path
+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')
+conf = load(stream, Loader=Loader)
+
+
+def getConf():
+    """
+    if local_config_potential_path exists it will superseed config_path
+    :return:
+    """
+    return conf

grdwindinversion/main.py

@@ -0,0 +1,59 @@
+from grdwindinversion.inversion import makeL2
+from grdwindinversion.utils import get_memory_usage
+import grdwindinversion
+import time
+import logging
+
+
+def processor_starting_point():
+    import argparse
+
+    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"]')
+
+    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")
+
+    args = parser.parse_args()
+    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)
+    else:
+        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)
+
+    # 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.')
+    # if '1SSH' in input_file or '1SDH' in input_file or '_HH_HV' in input_file:
+    #     raise Exception('this processor only handle acquisitions with VV or VV+VH polarization for now.')
+
+    config_file = args.config_file
+    out_folder = args.outputdir
+    resolution = args.resolution
+    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)
+
+    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.)
+
+
+if __name__ == '__main__':
+    processor_starting_point()

grdwindinversion/streaks.py

@@ -0,0 +1,79 @@
+import xarray as xr
+import xsarsea.gradients
+import xarray as xr
+from scipy.ndimage import binary_dilation
+import numpy as np
+
+
+def get_streaks(xr_dataset, xr_dataset_100):
+    """
+    Get the streaks from the wind field.
+
+    Parameters
+    ----------
+    xr_dataset : xarray.Dataset
+        dataset at user resolution.
+    xr_dataset_100 : xarray.Dataset
+        dataset at 100m resolution.
+
+    Returns
+    -------
+    xarray.Dataset
+        Extract wind direction from Koch Method using xsarsea tools.
+    """
+
+    # return empy dataArray, waiting for solution
+    return xr.DataArray(data=np.nan * np.ones([len(xr_dataset.coords[dim]) for dim in ['line','sample']]),
+                        dims=['line','sample'],
+                        coords=[xr_dataset.coords[dim] for dim in ['line','sample']])
+    #
+
+    """
+    gradients = xsarsea.gradients.Gradients(xr_dataset_100['sigma0_detrend'], windows_sizes=[
+                                            1600, 3200], downscales_factors=[1, 2], window_step=1)
+
+    # get gradients histograms as an xarray dataset
+    hist = gradients.histogram
+
+    # get orthogonals gradients
+    hist['angles'] = hist['angles'] + np.pi/2
+
+    # mean
+    hist_mean = hist.mean(['downscale_factor', 'window_size', 'pol'])
+
+    # smooth
+    hist_mean_smooth = hist_mean.copy()
+    hist_mean_smooth['weight'] = xsarsea.gradients.circ_smooth(
+        hist_mean['weight'])
+
+    # smooth only
+    # hist_smooth = hist.copy()
+    # hist_smooth['weight'] = xsarsea.gradients.circ_smooth(hist_smooth['weight'])
+
+    # select histogram peak
+    iangle = hist_mean_smooth['weight'].fillna(0).argmax(dim='angles')
+    streaks_dir = hist_mean_smooth.angles.isel(angles=iangle)
+    streaks_weight = hist_mean_smooth['weight'].isel(angles=iangle)
+    streaks = xr.merge(
+        [dict(angle=streaks_dir, weight=streaks_weight)]).drop('angles')
+
+    # streaks are [0, pi]. Remove ambiguity with anciallary wind
+    ancillary_wind = xr_dataset_100['ancillary_wind'].sel(line=streaks.line,
+                                                          sample=streaks.sample,
+                                                          method='nearest').compute()
+    streaks_c = streaks['weight'] * np.exp(1j * streaks['angle'])
+    diff_angle = xr.apply_ufunc(np.angle, ancillary_wind / streaks_c)
+    streaks_c = xr.where(np.abs(diff_angle) > np.pi/2, -streaks_c, streaks_c)
+    streaks['weight'] = np.abs(streaks_c)
+    streaks['angle'] = xr.apply_ufunc(np.angle, streaks_c)
+
+    streaks_dir = xr.apply_ufunc(
+        np.angle, streaks_c.interp(line=xr_dataset.line, sample=xr_dataset.sample))
+    streaks_dir = xr.where(
+        xr_dataset['land_mask'], np.nan, streaks_dir)
+    streaks_dir.attrs['comment'] = 'angle in radians, anticlockwise, 0=line'
+    streaks_dir.attrs['description'] = 'wind direction estimated from local gradient, and direction ambiguity removed with ancillary wind'
+    
+    return streaks_dir
+    
+    """

grdwindinversion/utils.py

@@ -0,0 +1,42 @@
+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.
+    else:
+        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
+        # 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)
+    return str_mem
+
+
+def getCurrentMemoryUsage():
+    ''' Memory usage in kB '''
+
+    with open('/proc/self/status') as f:
+        memusage = f.read().split('VmRSS:')[1].split('\n')[0][:-3]
+
+    return int(memusage.strip())

grdwindinversion-0.2.3.post15.dist-info/AUTHORS.rst

@@ -0,0 +1,14 @@
+=======
+Authors
+=======
+
+Development Lead
+----------------
+
+* Vincent Lheureux <vincent.lheureux@ifremer.fr>
+* Antoine Grouazel <antoine.grouazel@ifremer.fr>
+
+Contributors
+------------
+
+None yet. Why not be the first?

grdwindinversion-0.2.3.post15.dist-info/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2023, Antoine Grouazel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

grdwindinversion-0.2.3.post15.dist-info/METADATA

@@ -0,0 +1,80 @@
+Metadata-Version: 2.1
+Name: grdwindinversion
+Version: 0.2.3.post15
+Summary: Package to perform Wind inversion from GRD Level-1 SAR images
+License: MIT
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: AUTHORS.rst
+Requires-Dist: xsar
+Requires-Dist: xsarsea
+Requires-Dist: xarray
+Requires-Dist: xarray-datatree
+Requires-Dist: pyyaml
+Requires-Dist: numpy
+Requires-Dist: scipy
+Requires-Dist: fsspec
+Requires-Dist: aiohttp
+
+
+# grdwindinversion
+
+
+
+[![Python Version](https://img.shields.io/pypi/pyversions/grdwindinversion.svg)](https://pypi.org/project/grdwindinversion/)
+[![Dependencies Status](https://img.shields.io/badge/dependencies-up%20to%20date-brightgreen.svg)](https://github.com/umr-lops/grdwindinversion/pulls?utf8=%E2%9C%93&q=is%3Apr%20author%3Aapp%2Fdependabot)
+
+
+
+
+
+Package to perform Wind inversion from GRD Level-1 SAR images
+
+
+* Free software: MIT license
+* Documentation: https://grdwindinversion.readthedocs.io.
+
+
+## Usage
+
+
+ ```python
+
+    SAR_L1-to-L2_wind_processor -h
+    usage: SAR_L1-to-L2_wind_processor [-h] --input_file INPUT_FILE [--config_file CONFIG_FILE] --outputdir OUTPUTDIR [--verbose] [--overwrite]
+
+    Perform inversion from S1(L1-GRD) SAFE, L1-RCM, L1-RS2 ; using xsar/xsarsea tools
+
+    options:
+      -h, --help            show this help message and exit
+      --input_file INPUT_FILE
+                            input file path
+      --config_file CONFIG_FILE
+                            config file path [if not provided will take config file based on input file]
+      --outputdir OUTPUTDIR
+      --verbose
+      --overwrite           overwrite existing .nc files [default is False]
+```
+
+
+## Features
+
+This Python library (based on `xarray`) allows to perform wind inversion from level-1 GRD (projected magnitude image).
+Mission supported:
+ * Sentinel-1
+ * RCM
+ * RadarSat-2
+
+

grdwindinversion-0.2.3.post15.dist-info/RECORD

@@ -0,0 +1,19 @@
+grdwindinversion/.gitignore,sha256=vmDRHGeESYckUdUztsPr7u6ZNfBYMCVR3GE3AJCBnsY,1204
+grdwindinversion/.travis.yml,sha256=q13Gro7mMK7xN5eDEhyMIgcXIYsgSQfAEzk4dv34ie0,694
+grdwindinversion/__init__.py,sha256=VQc2V_j124NX2Gp06Go1oSZDSF4lBIVPYT-W9ZkNBXE,415
+grdwindinversion/config_prod.yaml,sha256=tIWn83LXNIl9l6w2I4TU-ZIk35EZm44GeIXklgYqFw8,1010
+grdwindinversion/config_prod_recal.yaml,sha256=WzucOsKVCK-lw5kRn-4llONwBxl8TogYrReeLycXC6k,1006
+grdwindinversion/data_config.yaml,sha256=YbbgxqpgasR5RINO29Ep_1cELdZotoylLzn6Qh7f6LM,473
+grdwindinversion/inversion.py,sha256=WoMgi4gRjMU11FHhb0xlZS_Hl7KKY5W_gbvI86cGNh8,43984
+grdwindinversion/load_config.py,sha256=bt7EXTmXfbuK0oNR-qwtijv_iZBQzi5BtY92RGKEo4Y,651
+grdwindinversion/main.py,sha256=l5PEyIkqQ7Vjha0zs9FO3uqTpCVdNdoen5Zu8svJH8g,2651
+grdwindinversion/streaks.py,sha256=SucALdajwAr-tcqwJs6KOj8CQ7qQPp3JUKSh2dHAJTY,2950
+grdwindinversion/utils.py,sha256=nIao7g_lGKgzL5y_ipBsxLoQDetf0OLrPy8FEd4eyWU,1428
+grdwindinversion/.github/ISSUE_TEMPLATE.md,sha256=qiM_a7CCUz3fSrz3Q20Se1nwPNFS8QCc8tkwK_0DSCo,327
+grdwindinversion-0.2.3.post15.dist-info/AUTHORS.rst,sha256=KmhW_5LBKGTIGwWEVkoTm1qx_bvdDR3yYL-1cwbDOFQ,218
+grdwindinversion-0.2.3.post15.dist-info/LICENSE,sha256=-B8mBiTeY3J7OLuayiV1myqmc7yeijBc7s34kc8RTmg,1075
+grdwindinversion-0.2.3.post15.dist-info/METADATA,sha256=-EzqUV0fqvzAXgjgZYEKC5cloJCV0Dh9vahVZINXMbI,2399
+grdwindinversion-0.2.3.post15.dist-info/WHEEL,sha256=cVxcB9AmuTcXqmwrtPhNK88dr7IR_b6qagTj0UvIEbY,91
+grdwindinversion-0.2.3.post15.dist-info/entry_points.txt,sha256=2rjvlVCy0iasRXjOz3kOIGuy2OCGQ-VTNuwuViQ6cMM,95
+grdwindinversion-0.2.3.post15.dist-info/top_level.txt,sha256=z6lPix3QPEYOo37qq8plA2hY7S3C8MQZY81agRlksMI,17
+grdwindinversion-0.2.3.post15.dist-info/RECORD,,

grdwindinversion-0.2.3.post15.dist-info/WHEEL

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

grdwindinversion-0.2.3.post15.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+SAR_L1-to-L2_wind_processor = grdwindinversion.main:processor_starting_point

grdwindinversion-0.2.3.post15.dist-info/top_level.txt

@@ -0,0 +1 @@
+grdwindinversion