system - SHOP documentation

iLab Assistant

The system singleton object is automatically created by SHOP and holds top-level information related to the SHOP run, such as execution times.


Input connections
Output connections
License	SHOP_OPEN
Release version	13.0.0.a

Attributes¶

Attribute	Data type	I/O	Required	Unit	Default	License	Version added	NaN allowed
cut_output_rhs	xy_array	Output	No	x: NOK and y: NOK	None/null	SHOP_SCENARIO_FUNCTIONALITY	13.0.0.a	No
sum_completed_iterations	int	Output	No	NO_UNIT	0	SHOP_OPEN	17.13.0	No
solver_computation_time	double_array	Output	No	SECOND	None/null	SHOP_OPEN	17.15.0	No
solver_interface_input_path	string	Input	No	STRING	Empty	SHOP_OPEN	17.16.0	No
model_building_time	double_array	Output	No	SECOND	None/null	SHOP_OPEN	17.17.0	No
result_processing_time	double_array	Output	No	SECOND	None/null	SHOP_OPEN	17.17.0	No
total_iteration_time	double_array	Output	No	SECOND	None/null	SHOP_OPEN	17.17.0	No
time_per_command	sy	Output	No	s: STRING and y: SECOND	None/null	SHOP_OPEN	17.17.0	No
physical_spill	double	Output	No	MM3	0.0	SHOP_OPEN	18.3.0	No
nonphysical_spill	double	Output	No	MM3	0.0	SHOP_OPEN	18.3.0	No

cut_output_rhs¶

Data type: xy_array. Unit: x: NOK and y: NOK.

Expected future income for the cuts generated by the model. The future incomes represent cuts in the same order as cut_output_coeffs_mm3 on reservoirs.

sum_completed_iterations¶

Data type: int. Unit: NO_UNIT.

The total number of full and incremental iterations that have been completed.

solver_computation_time¶

Data type: double_array. Unit: SECOND.

Computation time used in the external solver (CPLEX/Gurobi/OSI) for completed iterations.

solver_interface_input_path¶

Data type: string. Unit: STRING.

Manually specify where SHOP will look for the solver interface binary, see the documentation under ‘Environment variables’ to see where SHOP will search by default.

model_building_time¶

Data type: double_array. Unit: SECOND.

Computation time used for model building for each iteration.

result_processing_time¶

Data type: double_array. Unit: SECOND.

Computation time used for result processing for each iteration.

total_iteration_time¶

Data type: double_array. Unit: SECOND.

Total computation time for each iteration.

time_per_command¶

Data type: sy. Unit: s: STRING and y: SECOND.

Total computation time per command. The string value is the raw command string, and the y value is the computation time in seconds.

physical_spill¶

Data type: double. Unit: MM3.

The sum of river spill volume for the part of the spill that represents physical spill, i.e. the spill occurs when the water reaches max_vol of the upstream reservoir.

nonphysical_spill¶

Data type: double. Unit: MM3.

The sum of river spill volume for the part of the spill that represents non-physical spill, i.e. the spill occurs when the water does not reach max_vol of the upstream reservoir.