wavyopen 0.3.5__tar.gz → 0.3.8__tar.gz

{wavyopen-0.3.5 → wavyopen-0.3.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wavyopen
-Version: 0.3.5
+Version: 0.3.8
 Summary: A package for processing/calibrating/validating wave measurements and wave model output.
 Author-email: Patrik Bohlinger <patrikb@met.no>
 License-Expression: MIT

wavyopen-0.3.8/docs/vietnam25.rst

@@ -0,0 +1,179 @@
+Vietnam Validation Workshop 2025
+================================
+
+The following examples are tailored to the **wavy** Vietnam Validation Workshop 2025.
+
+0. Installation of wavyopen and preparation
+###########################################
+**wavyopen** is wavy's pip and conda package which can easily be installed with pip, conda, or mamba. In this workshop we will install the conda package in a fresh conda environment like:
+
+.. code::
+
+   conda create --name wavyopen --channel=conda-forge
+   conda activate wavyopen
+   conda install wavyopen
+
+Assuming you have mamba installed you can, instead of conda, use mamba as an inplace replacement like:
+
+.. code::
+
+   mamba create --name wavyopen --channel=conda-forge
+   mamba activate wavyopen
+   mamba install wavyopen
+
+When activated, you can use wavyopen in any directory of your computer.
+
+Since you probably have multiple, independent projects at the same time it may make sense to follow a general workflow of creating a project directory, specifying your environment variables, preparing config files, creating scripts. Let's go through each of these steps together:
+
+#. Create a project directory:
+
+   .. code::
+   
+      mkdir ~/wavyopen_vietnam25
+      mkdir ~/wavyopen_vietnam25/config
+      mkdir ~/wavyopen_vietnam25/scripts
+      mkdir ~/wavyopen_vietnam25/data
+
+
+#. Specify enfironmental variables
+
+   .. code::
+
+      cd ~/wavyopen_vietnam25
+      touch .env
+
+   Specify now where you will have your **wavy** config files in the .env-file.
+
+   .. code::
+
+      WAVY_CONFIG=~/wavyopen_vitenam25/config/
+
+   Also, if you would like to download data you need to have you copernicus marine credentials stored in the environment. This can be done anywhere (.bashrc, .profilerc, any shell wrapper script, manually, ...) and it could also be done in the .env file which we will do for this workshop.
+
+   .. code::
+
+      COPERNICUSMARINE_SERVICE_USERNAME=
+      COPERNICUSMARINE_SERVICE_PASSWORD=
+
+#. Preparing your config files:
+   The config files can be established following some prepared **wavy** examples which you can obtain using the wavyCFG script like:
+
+   .. code::
+
+      cd ~/wavyopen_vitenam25/config
+      wavyCFG --help
+      wavyCFG --path ./. --f satellite_cfg.yaml --t minimal
+      wavyCFG --path ./. --f model_cfg.yaml --t minimal
+      wavyCFG --path ./. --f region_cfg.yaml --t default
+
+#. Adjustments and further preparations are done in the subsequent sections.
+
+
+1. Downloading data satellite data
+##################################
+First we need to adjust the satellite_cfg.yaml file for your purpose. Please open the satellite_cfg.yaml file and ammend it. Specifically, the target template for the downloads (trgt_tmplt) and the source template for files that wavy should use (src_tmplt) need to be defined. I am choosing here:
+
+.. code::
+
+   trgt_tmplt: ~/wavyopen_vitenam25/data/name/%Y/%m/
+   src_tmplt: ~/wavyopen_vitenam25/data/name/%Y/%m/
+
+Now you can use the wavyDownload script to download data from the copernicus marine service.
+
+.. code::
+
+   wavyDownload --help
+   wavyDownload --sd 2025-05-01 --ed 2025-05-10 --nID cmems_L3_NRT --name s3a
+
+You can repeat this for all the other satellites as well (s3a, c2, j3, h2b, al, cfo, s6a, swon).
+
+
+2. Process satellite data
+#########################
+Now, you can start preparing python scripts reading, processing, and plotting your data. This may look like:
+
+.. code-block:: python3
+
+   from wavy import sc, gc, ms
+   from wavy.grid_stats import apply_metric
+
+   # satellite data from directory
+   sco = sc(nID='cmems_L3_NRT',
+            name='s3a',
+            sd='2025-05-01', ed='2025-05-10',
+            region="NorthSea").populate()
+   sco.quicklook(a=True)
+
+   # satellite data from multiple sources
+   mso = ms(nID=['cmems_L3_NRT'],
+            name=['s3a', 's3b', 'c2', 'cfo', 'h2b', 'j3', 'al', 's6a','swon'],
+            sd='2025-01-01', ed='2025-01-10',
+            region='NorthSea')
+   mso.quicklook(a=True, mode='indiv')
+
+   # grid satellite data
+   bb = (-5, 12, 50, 62)  # lonmin,lonmax,latmin,latmax
+   res = (1, 1)  # lon/lat
+   gco = gc(oco=mso, bb=bb, res=res)
+   gridvar, lon_grid, lat_grid = apply_metric(gco=gco)
+   gco.quicklook(val_grid=gridvar, lon_grid=lon_grid, lat_grid=lat_grid,
+                 title="", metric='mor', land_mask_resolution='i')
+
+
+Now, introduce your custom region in region_cfg.yaml and rerun the script by replacing "NorthSea".
+
+
+3. Add custom model to wavy
+###########################
+Add the ecwam model to the model_specs.yaml file (if it is not added already). For instance you can add your ecwam model like:
+
+.. code-block:: yaml
+
+   ecwam_vietnam:
+       name:
+       vardef:
+           Hs: sea_surface_wave_significant_height
+           time: time
+           lons: longitude
+           lats: latitude
+       coords:
+       wavy_input:
+           src_tmplt: "/home/patrikb/wavyopen_vietnam25/data/"
+           fl_tmplt: "vietnam_wave_%Y%m%d_%H.nc"
+       reader: read_ecwam
+       collector:
+       misc:
+           init_times: [0,12]
+           init_step: 12
+           grid_date: 2021-11-26 00:00:00
+           date_incr_unit: h
+           date_incr: 3
+
+   swan_vietnam:
+       name:
+       vardef:
+           Hs: hs
+           time: time
+           lons: longitude
+           lats: latitude
+       coords:
+       wavy_input:
+           src_tmplt: "/home/patrikb/wavyopen_vietnam25/data/"
+           fl_tmplt: "SWAN%Y%m%d%H.nc"
+       reader: read_ww3
+       collector:
+       misc:
+           init_times: [0,12]
+           init_step: 12
+           grid_date: 2021-11-26 00:00:00
+           date_incr_unit: h
+           date_incr: 3
+
+
+
+4. Collocate satellite with model
+#################################
+
+
+5. Validate with model against satellite observations
+#####################################################

{wavyopen-0.3.5 → wavyopen-0.3.8}/docs/workshops.rst

@@ -14,5 +14,6 @@ Workshops and show cases
    vietnam21
    vietnam22
    vietnam22_2
+   vietnam25
    mozambique23
    mozambique24

{wavyopen-0.3.5 → wavyopen-0.3.8}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "wavyopen"
 requires-python = ">=3.10"
-version = "0.3.5"
+version = "0.3.8"
 description = "A package for processing/calibrating/validating wave measurements and wave model output."
 license = "MIT"
 license-files = ["LICENSE"]

{wavyopen-0.3.5 → wavyopen-0.3.8}/wavy/apps/wavyCFG.py

@@ -12,8 +12,6 @@ from wavy.wconfig import load_or_default, load_minimal
         help='target path')
 @click.option('--t', type=str, default='default',
         help='type (default or minimal)')
