Merge branch 'main' into components

Author: rafa-guedes

.github/workflows/sphinx_docs_to_gh_pages.yaml

@@ -3,20 +3,21 @@ name: Build Sphinx Docs
 on:
   push:
     branches:
-      - docs
+      - main
 
 jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - name: Checkout repo
+        uses: actions/checkout@v3
       - name: Set up Python
         uses: actions/setup-python@v3
         with:
           python-version: "3.10"
       - name: Install dependencies
         run: |
-          sudo apt install pandoc gfortran
+          sudo apt install pandoc
           python -m pip install --upgrade pip
           pip install .
           pip install -r docs/requirements.txt

MANIFEST.in

@@ -8,7 +8,7 @@ recursive-include rompy *.png
 recursive-include docs/source *
 include docs/Makefile docs/make.bat
 
-recursive-include templates *
+recursive-include rompy/templates *
 
 include versioneer.py
 include rompy/_version.py

notebooks/oceanum_datamesh_demo.yml

@@ -0,0 +1,92 @@
+# Note that this is config demonstrates a full model 
+# example running off the coast of Raglan. It uses
+# era5 wind forcing, and spectral boundaries from
+# oceanum's global hindcast. These datasets are 
+# read from the oceanum catalog
+
+run_id: oceanum 
+period:
+  start: 20230101T00
+  duration: 6h
+  interval: 1h
+output_dir: simulations
+config:
+  model_type: swan
+  grid:
+    x0: 174.60
+    y0: -37.95
+    rot: 10.0
+    dx: 0.02
+    dy: 0.02
+    nx: 20
+    ny: 20
+    gridtype: REG
+  spectral_resolution:
+    fmin: 0.0464
+    fmax: 1.0
+    nfreqs: 31
+    ndirs: 36
+  forcing:
+    wind:
+      model_type: swan
+      id: wind 
+      var: WIND 
+      dataset: 
+        model_type: datamesh
+        dataset_id: era5_wind10m
+        token: null # Use a Datamesh token here if not in your environment
+      filter:
+        sort: 
+          coords: [latitude]
+      z1: u10
+      z2: v10
+      latname: latitude
+      lonname: longitude
+    bottom: 
+      id: bottom
+      var: BOTTOM
+      dataset: 
+        model_type: intake
+        catalog_uri: ../rompy/catalogs/oceanum.yaml
+        dataset_id: gebco_2022
+      fac: -1.0
+      z1: elevation
+      latname: lat
+      lonname: lon
+    boundary:
+      id: bnd
+      dataset: 
+        model_type: intake
+        catalog_uri: ../rompy/catalogs/oceanum.yaml
+        dataset_id: oceanum_wave_nz_era5_v1_spec
+        # dataset_id: oceanum_wave_glob05_era5_v1_spec
+      latname: lat
+      lonname: lon
+      tolerance: 0.1
+      spacing: 0.01
+      sel_method: idw
+      rectangle: closed
+  physics: 
+    friction: "MAD"
+    friction_coeff: 0.1
+  outputs:
+    grid:
+      variables:
+      - DEPTH
+      - UBOT
+      - HSIGN
+      - HSWELL
+      - DIR
+      - TPS
+      - TM01
+      - WIND
+    spec:
+      locations:
+        coords:
+        - lon: 174.61
+          lat: -37.96
+        - lon: 174.62
+          lat: -37.96
+        - lon: 174.62
+          lat: -37.97
+

notebooks/oceanum_example_datamesh.ipynb

@@ -1,3 +1,5 @@
+click
+cloudpathlib
 cookiecutter
 dask
 fsspec
@@ -9,15 +11,12 @@ intake-geopandas
 matplotlib
 netcdf4
 numpy
+oceanum
 owslib
 pandas
 pydantic
+pydantic_numpy
 scipy
 tqdm
 xarray
-pydantic
-pydantic_numpy
-pathlib
-cloudpathlib
-Click
 wavespectra

requirements.txt

@@ -1,5 +1,5 @@
 from .config import BaseConfig
-from .data import DataBlob, DataGrid, Dataset, DatasetIntake, DatasetXarray
+from .data import DataBlob, DataGrid, SourceDataset, SourceFile, SourceIntake, SourceDatamesh
 from .filters import *
 from .grid import BaseGrid, RegularGrid
 from .time import TimeRange