Release/1.5.0

[S-Hanly]

Here is an initial draft of the release notes.

endaq-python 1.5.0 is the culmination of 4 months of hard work to round out the library for general-purpose shock and vibration data analysis and visualization. It contains many new functions, numerous bug fixes, better documentation, and improved testing coverage. All users are encouraged to upgrade to this new release.

New Features

• calc.fft.rolling_fft() to calculate FFTs across many different time segments, either evenly spaced or discretely defined
• calc.psd.rolling_psd() to calculate PSDs across many different time segments, either evenly spaced or discretely defined
• calc.psd.spectrogram() a wrapper around scipy.signal.spectrogram() for an easier interface when working with dataframes with multiple channels
• calc.rotation.quaternion_to_euler() to convert quaternion data to euler angles (this had been in a previous release but wasn't added to the __init__.py file or the docs)
• calc.shock.rolling_shock_spectrum() to calculate a shock spectrum across many different time segments, either evenly spaced or discretely defined
• calc.stats.shock_vibe_metrics() to calculate a variety of shock and vibration metrics from a time series, such as peak, RMS, RMS within frequency ranges, integrated velocity & displacement metrics and more, example included in docstring
• calc.stats.find_peaks() to find peak indexes from a time series based on the overall RMS or peak of the signal if an explicit threshold isn't defined, example included in the docstring
• calc.stats.rolling_metrics() to calculate shock & vibration metrics across many different time segments
• calc.utils.convert_units() to apply unit conversions to scalers or dataframes using the pint library
• ide.get_utc_offset() to find the UTC offset of an IDE file, this is used to also allow ide.to_pandas() to return datetime indexes with a defined or implied timezone
• plot.spectrum_over_time() to visualize the rolling spectrum function outputs and batch outputs as heatmaps, animations, waterfall & surface plots and more, includes some examples in the docs
• plot.pvss_on_4cp() to plot on shock spectrum on 4 coordinate plot paper which includes the diagonal lines to define displacement and acceleration, includes some examples in the docs
• plot.table_plot() to generate a plotly table figure from a dataframe, includes some examples in the docs
• plot.table_plot_from_ide() to summarize an IDE file into a plotly table figure, includes some examples in the docs

Fixes / Changes

• calc.fft.aggregate_fft() now defaults to overlap between segments of 50%
• calc.shock.shock_spectrum() now doesn't require a definition of the natural frequencies to calculate the response from, it will define these from other parameters that have default values
• calc.shock.shock_spectrum() will limit the calculation to max_time around the peak event, this is defaulted to 2 seconds but can be disabled by setting it to None
• calc.utils.resample() fixed a bug with datetimes and includes an index name in the returned dataframe
• `plot.get_map() fixed a bug with latitude and longitude definition, also added an example in the docs
• plot.octave_spectrum() updated to use plot.spectrum_over_time()
• plot.rolling_min_max_envelope() changed defaults to plot as bars and for a larger number of points, also added an example in the docs
• various other docs improvements and testing coverage expansion

[codecov-commenter]

Codecov Report

Merging #203 (b40668c) into main (a878efd) will increase coverage by 8.85%. The diff coverage is 90.09%.

@@            Coverage Diff             @@
##             main     #203      +/-   ##
==========================================
+ Coverage   61.74%   70.59%   +8.85%     
==========================================
  Files          34       34              
  Lines        2614     3095     +481     
==========================================
+ Hits         1614     2185     +571     
+ Misses       1000      910      -90     

Impacted Files	Coverage Δ
endaq/plot/dashboards.py	46.87% <ø> (+40.00%)	:arrow_up:
endaq/batch/analyzer.py	91.83% <40.00%> (-1.58%)	:arrow_down:
endaq/calc/psd.py	86.66% <78.65%> (-2.96%)	:arrow_down:
endaq/ide/info.py	86.18% <80.00%> (-1.82%)	:arrow_down:
endaq/plot/plots.py	67.54% <93.01%> (+51.31%)	:arrow_up:
endaq/calc/utils.py	89.18% <94.44%> (+3.82%)	:arrow_up:
endaq/calc/stats.py	93.84% <95.65%> (+12.59%)	:arrow_up:
endaq/calc/fft.py	72.14% <96.00%> (+7.43%)	:arrow_up:
endaq/calc/shock.py	89.20% <97.56%> (+2.06%)	:arrow_up:
endaq/__init__.py	100.00% <100.00%> (ø)
... and 9 more

:mega: Codecov can now indicate which changes are the most critical in Pull Requests. Learn more