3.2.2

Updates since the last release:

• Citation now points to our JOSS Publication (#864)
• Additional fluence calculation in kit (#867)
• Fixed unit conversion (#869)
• Fixed tolerances used for delays in from_PyCMDS (#876)
• Trim now works with no outliers, and allows you to ignore the point itself when averaging (#886)
• New wt.close method to close all open WT objects in a particular python session (#887)
• Now uses expressions rather than natural name for axes stored in the file (#889)
• Data.moment now allows you to pass resultant=shape such that it can work with multidimensional axes (#883)
• Correction factor applied in from_PyCMDS for delay stages collected with errant constant (#897)
• Data.print_tree will now print scalar values, rather than the shape (#899)
• wt-tree entry point will no longer modify the file it is accessing (#898)

Deprecations:

• Data.downscale was removed to remove dependency on skimage (see #865, #863, #862). It is intended to be added back, however did not get enough need that the alternatives were fully fleshed out.

A full change list can be found here.

3.2.1 - JOSS Reviewed version

This is the version of WrightTools as reviewed by the Journal of Open Source Software.
The associated peer-reviewed paper can be found here.
The open review commentary can be found here

As such, this release is primarily documentation focused with few code improvements since the previous release.

Highlights of this release include:

• Quick2D now respects adding contours (#859)
• Collections and Data objects can now be created using multi-part posix paths (#858)
• Collections and Data objects can now be used as context managers, which close upon exiting (#846)
• wt.units.convert added as an alias of wt.units.converter (#849)
• Fixed a bug regarding using strings as parameters to prune (#854)
• Updates to ensure proper behavior due to deprecations in dependencies

We the maintainers extend our thanks to the JOSS reviewers/editors.

A full list of all closed issues and pull requests associated with this version can be found here.

3.2.0 - Documentation, moment, trim

One of the larger WrightTools releases:

• Dropped support for Python 3.5 -- Now 3.6+ only (#798)
• New method: Moment (see #786): Take the Nth moment of a channel along an axis
  • Deprecated "integrate" method of collapse, as moment handles this (#819)
• Use natural_name setter to rename groups within the underlying hdf5 file (#800)
• Fix bugs in chunkwise operations (#812)
• Improved parsing in from_PyCMDS (#816, #822)
• New method: trim (#829), Use statistical test in channels to remove outlier points
• Support for remote files in from_ functions (#801)

Far too many documentation improvements to list here, including making API easier to read, more examples, and improving our curated documentation on wright.tools.

This is also the version which is submitted for publication to JOSS.
You can follow the review here.

Full list of changes can be found here.

3.1.6 Prune, Cary, and Quick1D improvements

The headlining features of this release include:

• from_Cary will now read data files correctly where multiple objects have the same name
• Tweaks to how Quick1D presents data
  • Remove /chop000/
  • Add title with the data name
  • Add padding for ylim
• Improvements to set_fig_labels
  • Will now remove labels from axes
  • Can now be told a region to work on, rather than only the whole figure
• Data.prune method to remove unused variables and channels easily
• Continued improvements to documentation and examples

Full changelog can be found here.

3.1.5 Temperature and Gradient

Much of the work in this release was behind the scenes, but here are the headlining new features:

• Make interact2D more robust
• Ensure that data objects with constants open properly
• Fix units behavior when splitting and reading PyCMDS data files
• Add temperature units, allow Cary data files with temperature axes to be read in
• Gradient method of data objects

The full changelog can be seen here.

3.1.4 Plotting for lower ranked channels

The primary features of this release:

• Plotting functions like plot, pcolor, and contour now will plot channels e.g. 2D channels within a 3D data object
• Quick plotting methods now have lines and labels for constants

A full list of changes can be found here.

Happy π release

3.1.3 - Join and Constants

Major features include:

• Much improved joining of data sets.
• Addition of Constants, expressions which have a LaTeX formatted label including the mean value.
• Additional window functions in smooth1D.

A full list of closed issues and Merged pull requests can be found here.

3.1.2 - Split

Major features include:

• Implementation of split with WrightTools3 data objects
• Improved import of PyCMDS Data
• Improved import of spcm data
• Improved handling of complex dtype within collapse

A full list of closed issues and Merged pull requests can be found here.

3.1.1 - Data patches

Highlights of this release:

• wt-tree entry point
  • Allows for quick printing of the tree wt-tree data.wt5
• from_Solis method to create a data object
• Downscale method of data
• Kit methods for fluence calculations and SVD
• Interactive 2D plots for exploration of data objects with ndim >= 2
• pcolormesh method
• Additional bug fixes and code maintainability improvements

Full change log here

3.1.0 - cleanup

• Lots of internal cleanup to the codebase, formatting, and documentation.
  • Removed fit module entirely (was previously not imported by default anyway)
  • Removed unused artist classes
  • Documentation updated to better reflect current features
  • Now use black for code formatting
• Added __citation__ for our preferred citation for WrightTools
• Added support for pathlib objects
• Recovered Data.collapse method to lower dimensionality of data objects

Full list of changes can be found here