Add docs

E3SM-Project · Nov 7, 2023 · d9b666d · d9b666d
1 parent ac7f225
commit d9b666d
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 0 deletions.
diff --git a/docs/developers_guide/ocean/api.md b/docs/developers_guide/ocean/api.md
@@ -314,3 +314,22 @@
    vertical.zlevel.compute_z_level_resting_thickness
    vertical.zstar.init_z_star_vertical_coord
 ```
+
+### Visualization
+
+```{eval-rst}
+.. currentmodule:: polaris.ocean.viz
+
+.. autosummary::
+   :toctree: generated/
+
+   compute_transect
+   plot_transect
+   transect.horiz.find_spherical_transect_cells_and_weights
+   transect.horiz.find_planar_transect_cells_and_weights
+   transect.horiz.make_triangle_tree
+   transect.horiz.mesh_to_triangles
+   transect.vert.find_transect_levels_and_weights
+   transect.vert.interp_mpas_to_transect_cells
+   transect.vert.interp_mpas_to_transect_nodes
+
diff --git a/docs/developers_guide/ocean/framework.md b/docs/developers_guide/ocean/framework.md
@@ -422,3 +422,13 @@ density, which is horizontally constant and increases with depth.
 The {py:func}`polaris.ocean.rpe.compute_rpe()` is used to compute the RPE as
 a function of time in a series of one or more output files.  The RPE is stored
 in `rpe.csv` and also returned as a numpy array for plotting and analysis.
+
+## Visualization
+
+The `polaris.ocean.viz` module provides functions for making plots that are
+specific to the ocean component.
+
+The `polaris.ocean.viz.transect` modules includes functions for computing
+({py:func}`polaris.ocean.viz.compute_transect()`) and plotting
+({py:func}`polaris.ocean.viz.plot_transect()`) transects through the ocean
+from a sequence of x-y or latitude-longitude coordinates.