Release Notes

Version 1.34.1

Features Added

  • Added Python 3.12 support

Changes

  • Updated Allure table and plot utilities to use new pandas styling API (.map instead of .applymap).

  • API updates to avoid warnings and ensure compatibility with future pandas and numpy updates.

Version 1.34.0

Bugs Fixed

  • Automatic PDF report updates to improve visual aspect of Allure Tables

  • Type checking with numeric operation improved due to numpy updates.

Changes

  • Updates on requirements for Scipy, pandas, numpy and matplotlib.

  • Changed .values to .to_numpy() for better pandas compatibility

  • Updated pandas operations for improved performance

Deprecation

  • Licensing System:

    • Removed typhoon/license_typhoontest/ directory

    • Removed kernel.py and license validation

    • Removed test license files

    • Removed licensing dependencies from pyproject.toml

    • Removed licensing from tox.ini and tox_linux.ini

Version 1.34.0

Features Added

Changes

  • Following functions now raise TypeError when selected arguments are not of correct type:

    • get_capture_results

    • thd

    • find_all_slow

    • find_all

    • find_edges

    • is_constant

    • is_first_order

    • is_step

    • is_ramp

    • follows_reference

    • step_into

    • abc_to_alphabetagamma

    • alphabetagamma_to_abc

    • alpha_betagamma_to_dq0

    • dq0_to_alphabetagamma

    • abc_to_dq0

    • dq0_to_abc

    • abc_to_symmetrical_components

    • symmetrical_compoenents_to_abc

Version 1.33.0

Features Added

  • Upgrade to Pytest 8 for Python 3.10 (>=.6) and Python 3.11 (all versions).

Deprecation

  • Python 3.8 support.

Version 1.32.0

Bugs Fixed

  • Updated the Environment parameters on Allure report option

  • Fixed simple CSV report generation

Deprecation

  • Last Typhoontest API wheel support for Python 3.8.

Version 1.31.0

Deprecated

Version 1.30.0

Features Added

  • Option to disable the automatic Allure steps generated by the Typhoon APIs.

Changes

  • Packing of Typhoontest API had changed, to be compatible with new versions of Setuptools and pip.

  • Link for HIL API Documentation added on Typhoontest Documentation.

  • Existent options documented (--alluredir=DIR, --clean-alluredir, --open-allure, log_cli, --log-cli-level, --collect-only, --markers, -k, --keep-history).

Version 1.29.0

Bugs Fixed

  • typhoon.types.timedelta.Timdelta casting fixed to return typhoon.types.timedelta.Timdelta when a pandas.Timedelta is provided (indirectly fixing typhoon.test.signals.find function)

  • typhoon.test.signals.control package was reinserted on documentation

Version 1.28.0

Features Added

  • Python 3.11 support

  • Version number available through the Typhoontest modules (E.g. typhoon.test.__version__)

  • Allure environment info attached to PDF report

Changes

  • typhoon.test.IEC61000 package is released

    • The function are decorated, showing the usage on the Allure Report

    • Flicker is now called flickermeter and had code optimized

    • Power Quantities (Single and Three-Phase) modules reduced, now they returns a pandas.DataFrame instead of a tuple of pandas.DataFrames.

  • Docstring review with new examples

  • Requirements updated for Python 3.11 (Jinja, tables, pandas, bokeh, and more)

  • API fixes to support pandas==2.0.3

Bugs Fixed

  • Grid Fault function (typhoon.test.sources.grid_fault function) documentation

  • Absolute time (absolute_time) parameter for typhoon.test.capture.get_capture_results function fixed to consider executeAt waiting time.

Version 1.27.0

Features Added

  • ABC to Zero, Positive and Negative sequence (Symmetrical Components) function

  • Inverse ABC to Zero, Positive and Negative sequence function

Changes

  • typhoon.types.timedelta.Timedelta floating point error fixed.

Bugs Fixed

  • Automatic PDF Report issue fixed: Unable in some test cases to find the figures to add in the report.

Version 1.26.0

Features Added