-@click.option('--c', type=str, default='default',
-        help='clean')
 def main(f, path, t):
     if path is None:
         path = os.getcwd() 

{wavyopen-0.3.5 → wavyopen-0.3.8}/wavy/apps/wavyDownload.py

@@ -24,8 +24,7 @@ from wavy.wconfig import load_or_default
 @click.option('--nID', type=str, default='cmems_L3_NRT',
         help='nID as specified in satellite_cfg.yaml')
 @click.option('--name', type=str, default=None,
-        help='name as specified in satellite_cfg.yaml,\
-        if name equals "all", all names from chosen nID are considered')
+        help='name as specified in satellite_cfg.yaml, if name equals "all", all names from chosen nID are considered')
 @click.option('--nproc', type=int, default=None,
         help='chosen number of simultaneous processes')
 @click.option('--path', type=str, default=None)
@@ -50,23 +49,6 @@ def main(sd, ed, nid, name, path, nproc):
             \n s6a - Sentinel-6A Michael Freilich\n
             \n swon - SWOT nadir altimeter\n
             \n
-    The following most common missions are available from CCIv1:
-            \n
-            \ncci_L2P:\n
-            \n j1 - Jason-1\n
-            \n j2 - Jason-2\n
-            \n j3 - Jason-3\n
-            \n c2 - Cryosat-2\n
-            \n envisat - Envisat\n
-            \n ers1 - European Remote-Sensing Satellite-1\n
-            \n ers2 - European Remote-Sensing Satellite-2\n
-            \n topex - TOPEX/Poseidon\n
-            \n al - SARAL/AltiKa\n
-            \n gfo - GEOSAT Follow-On\n
-            \n
-            \ncci_L3:\n
-            \n multi - multimission product 1991-2018\n
-            \n\
 
     Note that these examples are not exclusive,\n
     almost any other source could be added and exploited.

