wavyopen 0.3.8__tar.gz → 0.4.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wavyopen
-Version: 0.3.8
+Version: 0.4.0
 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 → wavyopen-0.4.0}/docs/vietnam25.rst

@@ -11,7 +11,7 @@ The following examples are tailored to the **wavy** Vietnam Validation Workshop
 
    conda create --name wavyopen --channel=conda-forge
    conda activate wavyopen
-   conda install wavyopen
+   conda install wavyopen -c conda-forge
 
 Assuming you have mamba installed you can, instead of conda, use mamba as an inplace replacement like:
 
@@ -30,9 +30,9 @@ Since you probably have multiple, independent projects at the same time it may m
    .. code::
    
       mkdir ~/wavyopen_vietnam25
-      mkdir ~/wavyopen_vietnam25/config
-      mkdir ~/wavyopen_vietnam25/scripts
-      mkdir ~/wavyopen_vietnam25/data
+      mkdir -p ~/wavyopen_vietnam25/config
+      mkdir -p ~/wavyopen_vietnam25/scripts
+      mkdir -p ~/wavyopen_vietnam25/data
 
 
 #. Specify enfironmental variables
@@ -46,7 +46,7 @@ Since you probably have multiple, independent projects at the same time it may m
 
    .. code::
 
-      WAVY_CONFIG=~/wavyopen_vitenam25/config/
+      WAVY_CONFIG=~/wavyopen_vietnam25/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.
 
@@ -60,7 +60,7 @@ Since you probably have multiple, independent projects at the same time it may m
 
    .. code::
 
-      cd ~/wavyopen_vitenam25/config
+      cd ~/wavyopen_vietnam25/config
       wavyCFG --help
       wavyCFG --path ./. --f satellite_cfg.yaml --t minimal
       wavyCFG --path ./. --f model_cfg.yaml --t minimal
@@ -75,17 +75,20 @@ First we need to adjust the satellite_cfg.yaml file for your purpose. Please ope
 
 .. code::
 
-   trgt_tmplt: ~/wavyopen_vitenam25/data/name/%Y/%m/
-   src_tmplt: ~/wavyopen_vitenam25/data/name/%Y/%m/
+   trgt_tmplt: ~/wavyopen_vietnam25/data/name/%Y/%m/
+   src_tmplt: ~/wavyopen_vietnam25/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
+   wavyDownload --sd 2025-05-01 --ed 2025-05-03 --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).
+You can repeat this for all the other satellites as well (s3a, c2, j3, h2b, al, cfo, s6a, swon). If you like to retrieve all satellite missions in the list **name** then you can replace the name of the satellite with **all** like:
+
+.. code::
+   wavyDownload --sd 2025-05-01 --ed 2025-05-03 --nID cmems_L3_NRT --name all
 
 
 2. Process satellite data
@@ -100,14 +103,14 @@ Now, you can start preparing python scripts reading, processing, and plotting yo
    # satellite data from directory
    sco = sc(nID='cmems_L3_NRT',
             name='s3a',
-            sd='2025-05-01', ed='2025-05-10',
+            sd='2025-05-01', ed='2025-05-03',
             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',
+            name=['s3a', 's3b', 'c2', 'cfo', 'h2b', 'j3', 'al', 's6a', 'swon'],
+            sd='2025-05-01', ed='2025-05-03',
             region='NorthSea')
    mso.quicklook(a=True, mode='indiv')
 
@@ -120,12 +123,12 @@ Now, you can start preparing python scripts reading, processing, and plotting yo
                  title="", metric='mor', land_mask_resolution='i')
 
 
-Now, introduce your custom region in region_cfg.yaml and rerun the script by replacing "NorthSea".
+Now, introduce your custom region in region_cfg.yaml and rerun the script by replacing "NorthSea" with what you defined.
 
 
 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:
+Add the vietnam relevant model output files to the model_specs.yaml file. For instance you can add your ecwam model like:
 
 .. code-block:: yaml
 
@@ -138,7 +141,7 @@ Add the ecwam model to the model_specs.yaml file (if it is not added already). F
            lats: latitude
        coords:
        wavy_input:
-           src_tmplt: "/home/patrikb/wavyopen_vietnam25/data/"
+           src_tmplt: "/home/patrikb/wavyopen_vietnam25/data/ecwam_vietnam/"
            fl_tmplt: "vietnam_wave_%Y%m%d_%H.nc"
        reader: read_ecwam
        collector:
