Per #1954, add documentation about the semilatlon grid.

dtcenter · Sep 16, 2022 · 0631729 · 0631729
1 parent 2f92e78
commit 0631729
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/docs/Users_Guide/appendixB.rst b/docs/Users_Guide/appendixB.rst
@@ -23,6 +23,8 @@ The following map projections are currently supported in MET:
 
 * Gaussian Projection
 
+* Semi Lat/Lon
+
 Grid Specification Strings
 ==========================
 
@@ -82,6 +84,10 @@ For a Gaussian grid, the syntax is
 
 The parameters **Nx** and **Ny** are as before, while **lon_zero** defines the first longitude.
 
+For a Semi Lat/Lon grid, no grid specification string is supported. This grid type is only supported via Python embedding or when reading NetCDF files generated by another MET tool. A Semi Lat/Lon grid defines the information about 2D field of data whose dimension are defined by arrays of latitude (**lats**), longitude (**lons**), level (**levels**), and time (**times**). Times are defined as unixtime, the number of seconds since January 1, 1970. Typically, the lats or lons array and the levels or times array has non-zero length. For example, a zonal mean field is defined using the lats and levels array. A meridional mean field is defined using the lons and levels array. A Hovmoeller field is defined using lats or lons versus times. A arbitrary cross-section is defined by specifying both the lats and lons array with exactly the same length versus levels or times.
+
+Statistics can be computed from data on Semi Lat/Lon grids but only when all data resides on the same Semi Lat/Lon grid. Two Semi Lat/Lon grids are equal when their lats, lons, levels, and times arrays match. No functionality is provided to regrid Semi Lat/Lon data. The MET tools can plot Semi Lat/Lon data, however no map data is overlaid since these grids lack two spatial dimensions.
+
 Grids
 =====
 

diff --git a/docs/Users_Guide/appendixF.rst b/docs/Users_Guide/appendixF.rst
@@ -173,6 +173,15 @@ When specified as a dictionary, the contents of the **grid** dictionary vary bas
   • lon_zero (double)
   • nx, ny   (int)
 
+• **SemiLatLon** grid dictionary entries:
+
+  • type     ("SemiLatLon")
+  • name     (string)
+  • lats     (list of doubles)
+  • lons     (list of doubles)
+  • levels   (list of doubles)
+  • times    (list of doubles)
+
 Additional information about supported grids can be found in :ref:`appendixB`.
 
 **Using Xarray DataArrays**