Changes

  • pluggy=>1.0.0 temporally not compatible with Typhoontest, version used ==0.13.1.

  • Pytest version upgraded, currently using the version ==7.2.0.

Bugs Fixed

  • Fixing the DC component of typhoon.test.harmonic.frequency_content function.

  • Fixed new matplotlib versions compatibility with Typhoontest.

Deprecated

  • Aliases from the listed classes and functions was removed:

    • typhoon.test.capture module

      • read function

      • wait_until function

    • typhoon.test.ranges module

      • around function

    • typhoon.test.signals module

      • find function

    • typhoon.test.sources module

      • get_phasor_3ph function

      • change_grid function

      • get_pv_mpp function

    • typhoon.types.phasors module

      • Phasor class

      • Phasors3ph class

Version 1.25.0

Features Added

  • Parameters on Automatic PDF report

Changes

  • matplotlib>=3.6.x temporally not compatible with Typhoontest

Bugs Fixed

  • Automatic PDF report generation for some test session cases

Version 1.24.0

Bugs Fixed

  • Some dependencies for machines with no Microsoft C++ Tools installed

  • Issue with small timestamp captures on dataframes

Version 1.23.0

Features Added

  • Allure tables into Automatic PDF report generated

  • New options added to pytest (vdev, vcfg, ethdev, discovery_ip, fw, simple-report)

  • Single-Phase SOGI PLL added for frequency measurement

  • typhoon.test.signals.control Package documentation

  • typhoon.types.timedelta.Timedelta documentation

  • Sub-step Allure plots into Automatic PDF report generated

  • Automatic PDF report generated test

Changes

  • Pytest custom option documented

Bugs Fixed

  • function signal_frequency_zc - Average value offset issue

Version 1.22.0

Changes

  • Requirements updated

Bugs Fixed

  • AnalysisResult class

  • Files for wheels generation

Version 1.21.0

Features Added

  • Support for Python 3.10 in both platforms (Windows and Linux)

  • PDF Automatic Generation options and documentation

  • COMTRADE read_cff function

Bugs Fixed

  • Documentation and long description upgraded

  • Patch for datetime.total_seconds and pandas.DataFrame slicing

Changes

  • Dependencies, API and tests to fit Python 3.10 requirements

  • Tables package from extra to permanent requirement

Deprecated

  • Support for Python 3.6 and 3.7

Version 1.20.1

Features Added

  • lz4==3.1.3 third-part dependency

Bugs Fixed

  • Fixed the issue of plots containing signals from previous plots.

  • Further improvements on matplotlib memory leakage.

  • Documentation for stepinfo function

Version 1.20.0

Bugs Fixed

Version 1.19.0

Deprecated

  • Test executor from Typhoontest API

Version 1.18.1

Bugs Fixed

  • Pytest dependency issues

  • THD calculation considering fundamental float values

Features Added

  • Decorators for Analysis plot with new interactive plots option

  • Integrator Component using Cython

Version 1.18.0

Features Added

  • new command-line arguments:

    • --analysis-plot-type to control report plot attachment type over test run

    • --analysis-plot-on-fail-only to control if plot attachment will be added only on test failure

  • report_plot dictionary argument to override behaviour specified by --analysis-plot-type and --analysis-plot-on-fail-only

Bugs Fixed

  • typhoon.test.harmonic.thd added new argument frequency_tol. Solves frequency precision issue.

Version 1.17.0

Features Added

  • typhoon.test.capture.read_mdf function to import exported mdf capture files as typhoontest DataFrame

Bugs Fixed

  • typhoon.test.capture.read function issue for getting signals in multihil models

Version 1.16.0

Features Added

  • initial_value argument in is_ramp and assert_is_ramp functions

  • butterworth filters functions in typhoon.test.signals.filtering

    • low_pass_filter

    • high_pass_filter

    • band_pass_filter

    • band_Stop_filter

Bugs Fixed

  • add hash method to typhoon.types.timedelta.Timedelta class to fix its hashability

  • fix timedelta rounding imprecision which was creating asynchronous sample steps

  • fix wait_until which measured interval between signal reads with real time, instead of simulation time

  • fix typhoon.test.signals.is_step issue with plotting reference_signal when from_value is not

