Edited documentation

USGS-CMG · Aug 2, 2024 · f17aa8a · f17aa8a
1 parent c7593d0
commit f17aa8a
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -21,6 +21,7 @@ Currently, this package has at least partial support for:
 - RD Instruments ADCPs
 - Moving-boat ADCP data processed using [QRev](https://hydroacoustics.usgs.gov/movingboat/QRev.shtml), for use in index-velocity computation
 - EofE ECHOLOGGER altimeters
+- SBE 37 Microcat
 
 We have plans to support:
 

diff --git a/doc/index.rst b/doc/index.rst
@@ -29,6 +29,7 @@ Currently, this package has at least partial support for:
 - RD Instruments ADCPs
 - Moving-boat ADCP data processed using QRev_, for use in index-velocity computation
 - EofE ECHOLOGGER altimeters
+- SBE 37 Microcat
 
 .. _QRev: https://hydroacoustics.usgs.gov/movingboat/QRev.shtml
 
@@ -53,6 +54,7 @@ We have plans to support:
    rsk
    exo
    iq
+   mc
    wet
    hobo
    wxt

diff --git a/doc/mc.rst b/doc/mc.rst
@@ -1,13 +1,13 @@
 Seabird SBE 37 MicroCAT
-**************
+***********************
 
 Data will generally be processed using a series of run scripts. The first script for each instrument type
 depends on two :doc:`configuration files </config>`.
 
 Instrument data to raw .cdf
 ===========================
 
-Convert from exported .csv file to a raw netCDF file with .cdf extension using ``runmcasc2cdf.py``.
+Convert from exported .asc file to a raw netCDF file with .cdf extension using ``runmcasc2cdf.py``.
 
 runmcasc2cdf.py
 ----------------

diff --git a/stglib/mc.py b/stglib/mc.py
@@ -4,7 +4,7 @@
 from .core import qaqc, utils
 
 
-def read_asc(filnam, skiprows=50, encoding="utf-8"):
+def read_asc(filnam, skiprows=51, encoding="utf-8"):
     """Read data from an SBE 37 MicroCAT .asc file into an xarray
     Dataset.
 
@@ -13,7 +13,7 @@ def read_asc(filnam, skiprows=50, encoding="utf-8"):
     filnam : string
         The filename
     skiprows : int, optional
-        How many header rows to skip. Default 50
+        How many header rows to skip. Default 51
     encoding : string, optional
         File encoding. Default 'utf-8'
     Returns
@@ -31,7 +31,6 @@ def read_asc(filnam, skiprows=50, encoding="utf-8"):
         encoding=encoding,
         index_col=False,
     )
-    print(df)
     df.set_index("time", inplace=True)
     mc = df.to_xarray()
     return mc