Skip to content

Release v0.3.0

Compare
Choose a tag to compare
@derb12 derb12 released this 08 Nov 17:35

0.3.0 (2020-11-08)

This is a minor version with new features, bug fixes, and documentation improvements.

Note: The output of the launch_main_gui function was changed to a single, dictionary output.

New Features

  • Validation of user-input in the GUIs now converts the string inputs into the desired
    data type during validation, rather than requiring further processing after validation.
    Updated all modules for this new change.
  • Added the ability to use constraints in the data validation function for user-inputs,
    allowing user-inputs to be bounded between two values.
  • Added functions to generate_raw_data.py to create data for pore size analysis (emulating
    the output of the ImageJ software when analyzing images), uniaxial tensile tests,
    and rheometry.
  • The plotting GUI now uses "raw_unicode_escape" encoding when saving data to a csv file.
    This has no impact on the data after reloading, but it makes any Unicode more readable
    in the csv file. The module still uses "utf-8" encoding as the default when loading csv
    files, but will fall back to "raw_unicode_escape" in the event "utf-8" encoding errors.

Bug Fixes

  • Fixed issue where an additional set of data entry column labels was erroneously created
    when using a SummaryCalculation object for summarizing data for a sample.
  • Fixed issue using sorted() with strings rather than integers when sorting the indices
    of datasets to be deleted when using the plotting GUI.
  • Fixed the naming of the standard error for parameters from peak fitting in the output
    Excel file from "standard deviation" to "standard error".

Other Changes

  • The output of the launch_main_gui function is now a single dictionary. This will allow potential
    changes to the output in later versions to not cause breaking changes.
  • The output of launch_main_gui now includes the ExcelWriter object used when saving to Excel.
    This allows access to the Excel file in python after running the launch_main_gui function, in
    case further processing is desired.
  • The peak_fitting_gui module now includes full coverage for the data validation of user-inputs
    for all events.

Documentation/Examples

  • Added DataSource objects to the use_main_gui.py example program for the three new raw data types.
    These analyses are more in-depth than the existing DataSource objects, and involve both
    CalculationFunction and SummaryFunction objects.
  • Changed the Changelog to group changes into categories rather than labelling each change with
    FEATURE, BUG, etc.