From b0691cef174831659cf0ba90ae8c59c672a1eb77 Mon Sep 17 00:00:00 2001 From: Eleanor Frajka-Williams Date: Sun, 7 Sep 2025 15:12:39 +0200 Subject: [PATCH] [DOC] Update API documentation --- docs/source/oceanarray.rst | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/source/oceanarray.rst b/docs/source/oceanarray.rst index 2c5bec9..3f0915d 100644 --- a/docs/source/oceanarray.rst +++ b/docs/source/oceanarray.rst @@ -63,11 +63,11 @@ Trim instrument records to the deployment window and flag out-of-bounds values. :undoc-members: -trimming -^^^^^^^^^^^ +stage 2 - trimming +^^^^^^^^^^^^^^^^^^^ Trim instrument records to the deployment window and flag out-of-bounds values. -.. automodule:: oceanarray.trimming +.. automodule:: oceanarray.stage2 :members: :undoc-members: @@ -90,24 +90,24 @@ Convert to OceanSites format. Mooring Processing ---------------------- -filtering -^^^^^^^^^^^ +Step 1 - time_gridding +^^^^^^^^^^^^^^^^^^^^^^^ Apply Butterworth filters to remove tides and smooth high-frequency noise. -.. automodule:: oceanarray.filtering +.. automodule:: oceanarray.time_gridding :members: :undoc-members: -gridding +Step 2 - vertical gridding ^^^^^^^^^^^ Vertically interpolate T/S/P data onto a common pressure grid using climatological constraints. -.. automodule:: oceanarray.gridding +.. automodule:: oceanarray.vertical_gridding :members: :undoc-members: -stitching -^^^^^^^^^^^ +Step 3 - stitching +^^^^^^^^^^^^^^^^^^^ Concatenate deployments and interpolate onto a continuous time base. .. automodule:: oceanarray.stitching