Merge branch 'ABS_code' into 'master'

Add support for Aquatec ABS instrument See merge request cmgp/stglib!3
USGS-CMG · Dec 13, 2024 · 6856a67 · 6856a67
2 parents 45f2354 + 60d2226
commit 6856a67
Show file tree

Hide file tree

Showing 18 changed files with 774 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -22,6 +22,7 @@ Currently, this package has at least partial support for:
 - SBE 37 Microcat
 - SBE 26plus Seagauge
 - TruBlue pressure sensors
+- AQUAscat1000R
 
 We have plans to support:
 

diff --git a/doc/abss.rst b/doc/abss.rst
@@ -0,0 +1,4 @@
+AQUAscat1000R
+*************
+
+Starting with .mat files exported from Aquatec's ReadAquaScat1000.m script, use :doc:`runots.py </runots>` to process using the two :doc:`configuration files </config>`.
diff --git a/doc/config.rst b/doc/config.rst
@@ -251,4 +251,18 @@ TruBlue
 - ``wave_interval``: interval in seconds for calculating wave bursts from continuous pressure data
 - ``wp_min``, ``wp_max``: min/max allowable wave period, in seconds
 - ``wh_min``, ``wh_max``: min/max allowable wave height, in meters
-- ``wp_ratio``: maximum allowable ratio between peak period (``wp_peak``) and mean period (``wp_4060``).
+- ``wp_ratio``: maximum allowable ratio between peak period (``wp_peak``) and mean period (``wp_4060``).
+
+AQUAscat1000R
+-------------
+- ``outdir``: path to desired folder for burst .cdf files (converted from burst .mat files in mat2cdf)
+- ``matdir``: path to folder containing burst .mat files generated from Aquatec's ReadAquascat1000.m
+- ``P_1_offset``: offset between 0 and abs pressure before deploying
+- ``P_1_scale``: scale factor to apply to raw pressure data, likely 2. Plot raw data to asses appropriate scale factor. 
+- ``Tx_offset``: offset between ABSS temperature and actual temperature. Plot raw data to asses appropriate scale factor. Check with another instrument. 
+- ``Tx_scale``: scale factor to apply to raw temperature data. Likely none needed. Plot raw data to asses appropriate scale factor. 
+- ``Bat_offset``: offset between ABSS raw battery voltage and actual battery voltage. Likely none needed. 
+- ``Bat_scale``: scale factor to apply to raw battery voltage data, likely 2. Plot raw data to asses appropriate scale factor. 
+- ``orientation``: orientation of transducer(s)
+- ``initial_instrument_height``: height of acoustic transducer
+- ``pressure_sensor_height``: height of pressure port on canister, likely different that transducer height
diff --git a/doc/index.rst b/doc/index.rst
@@ -32,6 +32,7 @@ Currently, this package has at least partial support for:
 - SBE 37 Microcat
 - SBE 26plus Seagauge
 - TruBlue pressure sensors
+- AQUAscat1000R
 
 .. _QRev: https://hydroacoustics.usgs.gov/movingboat/QRev.shtml
 
@@ -49,6 +50,7 @@ We have plans to support:
    Processing data with runots.py (use this!) <runots>
    atmos
    waves
+   abss
    aqd
    aqdhr
    wvs

diff --git a/stglib/__init__.py b/stglib/__init__.py
@@ -1,5 +1,6 @@
 from . import (
     _version,
+    abss,
     aqd,
     argonaut,
     core,