Core

Optimizer

buzzard.core.optimizer.collectParametersToIdentify(config: dict) → Tuple[ndarray, list, list]

buzzard.core.optimizer.collectSimulations(config)

buzzard.core.optimizer.getOptimizationMethodAndOptions(config: dict) → Union[str, dict]

Extracts the optimization method and respective options from the input dictionary.

Parameters

config (dict) – Dictionary containing the information of the Buzzard input.

Return type

Union[str,dict]

buzzard.core.optimizer.getResidualForMultipleSimulations(params: ndarray) → float

buzzard.core.optimizer.runOptimization(config: dict) → OptimizeResult

Core function which executes parameter identification.

Parameters

config (dict) – Dictionary containing the information of the Buzzard input.

Return type

scipy.optimize.OptimizeResult

Identification Object

class buzzard.core.identification.Identification(name: str, values: dict)

Bases: object

The identification object stores information for one parameter which is defined to be optimized.

Parameters

• name (str) – Name of the parameter. Has to be equal to the placeholder in the simulation input files.

• values (dict) – Dictionary to define values for the parameter. Required keys are ‘start’, ‘min’, ‘max’ and ‘active’.

active_identifications = []

A list containing all active identification objects.

all_identifications = []

A list containing all identification objects.

checkInput(name: str, values: dict)

Input check for Identification object initialization

Simulation Object

class buzzard.core.simulation.Simulation(name, config)

Bases: object

The identification object stores information for one simulation for the optimization process.

Parameters

• name (str) – Name of the simulation.

• config (dict) – Dictionary which contains information about the simulation.

all_simulations = []

A list containing all simulations.

computeResidualForSingleDataSet(simX: ndarray, simY: ndarray, data: ndarray) → float

computeWeightedResidual(currParams: ndarray) → ndarray

Computes the error vector for the simulation wrt the given data.

Parameters

currParams (numpy.ndarray) – An array with the current parameters.

Returns

Array containing the errors between given data and simulation.

Return type

numpy.ndarray

interpolateSimulationResults(x: ndarray, y: ndarray) → interp1d

Interpolates simulation results taking into account decreasing x-data.

Parameters

• x (numpy.ndarray) – x-data for interpolation

• y (numpy.ndarray) – y-data for interpolation

Returns

interpolation of x and y

Return type

scipy.interpolate.interp1d

run(currParams: ndarray) → ndarray

Executes the simulation

Parameters

currParams (numpy.ndarray) – An array with the current parameters.

Returns

Result of the simulation (x-data, y-data).

Return type

Union[numpy.ndarray,numpy.ndarray]