Skip to content

Commit

Permalink
Add v0.5.2 release notes to docs what's new (#399)
Browse files Browse the repository at this point in the history
* add v0.5.2 release notes to docs what's new

* add #396 to list

* fix inline code styling

* fix nested list
  • Loading branch information
leewujung authored Jul 18, 2021
1 parent a10cf91 commit e48f8f3
Showing 1 changed file with 32 additions and 2 deletions.
34 changes: 32 additions & 2 deletions docs/source/whats-new.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,43 @@ What's new
See `GitHub releases page <https://github.com/OSOceanAcoustics/echopype/releases>`_ for the complete history.


v0.5.2 (2021 Jul 18)
--------------------

Overview
~~~~~~~~

This is a minor release that addresses issues related to time encoding for data variables related to platform locations and data conversion/encoding for AD2CP data files.

Bug fixes and improvements
~~~~~~~~~~~~~~~~~~~~~~~~~~

- Fixed the ``location_time`` encoding in the ``Platform`` group for latitude and longitude data variables (#393)
- Fixed the ``location_time`` encoding in the ``Platform/NMEA`` group (#395)
- Updated ``EchoData`` repr to show ``Platform/NMEA`` (#395, #396)
- Improved AD2CP data parsing and conversion (#388)

- Cleaned up organization of data from different sampling modes and their corresponding time coordinates
- Fixed parsing issues that generated spikes in parsed echosounder mode amplitude data
- Removed the ``Beam_complex`` group and put raw IQ samples in the ``Vendor`` group per convention requirements
- Populated the ``Sonar`` group with AD2CP information



v0.5.1 (2021 Jun 16)
--------------------

Overview
~~~~~~~~

This is a minor release that addresses a couple of issues from the last major version (0.5.0)
This is a minor release that addresses a couple of issues from the last major version (0.5.0)
and improves code maintenance and testing procedures.


New features
~~~~~~~~~~~~

- Added experimental functions to detect and correct ``ping_time`` reversals.
- Added experimental functions to detect and correct ``ping_time`` reversals.
See `qc` subpackage (#297)


Expand Down Expand Up @@ -160,16 +183,23 @@ New features
~~~~~~~~~~~~

- Add EK80 support:

- File conversion from EK80 `.raw` files to netCDF and zarr formats
- "Simple" calibration to frequency-average Sv based on pulse compression output is implemented but needs to be thoroughly tested.

- Rename subpackage `echopype.model` to `echopype.process`

- The new name better describes the subpackage's function to process data for further analysis
- Also rename class `EchoData` to `Process` to mirror the structure in `Convert` better.
- Importing using the old names will be deprecated in the next release.

- Overhaul converting multiple files with `combine_opt=True`

- If target format is netCDF, temporary files will be created and finally combined to a single netCDF. This is due to current restriction that xarray does not allow simply appending new data to an existing file.
- If target format is zarr, data in each file are unpacked and appended to the same output file.

- Allow reading Zarr into `Process` in addition to netCDF: thanks @lsetiawan!

- Add a logo!

Bug fixes
Expand Down

0 comments on commit e48f8f3

Please sign in to comment.