sectionate 0.3.0__py3-none-any.whl

sectionate/__init__.py

@@ -0,0 +1,6 @@
+from .section import *
+from .transports import *
+from .tracers import *
+from . import utils
+from .utils import load_section
+from .version import __version__

sectionate/catalog/Atlantic_transport_arrays.json

@@ -0,0 +1,348 @@
+{
+  "Western Europe": {
+    "lon": [
+      9.0,
+      15.0,
+      22.0,
+      35.0
+    ],
+    "lat": [
+      48.0,
+      51.0,
+      49.0,
+      60.0
+    ]
+  },
+  "Bering Strait": {
+    "lon": [
+      55.0,
+      -290.0,
+      -225.0,
+      -190.0,
+      -185.0,
+      -180.0,
+      -175.0,
+      -170.0,
+      -165.0,
+      -150.0,
+      -130.0,
+      -100.0,
+      -90.0
+    ],
+    "lat": [
+      55.0,
+      55.0,
+      65.0,
+      65.5,
+      67.0,
+      67.5,
+      66.0,
+      66.0,
+      65.5,
+      65.5,
+      65.5,
+      50.0,
+      45.0
+    ]
+  },
+  "Fram Strait": {
+    "lon": [
+      -44.0,
+      -30.0,
+      -22.0,
+      14.3,
+      28.5,
+      29.5,
+      35.0
+    ],
+    "lat": [
+      69.0,
+      78.0,
+      79.0,
+      79.0,
+      70.0,
+      66.0,
+      60.0
+    ]
+  },
+  "Davis Strait": {
+    "lon": [
+      -65.0,
+      -65.0,
+      -62.0,
+      -50.0,
+      -47.5,
+      -44.0
+    ],
+    "lat": [
+      53.0,
+      57.5,
+      66.5,
+      66.5,
+      66.5,
+      69.0
+    ]
+  },
+  "Denmark Strait": {
+    "lon": [
+      -44.0,
+      -35.0,
+      -25.0,
+      -20.0
+    ],
+    "lat": [
+      69.0,
+      69.0,
+      65.0,
+      65.0
+    ]
+  },
+  "Faroe Current": {
+    "lon": [
+      -14.0,
+      -6.25
+    ],
+    "lat": [
+      65.0,
+      62.25
+    ]
+  },
+  "Faroe Bank": {
+    "lon": [
+      -6.25,
+      -6.25,
+      -5.0,
+      -5.0
+    ],
+    "lat": [
+      62.25,
+      61.0,
+      58.5,
+      56.75
+    ]
+  },
+  "OSNAP West": {
+    "lon": [
+      -58.0,
+      -51.0,
+      -49.0,
+      -48.0,
+      -45.0,
+      -44.0
+    ],
+    "lat": [
+      52.0,
+      52.5,
+      54.0,
+      58.5,
+      60.5,
+      64.0
+    ]
+  },
+  "OSNAP East": {
+    "lon": [
+      -44.0,
+      -42.0,
+      -31.0,
+      -28.0,
+      -15.0,
+      -12.5,
+      -9.5,
+      -5.0
+    ],
+    "lat": [
+      64.0,
+      60.5,
+      59.0,
+      58.25,
+      58.0,
+      57.5,
+      57.25,
+      56.75
+    ]
+  },
+  "English Channel": {
+    "lon": [
+      -5.0,
+      0.0,
+      0.0,
+      2.5,
+      2.5
+    ],
+    "lat": [
+      56.75,
+      51.0,
+      49.0,
+      49.0,
+      47.5
+    ]
+  },
+  "NOAC 47N": {
+    "lon": [
+      -58.0,
+      -56.5,
+      -50.0,
+      -12.0,
+      2.5
+    ],
+    "lat": [
+      52.0,
+      48.25,
+      47.0,
+      47.5,
+      47.5
+    ]
+  },
+  "Strait of Gibraltar": {
+    "lon": [
+      -4.0,
+      -5.75,
+      -5.75,
+      -4.0
+    ],
+    "lat": [
+      38.0,
+      36.5,
+      35.5,
+      34.0
+    ]
+  },
+  "RAPID 26N": {
+    "lon": [
+      -90.0,
+      -80.0,
+      -80.0,
+      -72.0,
+      -49.0,
+      -41.0,
+      -24.0,
+      -21.5,
+      -16.5,
+      -10.0,
+      -5.0,
+      -4.0
+    ],
+    "lat": [
+      40.0,
+      34.0,
+      26.0,
+      26.0,
+      25.0,
+      24.75,
+      24.5,
+      25.5,
+      27.0,
+      28.5,
+      28.5,
+      28.5
+    ]
+  },
+  "Quebec": {
+    "lon": [
+      -80.0,
+      -75.0,
+      -70.0,
+      -65.0
+    ],
+    "lat": [
+      47.5,
+      50.0,
+      53.0,
+      53.0
+    ]
+  },
+  "MOVE 16N": {
+    "lon": [
+      -61.5,
+      -61.5,
+      -61.5,
+      -51.5,
+      -12.0,
+      20.0
+    ],
+    "lat": [
+      0.0,
+      8.0,
+      16.75,
+      16.0,
+      16.0,
+      16.0
+    ]
+  },
+  "Isthmus of Panama": {
+    "lon": [
+      -105.0,
+      -105.0,
+      -98.0,
+      -95.0,
+      -92.0,
+      -91.0,
+      -90.0,
+      -87.0,
+      -85.0,
+      -84.8,
+      -83.8,
+      -83.0,
+      -82.0,
+      -81.0,
+      -80.0,
+      -79.4,
+      -78.8,
+      -78.0,
+      -77.0,
+      -71.0
+    ],
+    "lat": [
+      40.0,
+      22.0,
+      19.0,
+      17.3,
+      17.3,
+      16.5,
+      15.0,
+      14.5,
+      12.5,
+      11.0,
+      10.0,
+      9.2,
+      8.7,
+      8.3,
+      9.0,
+      9.3,
+      9.2,
+      8.8,
+      7.0,
+      0.0
+    ]
+  },
+  "11S": {
+    "lon": [
+      -55.0,
+      -37.0,
+      -34.0,
+      15.0,
+      25.0
+    ],
+    "lat": [
+      -9.0,
+      -9.0,
+      -11.0,
+      -11.0,
+      -11.0
+    ]
+  },
+  "SAMBA": {
+    "lon": [
+      -55.0,
+      -55.0,
+      19.5,
+      25.0
+    ],
+    "lat": [
+      -20.0,
+      -34.5,
+      -34.5,
+      -20.0
+    ]
+  }
+}

