2.2.1: patch release version

Patch release version: 2.2.1

This is a patch release (non-breaking) version of NeuroDSP, as part of the 2.X.X series.

Changelog:

Reverts a breaking change introduced in 2.2.0: neurodsp.utils.checks.check_param was deprecated and renamed to check_param_range, making 2.2.0 incompatible with bycycle 1.0.0. Since 2.2.0 was a minor, non-breaking release, check_param has been re-added and aliased to check_param_range. check_param should instead be fully deprecated at a future time, in 3.0.0, to ensure compatability across the 2.X.X version series.

2.2: minor version release

Minor release version: 2.2.0

This is a minor, non-breaking, release version of NeuroDSP, as part of the 2.X.X series.

Changelog:

Aperiodic

• Detrended Fluctuation Analysis (#167)
• IRASA (#212)
• Autocorrelation (#217)

Simulation

• Fractional Gaussian noise and fractional Brownian motion (#216)
• Burst detection bug fix (#220)
• Time series with defined spectral parameters (i.e. height, width, center) (#221)
• Time series with defined Lorentzian parameters (i.e. chi1, chi2, knee) (#222)
• Asymmetrical gaussian cycles (#228)
• Define bursts based on set durations (#239)
• Extrema phase shifting (i.e. trough-to-trough or peak-to-peak) (#247)
• Custom cycle support (#248)
• Cycle length fix (#250)
• Variable oscillations parameters (i.e. vary cycle simulation parameters on a cycle-by-cycle basis) (#252)
• One-sided asymmetry (#254)
• Simulate spikes of action potentials (#259)

Plotting

• 2d array plotting (time series: #246, spectra: #269)
• Labeling bug fix and improved tests (#255)
• Plotting saving updates (#258, #260)

Maintenance

• Deprecate increase_n argument of robust_hilbert (#215)
• Improved speed of multidim decorator (#264)
• Error for invalid transition bands (#267)

Documentation

• Tutorial for Morlet wavelets (#226)
• Tutorials and updates for lagged coherence and sliding window matching (#230)
• Tutorials for DFA, IRASA, and Autocorrelation (#231)

2.1: minor new version release

Minor release version: 2.1.0

This is a minor, non-breaking, release version of NeuroDSP, as part of the 2.X.X series.

Changelog:

• A technical audit of the code was done, which updates technical approaches, including in filtering, time-frequency, and spectral modules
• Documentation updates, including docstring examples & tutorial updates, including to be able to download example data from tutorials
• An update to plot management and styling, increaing customizability of generated plots
• Module organization, including re-organizing test file layout
• Updating management of the documentation site, and updating sphinx versions & materials
• Miscellaneous bug fixes

2.0: major new version release

This is a release of the NeuroDSP, to the v2 series, starting at 2.0.0.

WARNING: This is an API breaking update from the 1.X.X series.

ChangeLog:

• Major refactors of most of the code base, including splitting out many functions into subfunctions
• An update and revamp of the names / vocabulary used, in particular in the sim module.
• Reorganization of some code, including moving modules into their own folder, and grouping some things.
• Major additions include extending the plotting utilities, and adding decorators for data normalization and running all functionality across 2D arrays.

1.1.2: Final Major Update to v1

This is an update of the v1.X.X series (from 1.0.X to 1.1.X) with some refactors and extensions (but no breaking changes). This is the final planned update of this series, before an API breaking v2 release.

ChangeLog:

• Code refactors, including splitting up the organization of the filt, spectral and sim modules, and updates to internal variable naming schemes.
• Miscellaneous small bug fixes.
• Documentation updates, including updates and additions to the docsite and tutorials / examples.
• Project updates, including updates to the README, adding a CodeOfConduct, and adding the JOSS paper draft.

Note: the .2 minor version is just due to a quirk when uploading to PYPI - there is no 1.1.0 or 1.1.1.

1.0.0: Revamp of signal processing toolbox

This is a major new release version, the first of the 1.X.X series, and a breaking update from the 0.X.X series.

Several major API-breaking changes including:

• waveform shape analysis has moved to bycycle.
• enhanced features for simulating background aperiodic processes
• many bug fixes

0.3.1: Miscellaneous additions and bug fixes

• Add new simulation features
• Add a function to visualize burst detection in cycle-by-cycle analysis

0.3: Improvements and new simulation and burst detection modules

Many improvements have been made since the last release.

1. Module to detect if an oscillator is present in a signal (burst.py)
2. Module to simulate data with neural oscillations (sim.py)
3. Improvements to waveform shape analysis (shape/cyclefeatures.py)

Other updates included an updates SCV (spectral coefficient of variation) function, a dockerfile, updated documentation, and fixing a few miscellaneous bugs.

0.2: Add spectral and pac modules and misc bug fixes

This new release has modules to characterize the power spectrum and phase-amplitude coupling. Several improvements (and bug fixes) have been made to some of the existing methods, particularly in the shape and filtering modules.

0.1: Initial package with base tools

Includes tools for:

• filtering
• time-frequency analysis
• lagged coherence measure of rhythmicity
• characterizing the shape of oscillatory waveforms