get_summary#

PeriodicControl.get_summary(params)#

Get the periodic control summary along with the evaluated scope for the provided parameters.

Parameters:
paramsPeriodicControlSummaryParams

Periodic control summary parameters.

Returns:
PeriodicControlSummaryResult

Return the PeriodicControlSummaryResult.

Return type:

PeriodicControlSummaryResult

Examples

>>> results = periodic_control.get_summary(prime.PeriodicControlSummaryParams(model=model))