Version 1.15.0

Bugs Fixed

  • compatibility with pandas>=1.0.5

  • allure tables: fixed an error to apply one of the available colormaps.

  • typhoon.test.sources.get_pv_mpp - issue with inverted current and voltage value

Features Added

  • allure tables: added a new color scheme based on a center value.

  • typhoon.types.timedelta.Timedelta - possibility to use relational with castable numbers/strings

Version 1.14.1

Bugs Fixed

  • fixed issue with importing tables package

Version 1.14.0

Features Added

  • three_phase_power function in typhoon.test.power package

  • moving_average function in typhoon.test.signals.filtering package

  • typhoon.test.reporting.tables package with functions for attaching html tables to allure report:

    • attach_table

    • attach_table_custom_colormap

    • attach_table_custom_colormap_by_column

    • text_style

  • typhoon.test.reporting.messages package for adding messages to allure report:

    • report_message

    • report_step

  • typhoon.test.reporting.figures.attach_figure function for adding matplotlib figure to allure report

  • ‘mode’ argument to typhoon.test.harmonic.thd function to select one of three modes of calculation:

    • with multiple harmonics only

    • with interharmonics in addition to multiples

    • with all available frequencies

Version 1.13.0

Bugs Fixed

  • StepInfo: If the signal never leaves the settling time region, it returns 0s

Features Added

  • typhoon.test.capture.merge_dataframes function for merging two dataframes

Version 1.12.1

Bugs Fixed

  • StepInfo:

    • Absolute threshold for settling time was swapping values

    • ‘settling_time_threshold’ is set to None when ‘settling_time_threshold_abs’ is defined

    • Stretched plots after using df-plot are now fixed

Version 1.12.0

Features Added

  • --report-plots pytest command line argument to control level of allure report plot attachments

Bugs Fixed

  • fixed all functions behaviour with time_tol argument

  • fixed couple bug and code refactoring

  • fixed plot attachments not to include user plots from test

Note

Typhoontest version 1.12.0 cannot work with Typhoon HIL Control Center versions older then 2020.2

Version 1.11.1

Feature Added

  • Support for global license folder definition

Version 1.11.0

Features Added

  • --keep-history command-line option which adds previous results trend graph in allure report

  • functions for reading exported data from typhoon capture:

    • read_hdf - for reading data exported in .h5 files;

    • read_csv - for reading data exported in .csv files;

    • read_mat - for reading data exported in .mat files;

    • read_tdms - for reading data exported in .tdms files;

Bugs Fixed

  • find_edges function fix - it was detecting edges one step before edge really occurs

Changes

  • step_info

    • parameter settling_time_threshold was set as a gain, now it is %.

    • now it is possible to define the starting time for evaluating a signal

    • now it is also possible to define the settling time threshold as absolute value

  • window_rms: assume_previous_data argument is added, which eliminates starting transient in result

Version 1.10.2

Features Added

  • shell script is created for opening allure reports on linux platforms

  • typhoontest became compatible with new typhoon software licencing frame

Version 1.10.1

Bugs Fixed

  • allure-pytest version downgraded to 2.6.2 because of the report opening issue

Version 1.10.0

Bugs Fixed

  • allure-html directory with standalone html report is automatically generated if --alluredir command line argument is specified

  • window_rms now computes the exact frequencies if possible for a given signal.

Version 1.9.0

Bugs Fixed

  • Updated pandas monkey patching code to avoid exceptions with pandas.compat

Features Added

  • Typhoontest library became linux compatible

  • Showing assertion results in allure report using pytest_assertion_pass (requires pytest > 5).

  • Step info function.

  • Function grid_fault for creating any type of grid faults on voltage sources.

Changes

  • Significantly improved performance of window_rms and is_step functions.

Version 1.8.0

Changes

  • TYPHOON environment variable is not used anymore for license and opening allure report.

Version 1.7.1

Bugs Fixed

  • Issue with time follows_reference function when sinusoidal signals are tested.

  • during arguments for TyphoonTest functions are now working with plain time strings.

  • TyphoonTest IDE collects items only at the end of test collection phase to avoid reporting wrong test order.

