Tutorial 05.2 - PrimitiveConfig, primitive_config_wrapper, DeviceConfig, calculate_minimum_definitive_differences

Step 0: Setup the project and prepare the data

from pathlib import Path

import pydpeet as eet

We will use “ERROR” as the logging style for better readability of the notebook

eet.set_logging_style("ERROR")

standardized_data = eet.read(
    input_path=str(Path.cwd().parent.parent / "res" / "raw_data_from_cyclers" / "Cal_Ageing_Checkup1.xlsx"),
    config=eet.ReadConfig.Neware_8_0_0_516,
)

Step 1: Creating a custom PrimitiveConfig

A PrimitiveConfig contains the following parameters used by add_primitive_segments:

Hint: You can type in “eet.PrimitiveConfig.” to see all other availiable PrimitiveConfig in most IDEs

default_config = eet.PrimitiveConfig.DEFAULT

Hint: Use primitive_config_wrapper to create your own custom PrimitiveConfig that overwrites the standard values

primitive_config = eet.primitive_config_wrapper(
    segments_to_detect_config=[("Voltage[V]", 0.01), ("Current[A]", 0.01), ("Power[W]", 0.01)]
)

default_config.segments_to_detect_config

[('Voltage[V]', 0.0025), ('Current[A]', 0.0015), ('Power[W]', 0.004)]

primitive_config.segments_to_detect_config

[('Voltage[V]', 0.01), ('Current[A]', 0.01), ('Power[W]', 0.01)]

Step 2: Using a device config to create a custom PrimitiveConfig

Instead of setting the segments_to_detect_config directly you’re also able to use a device config with the following parameters:

# BASYTEC_CTS (list[float])
#    0.002,  # ACCURACY_VOLTAGE_SIGNAL
#    0.003,  # ACCURACY_CURRENT_SIGNAL
#    0.002,  # ACCURACY_VOLTAGE_MEASUREMENT
#    0.003,  # ACCURACY_CURRENT_MEASUREMENT
#    6,  # FS_VOLTAGE
#    5,  # FS_CURRENT

You can use calculate_minimum_definitive_differences to get the values calculated internally per standard

eet.calculate_minimum_definitive_differences(*eet.DeviceConfig.BASYTEC_CTS)

(0.024, 0.03)

Hint: You can type in “eet.DeviceConfig.” to see all other availiable DeviceConfig in most IDEs

primitive_config = eet.primitive_config_wrapper(
    threshold_dict=eet.DeviceConfig.BASYTEC_CTS,
    segments_to_detect_config=None,
    adjust_segments_config=None,
    thresholds_primitive_annotation=None,
)

primitive_config.segments_to_detect_config  # uses per standard half the calculate_minimum_definitive_differences to increase the sensitivity

[('Voltage[V]', 0.012), ('Current[A]', 0.015), ('Power[W]', 0.027)]

primitive_config.adjust_segments_config

[('Voltage[V]', 0.024), ('Current[A]', 0.03), ('Power[W]', 0.054)]

primitive_config.thresholds_primitive_annotation

{'V': 0.024, 'I': 0.03, 'P': 0.054}