shipgrav 1.0.6__py2.py3-none-any.whl → 1.0.7__py2.py3-none-any.whl

shipgrav/__init__.py

@@ -62,7 +62,7 @@ Navigation data
 
 Which navigation data should you use to process gravimeter data?
 
-In an ideal world, the gravimeter pulls navigation info from the ship's feed and synchronizes it perfectly with acquisition such that the output files have the correct geographic coordinates in them at the start. In practice, this synchronization doesn't always work as expected (see ``example-scripts/dgs_raw_comp.py`` for a case where the serial files do not have GPS info). So, we like to take the timestamped navigation data directly from the ship's feed and match up the gravimeter timestamps to obtain more accurate coordinates.
+In an ideal world, the gravimeter pulls navigation info from the ship's feed and synchronizes it perfectly with acquisition such that the output files have the correct geographic coordinates in them at the start. In practice, this synchronization doesn't always work as expected (see ``example-scripts/dgs_raw_comp.py`` for a case where the serial files do not have GPS info). So, we like to take the timestamped navigation data directly from the ship's feed and match up the gravimeter timestamps to obtain more accurate coordinates. Using navigation from a feed separate from the gravimeter is **highly recommended**.
 
 The database file included in shipgrav lists the navigation talkers that we expect are good to use for specific UNOLS vessels. Find the files that contain those feeds, and you should be able to read in timestamped coordinates from them.
 
@@ -94,10 +94,10 @@ The data files can be downloaded from R2R and Zenodo, and the scripts will do th
    :height: 250px
    :align: center
 
-``dgs_ccp_calc.py`` reads DGS files from R/V Thompson cruise TN400, calculates the FAA and various kinematic variables, and fits for cross-coupling coefficients. The cross-coupling correction is applied and the data are plotted with and without correction.
+``dgs_ccp_calc.py`` reads DGS files from R/V Thompson cruise TN400, calculates the FAA and various kinematic variables, and fits for cross-coupling coefficients. The cross-coupling correction is applied and the data are plotted with and without correction. Satellite-derived FAA is also plotted
 
 .. image:: _static/TN400_ccp.png
-   :alt: FAA for TN400, with and without cross-coupling correction applied.
+   :alt: FAA for TN400, with and without cross-coupling correction applied; and satellite-derived FAA.
    :height: 250px
    :align: center
 

shipgrav/database.toml

@@ -5,6 +5,7 @@ Revelle = {'dgs'=968888.6465, 'bgm'=855240.81987}
 NBP = {'dgs'=968634.2514, 'bgm'=-999}
 Ride = {'dgs'=968895.7718, 'bgm'=-999}
 Langseth = {'dgs'=-999, 'bgm'=854974.4}
+Sikuliaq = {'dgs'=969538.8152, 'bgm'=-999}
 
 [nav-talkers]
 Atlantis = 'GPGGA'

shipgrav/io.py

@@ -17,7 +17,7 @@ from tqdm import tqdm
 ########################################################################
 
 
