Skip to content

[DOC] Update API documentation #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
eleanorfrajka merged 1 commit into from
Sep 7, 2025
Merged

[DOC] Update API documentation #16

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions docs/source/oceanarray.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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
Expand Down