@@ -158,9 +161,9 @@ Add the ecwam model to the model_specs.yaml file (if it is not added already). F
            lats: latitude
        coords:
        wavy_input:
-           src_tmplt: "/home/patrikb/wavyopen_vietnam25/data/"
+           src_tmplt: "/home/patrikb/wavyopen_vietnam25/data/swan_vietnam/"
            fl_tmplt: "SWAN%Y%m%d%H.nc"
-       reader: read_ww3
+       reader: read_era
        collector:
        misc:
            init_times: [0,12]
@@ -169,11 +172,46 @@ Add the ecwam model to the model_specs.yaml file (if it is not added already). F
            date_incr_unit: h
            date_incr: 3
 
+Check if your model data is readable by wavy with:
+
+.. code-block:: python3
+
+    from wavy import mc
+
+    mco1 = mc(nID='ecwam_vietnam', sd='2021-11-26').populate()
+    mco1.quicklook(m=True)
+
+    mco2 = mc(nID='swan_vietnam', sd='2021-11-26').populate()
+    mco2.quicklook(m=True)
 
 
 4. Collocate satellite with model
 #################################
 
+Access to model and observations enables you to validate the model against the observations. This can be done using the collocation module like:
+
+.. code-block:: python3
+
+    from wavy import cc, ms
+
+    mso = ms(nID=['cmems_L3_NRT'],
+             name=['s3a', 's3b', 'c2', 'cfo', 'h2b', 'j3', 'al', 's6a', 'swon'],
+             sd='2025-05-01', ed='2025-05-03',
+             region='NorthSea')
+
+    cco = cc(model='ww3_4km', oco=mso, leadtime='best').populate()
+
+    cco.quicklook(ts=True, m=True, sc=True, hist=True,
+                  std_regression_line=True,
+                  std_regression_col='b',
+                  std_regression_lw=1)
+
 
 5. Validate with model against satellite observations
 #####################################################
+
+Validation is quick and easy. Using the collocation class object **cco** you do:
+
+.. code-block:: python3
+
+   cco.validate_collocated_values()

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

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

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

@@ -7,17 +7,16 @@ from wavy.wconfig import load_or_default, load_minimal
 
 @click.command(context_settings={"ignore_unknown_options": True})
 @click.option('--f', type=str, default=None,
-        help='name of config default file')
+              help='name of config default file')
 @click.option('--path', type=str, default=None,
-        help='target path')
+              help='target path')
 @click.option('--t', type=str, default='default',
-        help='type (default or minimal)')
+              help='type (default or minimal)')
 def main(f, path, t):
     if path is None:
         path = os.getcwd() 
         print(path)
     fstr = os.path.join(path, f)
-    print(fstr)
     if t == 'minimal':
         default_cfg = load_minimal(f)
     elif t == 'default':
@@ -31,4 +30,3 @@ def main(f, path, t):
 
 if __name__ == "__main__":
     main()
-

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

@@ -14,8 +14,6 @@ from pathlib import Path
 from wavy.wconfig import load_or_default
 # -------------------------------------------------------------------- #
 
-# make sure that if name is name="all" then download all names for given nID
-
 @click.command(context_settings={"ignore_unknown_options": True})
 @click.option('--sd', type=str, default=None,
         help='starting date and time of your query e.g.: 2023-10-1T00')
@@ -29,15 +27,12 @@ from wavy.wconfig import load_or_default
         help='chosen number of simultaneous processes')
 @click.option('--path', type=str, default=None)
 
-#@click.option('--search_str', type=str,
-#       help='identifyer string to search for in remote directory')
- 
 def main(sd, ed, nid, name, path, nproc):
     """
     Wrapper for command line use of the wavy downloading functions.\n
 
     Here are some examples of supported files...
-    The following most common missions are available from the CMEMS webpage:
+    The following most common missions are available from the CMEMS webpage.\n
             \ncmems_L3_NRT:\n
             \n s3a - Sentinel-3A\n
             \n s3b - Sentinel-3B\n

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

@@ -39,3 +39,8 @@ cmems_L3_NRT:
     vardef:
         Hs: VAVH
         U: WIND_SPEED
+    coords:
+    misc:
+        processing_level:
+        provider:
+        obs_type:

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

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