Skip to content

v1.2.0

Choose a tag to compare

@lerdmann1601 lerdmann1601 released this 30 Jan 12:03
· 206 commits to main since this release

HERA

HERA is a robust MATLAB toolbox designed for the scientific benchmarking of clustered data. It offers hierarchical-compensatory ranking logic, advanced effect-size statistics, and automated reporting capabilities.

For more information please refer to the Readme and Project Documentation.

What's New in v1.2.0? (Feature & Stability Release)

This release introduces significant new modules for scientific validation ("Convergence Analysis") and massively improves the Python experience with smart type conversion.

📈 Scientific Validation: Convergence Analysis

  • New Module: Added a dedicated Convergence Analysis mode (HERA.start_ranking('convergence', 'true')) to validate the stability of default robust convergence parameters.
  • Simulation: Implements simulation loops to analyze how ranking, threshold and BCa confidence interval stability changes with different sample sizes and data distribution scenarios.
  • Reporting: Automatically generates detailed CSV logs and plots visualization of convergence behavior.

🐍 Python Integration 2.0

  • Smart Type Conversion: The Python wrapper now automatically detects and converts NumPy arrays and Pandas DataFrames/Series into MATLAB-compatible types. You can now pass your data directly to HERA without manual formatting!
  • Type Stubs (.pyi): Added type hinting files to provide better autocompletion and static analysis support in basic Python IDEs.
  • Return Values: Improved handling of return values, ensuring that MATLAB results are converted back to Python-friendly formats where possible.

📚 Documentation & Usability

  • GitHub Pages: Converted all documentation links to point directly to the GitHub Pages site for a better reading experience.
  • Contents.m: Added a standard MATLAB Contents.m file for better help integration within the MATLAB environment.
  • Documentation Overhaul: Updated README, Example_Analysis, and other guides to match the new version and folder structure.

🛠 Build & Workflow

  • Cleaner Builds: Improved build scripts (build_HERA_...) to automatically remove temporary files (__pycache__, .DS_Store) for smaller, cleaner distribution packages.
  • Zenodo DOI: Updated documentation and citation files to use the persistent Zenodo DOI, ensuring stable referencing across all versions.

Full Changelog: v1.1.2...v1.2.0