HYLOA - Documentation

Welcome to the official documentation of HYsteresis LOop Analyzer, a software for analyzing hysteresis loops.

Logo di hyloa

Documentation index:

Contents

What is HYLOA?

HYLOA is a Python package designed to analyze hysteresis loops with an intuitive graphical interface.

πŸ“Œ Main features:

  • πŸ“Š Data display: Loading and displaying hysteresis loops.

  • πŸ”§ Analysis tools: Filters, normalization, curve fitting and more.

  • πŸ–₯ User-friendly graphical interface based on PyQt5.

How to get started?

To install the package:

  1. Go to:

    https://github.com/Francesco-Zeno-Costanzo/hyloa/releases

  2. Download the file:

    hyloa-<version>-py3-none-any.whl

  3. Open a terminal in the folder where the wheel was downloaded.

  4. Install it with:

    python -m pip install hyloa-<version>-py3-none-any.whl

Replace <version> with the actual release version.

To launch the graphical interface:

hyloa

Windows users - quick launch:

If you’re on Windows and prefer not to use the terminal, simply:

  1. Download:

    • hyloa-<version>-py3-none-any.whl

    • setup.bat

  2. Double-click setup.bat to run the installer.

This will automatically install everything you need and create a desktop shortcut to launch the GUI.

Feedback

If you find a bug or have suggestions, open an issue at [GitHub](https://github.com/Francesco-Zeno-Costanzo/hyloa).