Skip to content

Commit

Permalink
Update changelog for v3.0
Browse files Browse the repository at this point in the history
Also update .filtered with a deprecation warning
  • Loading branch information
jrudoler committed Nov 8, 2021
1 parent b5998d9 commit a6491da
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
6 changes: 4 additions & 2 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,22 @@ Changes

Version 3.0.0
-------------
**2021.11.03**
**2021.11.08**
Version 3.0 of PTSA is largely a cleanup release. Several deprecated features
have been removed and things have been reorganized.

What's New
^^^^^^^^^^
* Filter objects no longer accept a ``TimeSeries`` object as a positional argument. Rather, these are passed to the object's .filter method instead. This allows for reusing filters on multiple time series as well as adding filter pipeline capabilities.
* Added a class decorator to ``TimeSeries`` that coerces the return type of xarray methods to be ``TimeSeries`` rather than ``xarray.DataArray``.

* to_hdf and from_hdf now use xarray's recommended file saving method, netCDF. We use xarray built-ins to do I/O rather than in-house code via h5py.
* to_hdf and from_hdf now support pandas MultiIndexes as coordinates
Removals
^^^^^^^^

* ``TimeSeriesX`` backwards compatibility has been removed. Use ``TimeSeries``
instead.
* the .filtered method has been removed. Initialize a ButterworthFilter and use .filter_with() instead


Version 2.0.10
Expand Down
2 changes: 1 addition & 1 deletion ptsa/data/timeseries.py
Original file line number Diff line number Diff line change
Expand Up @@ -364,7 +364,7 @@ def filtered(self, freq_range, filt_type='stop', order=4):
A TimeSeries instance with the filtered data.
"""
warnings.warn("The filtered method is not very flexible. "
warnings.warn("The filtered method is not very flexible and will be deprecated in an upcoming release."
"Consider using filters in ptsa.data.filters instead.")
time_axis_index = get_axis_index(self, axis_name='time')
filtered_array = buttfilt(self.values, freq_range,
Expand Down

0 comments on commit a6491da

Please sign in to comment.