Skip to content

Commit

Permalink
Add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
xylar committed Nov 13, 2024
1 parent 547cfe5 commit e71d12a
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 0 deletions.
2 changes: 2 additions & 0 deletions conda_package/docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -225,6 +225,8 @@ Ocean Tools
depth.compute_depth
depth.compute_zmid

compute_barotropic_streamfunction

.. currentmodule:: mpas_tools.ocean.inject_bathymetry

.. autosummary::
Expand Down
1 change: 1 addition & 0 deletions conda_package/docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ analyzing simulations, and in other MPAS-related workflows.
ocean/coastline_alteration
ocean/moc
ocean/depth
ocean/streamfunction
ocean/visualization

.. toctree::
Expand Down
14 changes: 14 additions & 0 deletions conda_package/docs/ocean/streamfunction.rst
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit e71d12a

Please sign in to comment.