PyOPIA 2.5.7__tar.gz → 2.5.9__tar.gz

{pyopia-2.5.7 → pyopia-2.5.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyOPIA
-Version: 2.5.7
+Version: 2.5.9
 Summary: A Python Ocean Particle Image Analysis toolbox.
 Home-page: https://github.com/sintef/pyopia
 Keywords: Ocean,Particles,Imaging,Measurement,Size distribution

pyopia-2.5.9/pyopia/__init__.py

@@ -0,0 +1 @@
+__version__ = '2.5.9'

{pyopia-2.5.7 → pyopia-2.5.9}/pyopia/instrument/silcam.py

@@ -214,7 +214,8 @@ class SilCamLoad():
     :func:`pyopia.instrument.silcam.timestamp_from_filename`
 
     Required keys in :class:`pyopia.pipeline.Data`:
-        - :attr:`pyopia.pipeline.Data.filename`
+        - :attr:`pyopia.pipeline.Data.filename` conforming to the format 'DYYYYmmddTHHMMSS.ffffff.silc'
+        e.g. 'D20240919T074500.183294.silc'
 
     Parameters
     ----------

{pyopia-2.5.7 → pyopia-2.5.9}/pyopia/io.py

@@ -160,7 +160,11 @@ def load_image_stats(datafilename):
 
 
 def load_stats(datafilename):
-    '''Load STATS file as a DataFrame
+    '''Load -STATS.nc file as xarray Dataset
+
+    .. warning:: Support for loading of old -STATS.h5 formats will be removed in version 3.0.0.
+        They will need to be converted to .nc prior to loading.
+        Data loaded from -STATS.h5 are returned as an xarray Dataset without metadata.
 
     Parameters
     ----------
@@ -169,21 +173,24 @@ def load_stats(datafilename):
 
     Returns
     -------
-    stats : DataFrame
-        STATS DataFrame  / xarray dataset
+    xstats : xarray.Dataset
+        Particle statistics
     '''
 
     if datafilename.endswith('.nc'):
-        with xarray.open_dataset(datafilename) as stats:
-            stats.load()
+        with xarray.open_dataset(datafilename) as xstats:
+            xstats.load()
     elif datafilename.endswith('.h5'):
+        logger.warning('In future, load_stats will only take .nc files')
         stats = pd.read_hdf(datafilename, 'ParticleStats/stats')
+        xstats = stats.to_xarray()
     else:
         logger.warning('WARNING. File extension not specified.' +
                        'Assuming prefix of -STATS.h5 for backwards compatability.' +
-                       'In future, this function will only take .nc files')
+                       'In future, load_stats will only take .nc files')
         stats = pd.read_hdf(datafilename + '-STATS.h5', 'ParticleStats/stats')
-    return stats
+        xstats = stats.to_xarray()
+    return xstats
 
 
 def combine_stats_netcdf_files(path_to_data, prefix='*'):

pyopia-2.5.7/pyopia/__init__.py

@@ -1 +0,0 @@
-__version__ = '2.5.7'