optimize_forkeys API Reference

geoloop.bin.SingleRunSim.optimize_forkeys

optimize_forkeys(
    config: dict,
    copcrit: float,
    optimize_keys: list[str],
    optimize_bounds: list[tuple[float, float]],
    isample: int,
) -> tuple[Any, dict]

Optimizes selected configuration parameters based on a specified COP criterion.

Parameters:

Name	Type	Description	Default
`config`	`dict`	Configuration dictionary for a single sample, modified in-place.	required
`copcrit`	`float`	Target COP value used in the optimization objective function.	required
`optimize_keys`	`list[str]`	List of configuration keys to adjust during optimization and optimize for.	required
`optimize_bounds`	`list[tuple[float, float]]`	Upper and lower value bounds for each optimization key.	required
`isample`	`int`	Index of the sampled model run.	required

Returns:

Type	Description
`tuple`	First element is the optimizer result object (`scipy.optimize.OptimizeResult`). Second element is the updated config dictionary.