From f17aa8a46659d6891afc69d91f14bc90958f3c2a Mon Sep 17 00:00:00 2001 From: De Meo Date: Fri, 2 Aug 2024 13:13:29 -0400 Subject: [PATCH] Edited documentation --- README.md | 1 + doc/index.rst | 2 ++ doc/mc.rst | 4 ++-- stglib/mc.py | 5 ++--- 4 files changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 899f9b47..83ac9398 100644 --- 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 index e2548a0d..59c83603 100644 --- 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 index 9894c059..2026dac4 100644 --- a/doc/mc.rst +++ b/doc/mc.rst @@ -1,5 +1,5 @@ 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 `. @@ -7,7 +7,7 @@ depends on two :doc:`configuration files `. 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 index c080688c..6f716400 100644 --- 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