Remove head_rotation from docs since we don't use it

USGS-CMG · Dec 15, 2023 · cb9d30d · cb9d30d
1 parent dcb4a95
commit cb9d30d
Show file tree

Hide file tree

Showing 7 changed files with 4 additions and 10 deletions.
diff --git a/doc/config.rst b/doc/config.rst
@@ -83,7 +83,6 @@ Aquadopp
 
 Aquadopp-specific options include:
 
-- ``head_rotation``: probably will be ``'horizontal'``
 - ``trim_method``: can be ``'water level'``, ``'water level sl'``, ``'bin range'``, ``None``, or ``'none'``. Or just omit the option entirely if you don't want to use it.
 - ``<VAR>_trim_single_bins``: trim data where only a single bin of data (after trimming via ``trim_method``) remains. Set this value to ``true`` to enable.
 - ``<VAR>_maxabs_diff_2d``: trim values in a 2D DataArray when the absolute value of the increase is greater than a specified amount
@@ -100,7 +99,6 @@ Signature-specific options include (see Aquadopp for others):
 
 - ``outdir``: output directory (make sure it exists) to write individual ``cdf`` files before being compiled into a single ``cdf`` file per data type
 - ``orientation``: can be ``UP`` or ``DOWN`` use this to identify orientation of profiler
-- ``head_rotation``: probably will be ``'horizontal'``
 
 .. literalinclude:: ../examples/aqd_config.yaml
    :language: yaml

diff --git a/examples/aqd_config.yaml b/examples/aqd_config.yaml
@@ -3,7 +3,6 @@ filename: '10771Baqd'   # name of output file, -raw.cdf or .nc will be appended
 LatLonDatum: 'NAD83'
 ClockError: 0 # sec, negative is slow
 orientation: 'UP'          # use this to identify orientation of profiler
-head_rotation: 'horizontal'
 initial_instrument_height: 0.15  # meters - estimated!!!
 initial_instrument_height_note: ''
 zeroed_pressure: 'Yes' # was pressure zeroed before deployment

diff --git a/stglib/tests/data/aqd1118A_config.yaml b/stglib/tests/data/aqd1118A_config.yaml
diff --git a/stglib/tests/data/aqd1121A_config.yaml b/stglib/tests/data/aqd1121A_config.yaml
@@ -3,7 +3,6 @@ filename: '11211Aaqd'   # name of output file, -raw.cdf or .nc will be appended
 LatLonDatum: 'NAD83'
 ClockError: 0 #sec
 orientation: 'UP'          # use this to identify orientation of profiler
-head_rotation: 'horizontal' #will probably be 'horizontal'
 initial_instrument_height: 0.125  # meters
 initial_instrument_height_note: 'Above grate'
 zeroed_pressure: 'Yes' # was pressure zeroed before deployment

diff --git a/stglib/tests/data/aqdhr1113tst_config.yaml b/stglib/tests/data/aqdhr1113tst_config.yaml
diff --git a/stglib/tests/data/sig11262_config.yaml b/stglib/tests/data/sig11262_config.yaml
@@ -5,7 +5,6 @@ LatLonDatum: 'NAD83'
 ClockError: 0 #sec
 #ClockDrift: 15 #sec < 60 s no need to apply correction
 orientation: 'Down'          # use this to identify orientation of profiler
-head_rotation: 'horizontal' #will probably be 'horizontal'
 initial_instrument_height: 1.56  # meters
 initial_instrument_height_note: 'From seabed'
 zeroed_pressure: 'Yes' # was pressure zeroed before deployment

diff --git a/stglib/tests/data/sig1126_config.yaml b/stglib/tests/data/sig1126_config.yaml
@@ -5,7 +5,6 @@ LatLonDatum: 'NAD83'
 ClockError: 0 #sec
 #ClockDrift: 15 #sec < 60 s no need to apply correction
 orientation: 'UP'          # use this to identify orientation of profiler
-head_rotation: 'horizontal' #will probably be 'horizontal'
 initial_instrument_height: 2.12  # meters
 initial_instrument_height_note: 'From seabed'
 zeroed_pressure: 'Yes' # was pressure zeroed before deployment