sunpeek.core_methods.dcam_lite_collective.main.run_energy_yield_check#

sunpeek.core_methods.dcam_lite_collective.main.run_energy_yield_check(array, eval_start=None, eval_end=None, reference_conditions_type=None, use_wind=None, settings=<sunpeek.core_methods.dcam_lite_collective.settings.DCAMYieldCheckSettings object>, on_strategy_error=StrategyErrorBehavior.skip)#

Run the D-CAM energy yield analysis (concept4 in MeQuSo project) on a given Array.

The analysis compares measured array yield with yield estimated from the D-CAM 2-N forward simulation. Strategy variants are selected from the requested reference-condition modes and wind-usage settings.

This function:
  • validates that time-series data exist

  • builds an algorithm instance with settings

  • executes all eligible strategies (reference conditions type × wind usage)

Parameters:
  • array (Array) – SunPeek array to analyze.

  • reference_conditions_type (Optional[List[Union[None, str, ReferenceConditionsType]]]) – Optional list of reference-condition modes to run. Values may be None, strings accepted by ReferenceConditionsType, or ReferenceConditionsType members. If omitted, all default modes are considered.

  • use_wind (Optional[List[Optional[bool]]]) – Optional list selecting whether wind speed is used during D-CAM data filtering. If omitted, both wind and no-wind variants are considered.

  • settings (DCAMYieldCheckSettings) –

    safety_uncertainty:

    Safety factor for uncertainty-related yield reduction.

    safety_others:

    Additional safety factor for other yield-reduction effects.

    n_discretization:

    Optional list of spatial discretization counts for the 2-N model.

    # Filtering and parameter conversion settings: min_interval_length:

    Minimum accepted operating interval length.

    pre_operation_length:

    Required pre-operation data length before an operating interval.

    max_gap_in_interval:

    Maximum allowed data gap inside an operating interval.

    cut_time_init_error:

    Duration trimmed from the beginning of each simulated interval to remove initialization effects.

    data_interpolation_method:

    Optional list of interpolation methods used when assembling D-CAM interval data.

    min_mf_spec:

    Minimum specific mass flow accepted by the data filter.

    min_te_amb:

    Minimum ambient temperature accepted by the data filter.

    max_ve_wind:

    Maximum wind speed accepted by the data filter.

    max_aoi:

    Maximum angle of incidence accepted by the data filter.

    # Reference conditions for collector parameter conversion 1N->2N ref_irradiance:

    Fixed irradiance reference condition for 1N-to-2N collector parameter conversion. If omitted, it is calculated from interval data.

    ref_deltaT_s_amb:

    Fixed solid-to-ambient temperature difference reference condition. If omitted, it is calculated from interval data.

    ref_fluid_heat_capacity:

    Fixed fluid heat-capacity reference condition. If omitted, it is calculated from interval data.

    ref_fluid_density:

    Fixed fluid-density reference condition. If omitted, it is calculated from interval data.

    ref_specific_mass_flow:

    Fixed specific mass-flow reference condition. If omitted, it is calculated from interval data.

    mock_simulation:

    If true, skip the forward solver and use a simple mock outlet temperature signal.

    solver_name:

    Name of the ODE solver used by the D-CAM forward simulation.

    solver_abstol:

    Absolute tolerance for the ODE solver.

    solver_reltol:

    Relative tolerance for the ODE solver.

    solver_dt0:

    Initial time step for the ODE solver.

    solver_max_steps:

    Maximum number of solver steps.

    approx_order:

    Spatial approximation order used in the D-CAM finite-difference model.

  • on_strategy_error (StrategyErrorBehavior) – Behavior when a strategy raises during execution.

Returns:

Algorithm result containing the selected strategy output, the strategy used, and calculation feedback.

Return type:

AlgoResult

Raises:

NoDataError – If the array plant has no uploaded or dataframe-backed time-series data.