Skip to content

optimize_keys_func API Reference

geoloop.bin.SingleRunSim.optimize_keys_func

optimize_keys_func(
    x: NDArray[float64],
    optimize_keys: list[str],
    config: dict,
    copcrit: float,
    isample: int,
) -> float

Objective function used for parameter optimization.

Parameters:

Name Type Description Default
x ndarray

Current optimization parameter values.

required
optimize_keys list[str]

List of configuration keys to optimize for and identifying which config fields to modify.

required
config dict

Current configuration dictionary that is modified in-place.

required
copcrit float

Target COP value used in the optimization objective function.

required
isample int

Sample index for simulation.

required

Returns:

Type Description
float

Value of the objective function (to be minimized).