API-Referenz Übersicht

Detaillierte Dokumentation der Module, Klassen und Funktionen von PyADM1ODE_calibration.

Module

• Kalibrierung: Kern-Klassen für Initial- und Online-Kalibrierung.
• IO & Daten: Laden, Speichern und Validieren von Messdaten.
• Optimierung: Implementierte Algorithmen und Zielfunktionen.

pyadm1ode_calibration.calibration.Calibrator(plant, verbose=True)

Orchestration layer for calibration workflows.

Provides a simplified interface for running both initial and online calibrations on a plant model.

Parameters:

Name	Type	Description	Default
plant	Any	The PyADM1ODE plant model instance.	required
verbose	bool	Whether to enable verbose logging. Defaults to True.	True

Source code in pyadm1ode_calibration/calibration/__init__.py

def __init__(self, plant: Any, verbose: bool = True):
    self.plant = plant
    self.verbose = verbose
    self.initial_calibrator = InitialCalibrator(plant, verbose)
    self.online_calibrator = OnlineCalibrator(plant, verbose)

Functions

apply_calibration(result)

Apply calibration results to the plant model.

Parameters:

Name	Type	Description	Default
result	CalibrationResult	Result containing new parameters.	required

Source code in pyadm1ode_calibration/calibration/__init__.py

def apply_calibration(self, result: CalibrationResult) -> None:
    """
    Apply calibration results to the plant model.

    Args:
        result (CalibrationResult): Result containing new parameters.
    """
    self.online_calibrator.apply_calibration(result)

run_initial_calibration(measurements, parameters, **kwargs)

Run initial batch calibration from historical data.

Parameters:

Name	Type	Description	Default
measurements	MeasurementData	Historical measurement data.	required
parameters	List[str]	List of parameter names to calibrate.	required
**kwargs	Any	Additional settings for InitialCalibrator.	{}

Returns:

Name	Type	Description
CalibrationResult	CalibrationResult	Results of the calibration.

Source code in pyadm1ode_calibration/calibration/__init__.py

def run_initial_calibration(
    self, measurements: "MeasurementData", parameters: List[str], **kwargs: Any
) -> CalibrationResult:
    """
    Run initial batch calibration from historical data.

    Args:
        measurements: Historical measurement data.
        parameters: List of parameter names to calibrate.
        **kwargs: Additional settings for InitialCalibrator.

    Returns:
        CalibrationResult: Results of the calibration.
    """
    return self.initial_calibrator.calibrate(measurements, parameters, **kwargs)

run_online_calibration(measurements, parameters, **kwargs)

Run online re-calibration for real-time adjustments.

Parameters:

Name	Type	Description	Default
measurements	MeasurementData	Recent measurement data.	required
parameters	List[str]	List of parameter names to calibrate.	required
**kwargs	Any	Additional settings for OnlineCalibrator.	{}

Returns:

Name	Type	Description
CalibrationResult	CalibrationResult	Results of the calibration.

Source code in pyadm1ode_calibration/calibration/__init__.py

def run_online_calibration(
    self, measurements: "MeasurementData", parameters: List[str], **kwargs: Any
) -> CalibrationResult:
    """
    Run online re-calibration for real-time adjustments.

    Args:
        measurements: Recent measurement data.
        parameters: List of parameter names to calibrate.
        **kwargs: Additional settings for OnlineCalibrator.

    Returns:
        CalibrationResult: Results of the calibration.
    """
    return self.online_calibrator.calibrate(measurements, parameters, **kwargs)