Version 1.7.0

Bugs Fixed

  • Fixed path for license (new filesystem convection).

  • TyphoonTest will not send any data to TyphoonTest IDE if --msg_proxy_path arg is not sent.

Version 1.6.0

Features Added

  • Time tolerance added to analysis functions.

Version 1.5.0

Bugs Fixed

  • Error with max_frequency in frequency_content function.

  • Error in follows_reference function if during argument is used.

Features Added

  • Shorthand names for pytest testing concepts.

  • Parameters accept ASCII tables.

  • full-cycle mode in signal_frequency_zc function - mode in which every second zero-crossing is detected.

Changes

  • abc_to_alphabetagamaa and alphabetagamma_to_abc functions have argument alignment for choosing which axis is aligned with a-axis from abc frame

Version 1.4.1

Bugs Fixed

  • capture variable in typhoon.test would shadow typhoon.test.capture submodule

  • fixed exception in TyphoonTest IDE Test Explorer related to test classes

Version 1.4.0

Changes

  • All functions with during argument refactored to significantly decrease their execution time

Bugs Fixed

  • Fixed parsing for pytest Instance and Class nodes while collecting tests.

  • Fixed communication bug with TyphoonTest IDE that would make pytest hang at the end of test run.

  • Fixed find_edges function bug - now it detects bug if it happens at first sample.

  • Fixed signal_frequency_zc function - nan values removed before the first zero-crossing moment

Features Added

  • is_first_order function

Version 1.3.0

Features Added

  • TyphoonTest IDE now separates between selected and deselected tests.

Version 1.2.1

Bugs Fixed

  • Compatibility with Python 2.7 and TyphoonTest IDE.

  • Fixed communication bug with TyphoonTest IDE that would make pytest hang at the end of test run.

Version 1.2.0

Features Added

  • reference frame transformation functions:

    • abc_to_alphabetagamma

    • alphabetagamma_to_abc

    • alphabetagamma_to_dq0

    • dq0_to_alphabetagamma

    • abc_to_dq0

    • dq0_to_abc

  • harmonic.signal_frequency_zc function

  • signals.find_all function.

  • signals.find_edges function.

  • rms.window_rms is refactored to run faster.

  • Function to execute old Test Executor tests.

  • Integration with TyphoonTest IDE

Changes

  • Refactored follows_reference function so it works faster

  • Open report.cmd file is now created at the beginning of tests, allowing to see results if test run is interrupted.

Bugs Fixed

  • capture.wait now also works with anything that can be convertible to timedelta.

Version 1.1.1

Bugs Fixed

  • Problem with opening Allure reports.

Version 1.1.0

Changes

  • Library now depends on Typhoon Control Center with proper TyphoonTest license activated.

  • Allure binaries are now packed with Typhoon Control Center instead of inside the wheel file.

  • Using Typhoon portable JRE for Allure reports.

  • Not using typhoon_report path script anymore. Using python -m typhoon.allure_report instead.

  • open_report.cmd files might have to be changed to take this into account.

Version 1.0.2

Bugs Fixed

  • Regression with typhoon.test.utils.capture_plot function, saving all files in the root folder.

Version 1.0.1

Bugs Fixed

  • Bug with typhoon.test.utils.capture_plot function, saving all signals with the same file name

Version 1.0.0

Features Added

  • Full compatibility for Python 2.7

Changes

  • typhoon.simple is now typhoon.test.capture

  • typhoon.grid is now typhoon.test.sources

Bugs Fixed

  • Bug when saving Analysis plots to file

  • Bugs with slicing using timedeltas

  • Representation for percentages smaller than 1% in ranges.around function.

  • Steps don’t show too much information anymore.

  • AttributeError with allure.log function.

  • Bug with tolerances for negative values.

  • Bug with analysis functions if during argument is single value

Version 0.3.1

Bugs Fixed

  • Internal error fixed

Version 0.3.0

Changes

  • Wait functions all return time.

Version 0.2.0

  • Last backwards-compatible version.