wavyopen 0.3.8__tar.gz → 0.3.9__tar.gz

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

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

@@ -85,7 +85,10 @@ Now you can use the wavyDownload script to download data from the copernicus mar
    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).
+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-10 --nID cmems_L3_NRT --name all
 
 
 2. Process satellite data
@@ -106,8 +109,8 @@ Now, you can start preparing python scripts reading, processing, and plotting yo
 
    # 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-10',
             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,7 +161,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/swan_vietnam/"
            fl_tmplt: "SWAN%Y%m%d%H.nc"
        reader: read_ww3
        collector:
@@ -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').populate()
+    mco1.quicklook(m=True)
+
+    mco2 = mc(nID='swan_vietnam').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.3.9}/pyproject.toml

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

{wavyopen-0.3.8 → wavyopen-0.3.9}/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.3.9}/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.3.9}/wavyopen.egg-info/PKG-INFO

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