{wavyopen-0.3.5 → wavyopen-0.3.8}/wavy/config/region_cfg.yaml.default

@@ -7,41 +7,11 @@ rect:
         llcrnrlat: -90.
         urcrnrlon: 180.
         urcrnrlat: 90.
-    Moskenes:
-        llcrnrlon: 11.5
-        llcrnrlat: 67.
-        urcrnrlon: 14.
-        urcrnrlat: 68.5
     Sulafj:
         llcrnrlon: 5.
         llcrnrlat: 62.
         urcrnrlon: 8.14
         urcrnrlat: 63.15
-    SulafjD:
-        llcrnrlon: 5.968
-        llcrnrlat: 62.4
-        urcrnrlon: 6.078
-        urcrnrlat: 62.5
-    Fedje:
-        llcrnrlon: 4
-        llcrnrlat: 60.2
-        urcrnrlon: 5.3
-        urcrnrlat: 61.7
-    Valhall:
-        llcrnrlon: 2.5
-        llcrnrlat: 55
-        urcrnrlon: 4.5
-        urcrnrlat: 58
-    fedjeosen:
-        llcrnrlon: 4.4
-        llcrnrlat: 60.6
-        urcrnrlon: 4.8
-        urcrnrlat: 60.9
-    OO:
-        llcrnrlon: 10
-        llcrnrlat: -45 # 45S
-        urcrnrlon: 45
-        urcrnrlat: -25 # 25S
        
 # polynomial
 poly:

{wavyopen-0.3.5 → wavyopen-0.3.8}/wavy/config/satellite_cfg.yaml.minimal

@@ -11,22 +11,31 @@
 cmems_L3_NRT:
     name:
         s3a: s3a
+        s3b: s3b
+        c2: c2
+        j3: j3
+        h2b: h2b
+        al: al
+        cfo: cfo
+        s6a: s6a
+        swon: swon
     download:
         copernicus:
             dataset_id: cmems_obs-wave_glo_phy-swh_nrt_name-l3_PT1S
             trgt_tmplt:
             path_date_incr_unit: 'm'
             path_date_incr: 1