sectionate/gridutils.py

@@ -0,0 +1,95 @@
+def get_geo_corners(grid):
+    """
+    Find longitude and latitude coordinates from grid dataset, assuming the coordinate
+    names contain the sub-strings "lon" and "lat", respectively.
+
+    Parameters
+    ----------
+    grid: xgcm.Grid
+        Contains information about ocean model grid discretization, e.g. coordinates and metrics.
+        
+    Returns
+    -------
+    dict
+        Dictionary containing names of longitude and latitude coordinates.
+    """
+    dims = {}
+    for axis in ["X", "Y"]:
+        if "outer" in grid.axes[axis].coords:
+            dims[axis] = grid.axes[axis].coords["outer"]
+        elif "right" in grid.axes[axis].coords:
+            dims[axis] = grid.axes[axis].coords["right"]
+        else:
+            raise ValueError("Only 'symmetric' and 'non-symmetric' grids\
+            are currently supported. They require C-grid topology, i.e. with\
+            vorticity coordinates at 'outer' and 'right' positions, respectively.")
+
+    coords = grid._ds.coords
+    return {
+        axis: [
+            coords[c] for c in coords
+            if (
+                (geoc in c) and
+                (dims["X"] in coords[c].dims) and
+                (dims["Y"] in coords[c].dims)
+            )
+        ][0]
+        for axis, geoc in zip(["X", "Y"], ["lon", "lat"])
+    }
+    
+def coord_dict(grid):
+    """
+    Find names of "X" and "Y" dimension variables from grid dataset.
+
+    Parameters
+    ----------
+    grid: xgcm.Grid
+        Contains information about ocean model grid discretization, e.g. coordinates and metrics.
+        
+    Returns
+    -------
+    dict
+        Dictionary containing names of "X" and "Y" dimension variables, at both cell 'center' position
+        and either 'outer' or 'right' position. ('left' position not yet supported.)
+    """
+    if check_symmetric(grid):
+        corner_pos = "outer"
+    else:
+        corner_pos = "right"
+        
+    return {
+        "X": {
+            "center": grid.axes["X"].coords["center"],
+            "corner": grid.axes["X"].coords[corner_pos]},
+        "Y": {
+            "center": grid.axes["Y"].coords["center"],
+            "corner": grid.axes["Y"].coords[corner_pos]},
+    }
+    
+def check_symmetric(grid):
+    """
+    Check whether the horizontal ocean model grid is symmetric or not, according to MOM6 conventions.
+    Symmetric C-grids have tracers on (M,N) 'center' positions and vorticity on (M+1, N+1) 'outer' positions.
+    Non-symmetric C-grids instead have vorticity on (M,N) 'right' positions.
+
+    Parameters
+    ----------
+    grid: xgcm.Grid
+        Contains information about ocean model grid discretization, e.g. coordinates and metrics.
+        
+    Returns
+    -------
+    symmetric : bool
+        True if symmetric; False if non-symmetric.
+        
+    """
+    pos_dict = {
+        p : ((p in grid.axes["X"].coords) and (p in grid.axes["Y"].coords))
+        for p in ["outer", "right"]
+    }
+    if pos_dict["outer"]:
+        return True
+    elif pos_dict["right"]:
+        return False
+    else:
+        raise ValueError("Horizontal grid axes ('X', 'Y') must be either both symmetric or both non-symmetric (by MOM6 conventions).")