From 8b1775d78a46db6254e1b64af59d9c426ac63e4e Mon Sep 17 00:00:00 2001 From: Dan Nowacki Date: Wed, 21 Feb 2024 09:04:39 -0800 Subject: [PATCH] Doc updates --- doc/config.rst | 7 ++++++- doc/vec.rst | 12 ++++++++++++ doc/wvs.rst | 6 +++--- 3 files changed, 21 insertions(+), 4 deletions(-) diff --git a/doc/config.rst b/doc/config.rst index 869c4815..9d4c3c15 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -192,9 +192,14 @@ Onset Hobo - ``names``: option for user specified column names (only recommended when code will not read names using automated/default method) Lowell TCM Hobo ----------- +--------------- - All the _min, _max, _bad_ens, etc. options available to the EXO. - ``skipfooter``: number of lines to skip in the CSV file at the end of the file - ``ncols``: number of columns of data to read, starting at first - ``names``: option for user specified column names (only recommended when code will not read names using automated/default method) + +Vector +------ +- ``pressure_sensor_height`` and ``velocity_sample_volume_height`` to specify the elevations of these two sensors. +- ``puv``: set to ``true`` to compute PUV wave statistics. diff --git a/doc/vec.rst b/doc/vec.rst index c56bf0fd..27ac0344 100644 --- a/doc/vec.rst +++ b/doc/vec.rst @@ -29,3 +29,15 @@ runveccdf2nc.py .. argparse:: :ref: stglib.core.cmd.veccdf2nc_parser :prog: runveccdf2nc.py + + Compute wave statistics + ======================= + + Use stglib's built-in wave-statistics toolbox to compute a wave-statistics file. + + runvecnc2waves.py + ----------------- + + .. argparse:: + :ref: stglib.core.cmd.vecnc2waves_parser + :prog: runvecnc2waves.py diff --git a/doc/wvs.rst b/doc/wvs.rst index 489e607f..88dfd594 100644 --- a/doc/wvs.rst +++ b/doc/wvs.rst @@ -31,12 +31,12 @@ runwvscdf2nc.py :ref: stglib.core.cmd.wvscdf2nc_parser :prog: runwvscdf2nc.py -Compute waves statistics -======================== +Compute wave statistics +======================= Using DIWASP: This is run separately in Matlab using the DIWASP toolbox (docs TODO). -Use stglib's built-in waves statistics toolbox to compute a wave statistics file. +Use stglib's built-in wave-statistics toolbox to compute a wave-statistics file. runwvsnc2waves.py -----------------