-            strsub:
+            strsub: ["name"]
             server: "nrt.cmems-du.eu"
             time_incr: 'h'
     wavy_input:
         src_tmplt:
         fl_tmplt:
-        strsub:
+        strsub: ["name"]
         path_date_incr_unit: 'm'
         path_date_incr: 1
     reader: read_local_ncfiles
     collector: get_remote_files_copernicusmarine
     vardef:
         Hs: VAVH
+        U: WIND_SPEED

{wavyopen-0.3.5 → wavyopen-0.3.8}/wavy/satellite_collectors.py

@@ -189,7 +189,6 @@ def get_remote_files_copernicusmarine(**kwargs):
     product = kwargs.get('nID')
     sdate = kwargs.get('sd')
     edate = kwargs.get('ed')
-    nproc = kwargs.get('nproc', 1)
     name = kwargs.get('name', 's3a')
 
     # if CMEMS credentials are defined in environment other options 
@@ -197,16 +196,14 @@ def get_remote_files_copernicusmarine(**kwargs):
     if 'COPERNICUSMARINE_SERVICE_USERNAME' in os.environ:
         username = os.getenv('COPERNICUSMARINE_SERVICE_USERNAME')
     else:
-        username = None
+        username = kwargs.get('COPERNICUSMARINE_SERVICE_USERNAME')
     if 'COPERNICUSMARINE_SERVICE_PASSWORD' in os.environ:
         password = os.getenv('COPERNICUSMARINE_SERVICE_PASSWORD')
     else:
-        password = None
+        password = kwargs.get('COPERNICUSMARINE_SERVICE_PASSWORD')
 
-    if (username is not None and password is not None):
-        no_metadata_cache = True
-    else:
-        no_metadata_cache = False
+    if (username is None or password is None):
+        print('--> Please provide complete credentials!')
 
     dict_for_sub = kwargs
 
@@ -215,14 +212,14 @@ def get_remote_files_copernicusmarine(**kwargs):
 
     # Get time increment
     time_incr = satellite_dict[product]['download']['copernicus']\
-                .get('time_incr','h')
+                .get('time_incr', 'h')
     
     # Chose search template for time given time_incr
-    if time_incr=='h':
+    if time_incr == 'h':
         file_search_template = '%Y%m%dT%H'
-    elif time_incr=='d':
+    elif time_incr == 'd':
         file_search_template = '%Y%m%dT'
-    elif time_incr=='m':
+    elif time_incr == 'm':
         file_search_template = '%Y%m'
     print('Date search format:', file_search_template)
 
@@ -277,11 +274,11 @@ def get_remote_files_copernicusmarine(**kwargs):
             # check if download path_local exists if not create
             if not os.path.exists(path_local):
                 os.makedirs(path_local, exist_ok=True)
-    
+
             # Create regexp filter
             tmpdate_str = tmpdate.strftime(file_search_template)
             regexp_tmp = "*{}*_*_*.nc".format(tmpdate_str)
-            # Fetch data corresponding to tmp date 
+            # Fetch data corresponding to tmp date
             try:
                 cmc.get(
                     dataset_id=dataset_id,

{wavyopen-0.3.5 → wavyopen-0.3.8}/wavyopen.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wavyopen
-Version: 0.3.5
+Version: 0.3.8
 Summary: A package for processing/calibrating/validating wave measurements and wave model output.
 Author-email: Patrik Bohlinger <patrikb@met.no>
 License-Expression: MIT

{wavyopen-0.3.5 → wavyopen-0.3.8}/wavyopen.egg-info/SOURCES.txt

@@ -91,6 +91,7 @@ docs/tutorials_wavyQuick.rst
 docs/vietnam21.rst
 docs/vietnam22.rst
 docs/vietnam22_2.rst
+docs/vietnam25.rst
 docs/vietnam_coll_2022_2_map.png
 docs/vietnam_coll_2022_2_sc.png
 docs/vietnam_coll_2022_2_ts.png