-def read_nav(ship, pathlist, sampling=1, talker=None, ship_function=None, progressbar=True):
+def read_nav(ship, pathlist, sampling=1, talker=None, ship_function=None, decimate=0, progressbar=True):
     """ Read navigation strings from .GPS (or similar) files.
 
     Ships have different formats and use different talkers for preferred
@@ -38,6 +38,8 @@ def read_nav(ship, pathlist, sampling=1, talker=None, ship_function=None, progre
         This function should return arrays of lon, lat, and timestamps.
         Look at _navcoords() and navdate_Atlantis() (and similar functions) for examples.
     :type ship_function: function, optional
+    :param decimate: integer skip for decimating data, default 0 returns all points
+    :type decimate: int, optional
     :param progressbar: display progress bar while list of files is read
     :type progressbar: bool
 
@@ -119,6 +121,12 @@ def read_nav(ship, pathlist, sampling=1, talker=None, ship_function=None, progre
         lon_out = np.interp(sec_time, sec_time[idx], lon[idx])
         lat_out = np.interp(sec_time, sec_time[idx], lat[idx])
 
+        # decimate if we're doing that
+        if decimate:
+            sec_time = sec_time[::decimate]
+            lon_out = lon_out[::decimate]
+            lat_out = lat_out[::decimate]
+
         timetime = np.append(timetime, sec_time)
         lonlon = np.append(lonlon, lon_out)
         latlat = np.append(latlat, lat_out)
@@ -325,14 +333,16 @@ def _navcoords(allnav, talker):
         post = subnav[i].split(talker)[-1].lstrip().split(',')
         if post[0] == '':
             post = post[1:]  # correct for spacing in some files
-
-        lat[i] = int(post[1][:2]) + float(post[1][2:]) / \
-            60  # convert to decimal degrees
-        if post[2] == 'S':
-            lat[i] = -lat[i]         # handle coordinate sign
-        lon[i] = int(post[3][:3]) + float(post[3][3:])/60
-        if post[4] == 'W':
-            lon[i] = -lon[i]
+        if post[1] == '' or post[3] == '':  # no coords, nav dropped out?
+            lat[i] = np.nan; lon[i] = np.nan
+        else:
+            lat[i] = int(post[1][:2]) + float(post[1][2:]) / \
+                60  # convert to decimal degrees
+            if post[2] == 'S':
+                lat[i] = -lat[i]         # handle coordinate sign
+            lon[i] = int(post[3][:3]) + float(post[3][3:])/60
+            if post[4] == 'W':
+                lon[i] = -lon[i]
 
     return lon, lat
 
@@ -560,6 +570,8 @@ def read_dgs_laptop(fp, ship, ship_function=None, progressbar=True):
                 dat = _dgs_laptop_general(path)
             elif ship == 'Thompson':
                 dat = _dgs_laptop_Thompson(path)
+            elif ship == 'Sikuliaq':
+                dat = _dgs_laptop_Sikuliaq(path)
             else:
                 print('R/V %s not supported for dgs laptop file read' % ship)
                 return -999
@@ -581,6 +593,17 @@ def _dgs_laptop_general(path):
     return dat
 
 
+def _dgs_laptop_Sikuliaq(path):
+    """Read single laptop file for Sikuliaq, has more of a header than the others
+    """
+    dat = pd.read_csv(path,skiprows=19,names=['rgrav','long_a','crss_a','status','ve','vcc',
+                                              'al','ax','lat','lon','year','month','day',
+                                              'hour','minute','second'],
+                      usecols=(1,2,3,6,10,11,12,13,14,15,19,20,21,22,23,24))
+    dat['date_time'] = pd.to_datetime(dat[['year','month','day','hour','minute','second']],utc=True)
+    return dat
+
+
 def _dgs_laptop_Thompson(path):
     """Read single laptop file for Thompson, which does things its own way.
     """

{shipgrav-1.0.6.dist-info → shipgrav-1.0.7.dist-info}/METADATA

@@ -1,9 +1,10 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: shipgrav
-Version: 1.0.6
+Version: 1.0.7
 Summary: Functions for marine gravity data processing and reduction
 Author-email: "Hannah F. Mark" <hmark@whoi.edu>
 Maintainer-email: "Hannah F. Mark" <hmark@whoi.edu>
+License-File: LICENSE
 Keywords: UNOLS,gravimetry,marine gravity
 Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
 Classifier: Operating System :: OS Independent

{shipgrav-1.0.6.dist-info → shipgrav-1.0.7.dist-info}/RECORD

@@ -1,7 +1,7 @@
-shipgrav/__init__.py,sha256=42vF06SBX2L8-ISqu1Hkgf2fr0qRzfV1ZSgF0Q4117c,12001
-shipgrav/database.toml,sha256=8xSnXoAsfBMPDhvzKzw83oDrDT9AxD_QINZ8IWSUmiE,551
+shipgrav/__init__.py,sha256=aCI3zS2iUUH_hFhwPgs-VZDSdfsCnJExBjSgCJSVpY8,12151
+shipgrav/database.toml,sha256=_uQdFL6XeiYX_YKRB-3lzr7mVY6gcRF5r7CRL_F8Dx0,594
 shipgrav/grav.py,sha256=09d5LIczUGys9VerTngumOMLeYOqdVJVtAdBGJZw2R8,43196
-shipgrav/io.py,sha256=N2cqXRHIX_lSyCKJ35h9J4zcvs7tMKvSq0ch90xJncM,30448
+shipgrav/io.py,sha256=-w-NhsccIkTKqHwyD_rgJ3K1kiFT_fL1Nwcvw41_MsI,31586
 shipgrav/nav.py,sha256=3E2Il-PhTEPVv8_8PrLVe7h6slHq-2HYX_Q8PdpB6X4,2895
 shipgrav/utils.py,sha256=BJSBrKgCOADzdb6gBO3u9n16l22zzFXTAw42e5_QkBY,9582
 shipgrav/tests/__init__.py,sha256=i8hMukDivY8kFp7OBdo1byRJWMBvb8nDDWJcAy2cOOI,427
@@ -28,7 +28,7 @@ shipgrav/tests/ex_files/TN400_bgm.Raw,sha256=DL7T2aJednjGLMKJo6K8KcUYLMjQCiv6bsU
 shipgrav/tests/ex_files/TN400_dgs_proc.Raw,sha256=oxTXwDdyoz5yuKe253L1GgOSR5oWGGMuXfSQWrT24Ag,760
 shipgrav/tests/ex_files/TN400_dgs_raw.Raw,sha256=tb-zerwCH6kkbGDbnnJ6I-sAUdCHOvkKgXXrBb6zTj8,311
 shipgrav/tests/ex_files/TN400_nav.Raw,sha256=66dgRQTXjf0JItMWE1ZGUO6NptrGqV6JyN2wdYe5bW8,194
-shipgrav-1.0.6.dist-info/METADATA,sha256=B6JBqZZlu8Ni_o9lpZiZzM4ywutIdgzthgLIiksQE10,2855
-shipgrav-1.0.6.dist-info/WHEEL,sha256=aO3RJuuiFXItVSnAUEmQ0yRBvv9e1sbJh68PtuQkyAE,105
-shipgrav-1.0.6.dist-info/licenses/LICENSE,sha256=5X8cMguM-HmKfS_4Om-eBqM6A1hfbgZf6pfx2G24QFI,35150
-shipgrav-1.0.6.dist-info/RECORD,,
+shipgrav-1.0.7.dist-info/METADATA,sha256=V2cPOwuPuUfHqExOfpOHfDerjQcAhmsbVHMeKkK_2yo,2877
+shipgrav-1.0.7.dist-info/WHEEL,sha256=aha0VrrYvgDJ3Xxl3db_g_MDIW-ZexDdrc_m-Hk8YY4,105
+shipgrav-1.0.7.dist-info/licenses/LICENSE,sha256=5X8cMguM-HmKfS_4Om-eBqM6A1hfbgZf6pfx2G24QFI,35150
+shipgrav-1.0.7.dist-info/RECORD,,

{shipgrav-1.0.6.dist-info → shipgrav-1.0.7.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.26.3
+Generator: hatchling 1.28.0
 Root-Is-Purelib: true
 Tag: py2-none-any
 Tag: py3-none-any