add docs and docstring for sonar_model in open_raw (OSOceanAcoustics#475

) * add docs and docstring for sonar_model in open_raw * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * update docs/requirements.txt for rtd * fix typo Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Ze-sys · Nov 4, 2021 · 1bb675b · 1bb675b
1 parent c172bca
commit 1bb675b
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 6 deletions.
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,4 +1,5 @@
 sphinx_rtd_theme
 sphinx-automodapi
 sphinxcontrib-mermaid
-numpydoc
+numpydoc
+docutils<0.18
diff --git a/docs/source/convert.rst b/docs/source/convert.rst
@@ -37,11 +37,14 @@ File conversion for different types of echosounders is achieved by
 using the single function ``open_raw`` to parse the raw data and
 create a fully parsed ``EchoData`` object.
 
-For data files from EK60, EK80 and  EA640 echosounders,
-use the parameter ``sonar_model`` to indicate the echosounder type,
-since there is no specific information in the extension ``.raw``
-that includes information about the echosounder type.
-In this example, ``open_raw`` is used to convert a raw EK80 file,
+Use the parameter ``sonar_model`` to indicate the echosounder type:
+    - ``EK60``: Kongsberg Simrad EK60 echosounder
+    - ``EK80``: Kongsberg Simrad EK80 and Kongsberg EA640 echsoounders
+    - ``AZFP``: ASL Environmental Sciences AZFP echosounder
+    - ``AD2CP``: Nortek Signature series ADCP
+      (tested with Signature 500 and Signature 1000)
+
+In the following example, ``open_raw`` is used to convert a raw EK80 file,
 return the EchoData object ``ed``, and generate a converted
 netCDF file named ``FILENAME.nc`` saved to the directory path
 ``./unpacked_files``:

diff --git a/echopype/convert/api.py b/echopype/convert/api.py
@@ -335,6 +335,13 @@ def open_raw(
         path to raw data file
     sonar_model : str
         model of the sonar instrument
+
+        - ``EK60``: Kongsberg Simrad EK60 echosounder
+        - ``EK80``: Kongsberg Simrad EK80 and Kongsberg EA640 echsoounders
+        - ``AZFP``: ASL Environmental Sciences AZFP echosounder
+        - ``AD2CP``: Nortek Signature series ADCP
+          (tested with Signature 500 and Signature 1000)
+
     xml_path : str
         path to XML config file used by AZFP
     convert_params : dict