From e71d12a25f1ee49259fb6502eab66d74b88388eb Mon Sep 17 00:00:00 2001 From: Xylar Asay-Davis Date: Tue, 12 Nov 2024 18:26:44 -0700 Subject: [PATCH] Add docs --- conda_package/docs/api.rst | 2 ++ conda_package/docs/index.rst | 1 + conda_package/docs/ocean/streamfunction.rst | 14 ++++++++++++++ 3 files changed, 17 insertions(+) create mode 100644 conda_package/docs/ocean/streamfunction.rst diff --git a/conda_package/docs/api.rst b/conda_package/docs/api.rst index a14f213d5..d4affcba7 100644 --- a/conda_package/docs/api.rst +++ b/conda_package/docs/api.rst @@ -225,6 +225,8 @@ Ocean Tools depth.compute_depth depth.compute_zmid + compute_barotropic_streamfunction + .. currentmodule:: mpas_tools.ocean.inject_bathymetry .. autosummary:: diff --git a/conda_package/docs/index.rst b/conda_package/docs/index.rst index b2deb349b..4824ffe04 100644 --- a/conda_package/docs/index.rst +++ b/conda_package/docs/index.rst @@ -50,6 +50,7 @@ analyzing simulations, and in other MPAS-related workflows. ocean/coastline_alteration ocean/moc ocean/depth + ocean/streamfunction ocean/visualization .. toctree:: diff --git a/conda_package/docs/ocean/streamfunction.rst b/conda_package/docs/ocean/streamfunction.rst new file mode 100644 index 000000000..21e6e8481 --- /dev/null +++ b/conda_package/docs/ocean/streamfunction.rst @@ -0,0 +1,14 @@ +.. _ocean_streamfunction: + +Computing streamfunctions +========================= + +Computing the barotropic streamfunction +--------------------------------------- + +The function :py:func:`mpas_tools.ocean.compute_barotropic_streamfunction()` +computes the barotproic streamfunction at vertices on the MPAS-Ocean grid. +The function takes a dataset containing an MPAS-Ocean mesh and another with +``normalVelocity`` and ``layerThickness`` variables (possibly with a +``timeMonthly_avg_`` prefix). The streamfunction is computed only over the +range of (positive-down) depths provided and at the given time index.