EchoData¶

class echopype.echodata.EchoData(converted_raw_path=None, storage_options=None, source_file=None, xml_path=None, sonar_model=None)¶

Echo data model class for handling raw converted data, including multiple files associated with the same data set.

Attributes Summary

`nc_path`
`zarr_path`

Methods Summary

`raw2nc`([save_path, combine_opt, overwrite, …])
`raw2zarr`([save_path, combine_opt, …])
`to_netcdf`([save_path])	Save content of EchoData to netCDF.
`to_zarr`([save_path])	Save content of EchoData to zarr.

Attributes Documentation

Methods Documentation

raw2nc(save_path=None, combine_opt=False, overwrite=False, compress=True)¶

raw2zarr(save_path=None, combine_opt=False, overwrite=False, compress=True)¶

to_netcdf(save_path=None, **kwargs)¶

Save content of EchoData to netCDF.

Parameters:

save_path : str: path that converted .nc file will be saved
compress : bool: whether or not to perform compression on data variables Defaults to True
overwrite : bool: whether or not to overwrite existing files Defaults to False
parallel : bool: whether or not to use parallel processing. (Not yet implemented)
output_storage_options : dict: Additional keywords to pass to the filesystem class.

to_zarr(save_path=None, **kwargs)¶

Save content of EchoData to zarr.

Parameters:

save_path : str: path that converted .nc file will be saved
compress : bool: whether or not to perform compression on data variables Defaults to True
overwrite : bool: whether or not to overwrite existing files Defaults to False
parallel : bool: whether or not to use parallel processing. (Not yet implemented)
output_storage_options : dict: Additional keywords to pass to the filesystem class.