"""
Statkraft Energy Market short term model Shop adapter
"""
from __future__ import annotations
from builtins import list as ShopCommandList
import collections.abc
import shyft.energy_market.stm
from shyft.energy_market.stm import ShopCommand
import shyft.time_series
import typing
__all__ = ['ShopCommand', 'ShopCommandList', 'ShopCommander', 'ShopSystem', 'Status', 'busbar_power_deficit_url', 'busbar_power_excess_url', 'gate_ramp_cost_url', 'global_settings_scale_bp_curves_by_best_point_mc_url', 'market_load_price_url', 'power_plant_ramping_steps_direction_url', 'power_plant_schedule_penalty_cost_url', 'river_discharge_result_downstream_url', 'shop_api_version', 'shyft_with_shop', 'transmission_line_max_backward_flow_url', 'transmission_line_n_segments_url']
[docs]
class ShopCommander:
"""
A shop commander, utility for sending individual commands to the shop core.
"""
@staticmethod
def _pybind11_conduit_v1_(*args, **kwargs):
...
[docs]
def execute(self, command: shyft.energy_market.stm.ShopCommand) -> None:
"""
Execute command object.
"""
[docs]
def execute_string(self, command_string: str) -> None:
"""
Execute command string.
"""
[docs]
def executed(self) -> list[shyft.energy_market.stm.ShopCommand]:
"""
Get executed commands as objects.
"""
[docs]
def executed_strings(self) -> list[str]:
"""
Get executed commands as strings.
"""
@typing.overload
def log_file(self) -> None:
"""
Shop command string 'log file'.
"""
@typing.overload
def log_file(self, filename: str) -> None:
"""
Shop command string 'log file <filename>'.
"""
[docs]
def log_file_lp(self, filename: str) -> None:
"""
Shop command string 'log file /lp <filename>'.
"""
[docs]
def penalty_cost_all(self, value: typing.SupportsFloat | typing.SupportsIndex) -> None:
"""
Shop command string 'penalty cost /all <value>'.
"""
[docs]
def penalty_cost_discharge(self, value: typing.SupportsFloat | typing.SupportsIndex) -> None:
"""
Shop command string 'penalty cost /discharge <value>'.
"""
[docs]
def penalty_cost_gate_ramping(self, value: typing.SupportsFloat | typing.SupportsIndex) -> None:
"""
Shop command string 'penalty cost /gate /ramping <value>'.
"""
[docs]
def penalty_cost_load(self, value: typing.SupportsFloat | typing.SupportsIndex) -> None:
"""
Shop command string 'penalty cost /load <value>'.
"""
[docs]
def penalty_cost_overflow(self, value: typing.SupportsFloat | typing.SupportsIndex) -> None:
"""
Shop command string 'penalty cost /overflow <value>'.
"""
[docs]
def penalty_cost_overflow_time_adjust(self, value: typing.SupportsFloat | typing.SupportsIndex) -> None:
"""
Shop command string 'penalty cost /overflow_time_adjust <value>'.
"""
[docs]
def penalty_cost_powerlimit(self, value: typing.SupportsFloat | typing.SupportsIndex) -> None:
"""
Shop command string 'penalty cost /powerlimit <value>'.
"""
[docs]
def penalty_cost_reserve(self, value: typing.SupportsFloat | typing.SupportsIndex) -> None:
"""
Shop command string 'penalty cost /reserve <value>'.
"""
[docs]
def penalty_cost_reservoir_endpoint(self, value: typing.SupportsFloat | typing.SupportsIndex) -> None:
"""
Shop command string 'penalty cost /reservoir /endpoint <value>'.
"""
[docs]
def penalty_cost_reservoir_ramping(self, value: typing.SupportsFloat | typing.SupportsIndex) -> None:
"""
Shop command string 'penalty cost /reservoir /ramping <value>'.
"""
[docs]
def penalty_cost_soft_p_penalty(self, value: typing.SupportsFloat | typing.SupportsIndex) -> None:
"""
Shop command string 'penalty cost /soft_p_penalty <value>'.
"""
[docs]
def penalty_cost_soft_q_penalty(self, value: typing.SupportsFloat | typing.SupportsIndex) -> None:
"""
Shop command string 'penalty cost /soft_q_penalty <value>'.
"""
[docs]
def penalty_flag_all(self, on: bool) -> None:
"""
Shop command string 'penalty flag /all /on|/off'.
"""
[docs]
def penalty_flag_discharge(self, on: bool) -> None:
"""
Shop command string 'penalty flag /on|/off /discharge'.
"""
[docs]
def penalty_flag_gate_max_q_con(self, on: bool) -> None:
"""
Shop command string 'penalty flag /on|/off /gate /max_q_con'.
"""
[docs]
def penalty_flag_gate_min_q_con(self, on: bool) -> None:
"""
Shop command string 'penalty flag /on|/off /gate /min_q_con'.
"""
[docs]
def penalty_flag_gate_ramping(self, on: bool) -> None:
"""
Shop command string 'penalty flag /on|/off /gate /ramping'.
"""
[docs]
def penalty_flag_load(self, on: bool) -> None:
"""
Shop command string 'penalty flag /on|/off /load'.
"""
[docs]
def penalty_flag_plant_max_p_con(self, on: bool) -> None:
"""
Shop command string 'penalty flag /on|/off /plant /max_p_con'.
"""
[docs]
def penalty_flag_plant_max_q_con(self, on: bool) -> None:
"""
Shop command string 'penalty flag /on|/off /plant /max_q_con'.
"""
[docs]
def penalty_flag_plant_min_p_con(self, on: bool) -> None:
"""
Shop command string 'penalty flag /on|/off /plant /min_p_con'.
"""
[docs]
def penalty_flag_plant_min_q_con(self, on: bool) -> None:
"""
Shop command string 'penalty flag /on|/off /plant /min_q_con'.
"""
[docs]
def penalty_flag_plant_schedule(self, on: bool) -> None:
"""
Shop command string 'penalty flag /on|/off /plant /schedule'.
"""
[docs]
def penalty_flag_powerlimit(self, on: bool) -> None:
"""
Shop command string 'penalty flag /on|/off /powerlimit'.
"""
[docs]
def penalty_flag_reservoir_endpoint(self, on: bool) -> None:
"""
Shop command string 'penalty flag /on|/off /reservoir /endpoint'.
"""
[docs]
def penalty_flag_reservoir_ramping(self, on: bool) -> None:
"""
Shop command string 'penalty flag /on|/off /reservoir /ramping'.
"""
[docs]
def print_bp_curves(self) -> None:
"""
Shop command string 'print bp_curves'.
"""
[docs]
def print_bp_curves_all_combinations(self) -> None:
"""
Shop command string 'print bp_curves /all_combinations'.
"""
[docs]
def print_bp_curves_current_combination(self) -> None:
"""
Shop command string 'print bp_curves /current_combination'.
"""
[docs]
def print_bp_curves_discharge(self) -> None:
"""
Shop command string 'print bp_curves /discharge'.
"""
[docs]
def print_bp_curves_dyn_points(self) -> None:
"""
Shop command string 'print bp_curves /dyn_points'.
"""
[docs]
def print_bp_curves_from_zero(self) -> None:
"""
Shop command string 'print bp_curves /from_zero'.
"""
[docs]
def print_bp_curves_market_ref_mc(self) -> None:
"""
Shop command string 'print bp_curves /market_ref_mc'.
"""
[docs]
def print_bp_curves_no_vertical_step(self) -> None:
"""
Shop command string 'print bp_curves /no_vertical_step'.
"""
[docs]
def print_bp_curves_old_points(self) -> None:
"""
Shop command string 'print bp_curves /old_points'.
"""
[docs]
def print_bp_curves_operation(self) -> None:
"""
Shop command string 'print bp_curves /operation'.
"""
[docs]
def print_bp_curves_production(self) -> None:
"""
Shop command string 'print bp_curves /production'.
"""
[docs]
def print_mc_curves(self, filename: str) -> None:
"""
Shop command string 'print mc_curves <filename>'.
"""
[docs]
def print_mc_curves_down(self, filename: str) -> None:
"""
Shop command string 'print mc_curves /down <filename>'.
"""
[docs]
def print_mc_curves_down_mod(self, filename: str) -> None:
"""
Shop command string 'print mc_curves /down /mod <filename>'.
"""
[docs]
def print_mc_curves_down_pq(self, filename: str) -> None:
"""
Shop command string 'print mc_curves /down /pq <filename>'.
"""
[docs]
def print_mc_curves_down_pq_mod(self, filename: str) -> None:
"""
Shop command string 'print mc_curves /down /pq /mod <filename>'.
"""
[docs]
def print_mc_curves_mod(self, filename: str) -> None:
"""
Shop command string 'print mc_curves /mod <filename>'.
"""
[docs]
def print_mc_curves_pq(self, filename: str) -> None:
"""
Shop command string 'print mc_curves /pq <filename>'.
"""
[docs]
def print_mc_curves_pq_mod(self, filename: str) -> None:
"""
Shop command string 'print mc_curves /pq /mod <filename>'.
"""
[docs]
def print_mc_curves_up(self, filename: str) -> None:
"""
Shop command string 'print mc_curves /up <filename>'.
"""
[docs]
def print_mc_curves_up_down(self, filename: str) -> None:
"""
Shop command string 'print mc_curves /up /down <filename>'.
"""
[docs]
def print_mc_curves_up_down_mod(self, filename: str) -> None:
"""
Shop command string 'print mc_curves /up /down /mod <filename>'.
"""
[docs]
def print_mc_curves_up_down_pq(self, filename: str) -> None:
"""
Shop command string 'print mc_curves /up /down /pq <filename>'.
"""
[docs]
def print_mc_curves_up_down_pq_mod(self, filename: str) -> None:
"""
Shop command string 'print mc_curves /up /down /pq /mod <filename>'.
"""
[docs]
def print_mc_curves_up_mod(self, filename: str) -> None:
"""
Shop command string 'print mc_curves /up /mod <filename>'.
"""
[docs]
def print_mc_curves_up_pq(self, filename: str) -> None:
"""
Shop command string 'print mc_curves /up /pq <filename>'.
"""
[docs]
def print_mc_curves_up_pq_mod(self, filename: str) -> None:
"""
Shop command string 'print mc_curves /up /pq /mod <filename>'.
"""
[docs]
def print_model(self, filename: str) -> None:
"""
Shop command string 'print model <filename>'.
"""
@typing.overload
def print_pqcurves_all(self) -> None:
"""
Shop command string 'print pqcurves /all'.
"""
@typing.overload
def print_pqcurves_all(self, filename: str) -> None:
"""
Shop command string 'print pqcurves /all <filename>'.
"""
@typing.overload
def print_pqcurves_convex(self) -> None:
"""
Shop command string 'print pqcurves /convex'.
"""
@typing.overload
def print_pqcurves_convex(self, filename: str) -> None:
"""
Shop command string 'print pqcurves /convex <filename>'.
"""
@typing.overload
def print_pqcurves_final(self) -> None:
"""
Shop command string 'print pqcurves /final'.
"""
@typing.overload
def print_pqcurves_final(self, filename: str) -> None:
"""
Shop command string 'print pqcurves /final <filename>'.
"""
@typing.overload
def print_pqcurves_original(self) -> None:
"""
Shop command string 'print pqcurves /original'.
"""
@typing.overload
def print_pqcurves_original(self, filename: str) -> None:
"""
Shop command string 'print pqcurves /original <filename>'.
"""
[docs]
def return_scenario_result_table(self, filename: str) -> None:
"""
Shop command string 'return scenario_result_table <filename>'.
"""
[docs]
def return_shopsimres(self, filename: str) -> None:
"""
Shop command string 'return shopsimres <filename>'.
"""
[docs]
def return_shopsimres_gen(self, filename: str) -> None:
"""
Shop command string 'return shopsimres /gen <filename>'.
"""
[docs]
def return_simres(self, filename: str) -> None:
"""
Shop command string 'return simres <filename>'.
"""
[docs]
def return_simres_gen(self, filename: str) -> None:
"""
Shop command string 'return simres /gen <filename>'.
"""
[docs]
def save_pq_curves(self, on: bool) -> None:
"""
Shop command string 'save pq_curves /on|/off'.
"""
[docs]
def save_series(self, filename: str) -> None:
"""
Shop command string 'save series <filename>'.
"""
[docs]
def save_shopsimseries(self, filename: str) -> None:
"""
Shop command string 'save shopsimseries <filename>'.
"""
[docs]
def save_tunnelloss(self) -> None:
"""
Shop command string 'save tunnelloss'.
"""
[docs]
def save_xmlseries(self, filename: str) -> None:
"""
Shop command string 'save xmlseries <filename>'.
"""
[docs]
def save_xmlshopsimseries(self, filename: str) -> None:
"""
Shop command string 'save xmlshopsimseries <filename>'.
"""
[docs]
def set_bypass_loss(self, on: bool) -> None:
"""
Shop command string 'set bypass_loss /on|/off'.
"""
[docs]
def set_capacity_all(self, value: typing.SupportsFloat | typing.SupportsIndex) -> None:
"""
Shop command string 'set capacity /all <value>'.
"""
[docs]
def set_capacity_bypass(self, value: typing.SupportsFloat | typing.SupportsIndex) -> None:
"""
Shop command string 'set capacity /bypass <value>'.
"""
[docs]
def set_capacity_gate(self, value: typing.SupportsFloat | typing.SupportsIndex) -> None:
"""
Shop command string 'set capacity /gate <value>'.
"""
[docs]
def set_capacity_spill(self, value: typing.SupportsFloat | typing.SupportsIndex) -> None:
"""
Shop command string 'set capacity /spill <value>'.
"""
[docs]
def set_code_full(self) -> None:
"""
Shop command string 'set code /full'.
"""
[docs]
def set_code_head(self) -> None:
"""
Shop command string 'set code /head'.
"""
[docs]
def set_code_incremental(self) -> None:
"""
Shop command string 'set code /incremental'.
"""
[docs]
def set_com_dec_period(self, value: typing.SupportsInt | typing.SupportsIndex) -> None:
"""
Shop command string 'set com_dec_period <value>'.
"""
[docs]
def set_droop_discretization_limit(self, value: typing.SupportsFloat | typing.SupportsIndex) -> None:
"""
Shop command string 'set droop_discretization_limit <value>'.
"""
[docs]
def set_dyn_flex_mip(self, value: typing.SupportsInt | typing.SupportsIndex) -> None:
"""
Shop command string 'set dyn_flex_mip <value>'.
"""
[docs]
def set_dyn_seg_incr(self) -> None:
"""
Shop command string 'set dyn_seg /incr'.
"""
[docs]
def set_dyn_seg_mip(self) -> None:
"""
Shop command string 'set dyn_seg /mip'.
"""
[docs]
def set_dyn_seg_on(self) -> None:
"""
Shop command string 'set dyn_seg /on'.
"""
[docs]
def set_fcr_d_band(self, value: typing.SupportsFloat | typing.SupportsIndex) -> None:
"""
Shop command string 'set fcr_d_band <value>'.
"""
[docs]
def set_fcr_n_band(self, value: typing.SupportsFloat | typing.SupportsIndex) -> None:
"""
Shop command string 'set fcr_n_band <value>'.
"""
[docs]
def set_fcr_n_equality(self, value: typing.SupportsInt | typing.SupportsIndex) -> None:
"""
Shop command string 'set fcr_n_equality <value>'.
"""
[docs]
def set_gen_turn_off_limit(self, value: typing.SupportsFloat | typing.SupportsIndex) -> None:
"""
Shop command string 'set gen_turn_off_limit <value>'.
"""
[docs]
def set_headopt_feedback(self, value: typing.SupportsFloat | typing.SupportsIndex) -> None:
"""
Shop command string 'set headopt_feedback <value>'.
"""
[docs]
def set_max_num_threads(self, value: typing.SupportsInt | typing.SupportsIndex) -> None:
"""
Shop command string 'set max_num_threads <value>'.
"""
[docs]
def set_merge_off(self) -> None:
"""
Shop command string 'set merge /off'.
"""
[docs]
def set_merge_on(self) -> None:
"""
Shop command string 'set merge /on'.
"""
[docs]
def set_merge_stop(self) -> None:
"""
Shop command string 'set merge /stop'.
"""
[docs]
def set_method_baropt(self) -> None:
"""
Shop command string 'set method /baropt'.
"""
[docs]
def set_method_dual(self) -> None:
"""
Shop command string 'set method /dual'.
"""
[docs]
def set_method_hydbaropt(self) -> None:
"""
Shop command string 'set method /hydbaropt'.
"""
[docs]
def set_method_netdual(self) -> None:
"""
Shop command string 'set method /netdual'.
"""
[docs]
def set_method_netprimal(self) -> None:
"""
Shop command string 'set method /netprimal'.
"""
[docs]
def set_method_primal(self) -> None:
"""
Shop command string 'set method /primal'.
"""
[docs]
def set_mipgap(self, absolute: bool, value: typing.SupportsFloat | typing.SupportsIndex) -> None:
"""
Shop command string 'set mipgap /absolute|/relative <value>'.
"""
[docs]
def set_newgate(self, on: bool) -> None:
"""
Shop command string 'set newgate /on|/off'.
"""
[docs]
def set_nseg_all(self, value: typing.SupportsFloat | typing.SupportsIndex) -> None:
"""
Shop command string 'set nseg /all <value>'.
"""
[docs]
def set_nseg_down(self, value: typing.SupportsFloat | typing.SupportsIndex) -> None:
"""
Shop command string 'set nseg /down <value>'.
"""
[docs]
def set_nseg_up(self, value: typing.SupportsFloat | typing.SupportsIndex) -> None:
"""
Shop command string 'set nseg /up <value>'.
"""
[docs]
def set_parallel_mode_auto(self) -> None:
"""
Shop command string 'set parallel_mode /auto'.
"""
[docs]
def set_parallel_mode_deterministic(self) -> None:
"""
Shop command string 'set parallel_mode /deterministic'.
"""
[docs]
def set_parallel_mode_opportunistic(self) -> None:
"""
Shop command string 'set parallel_mode /opportunistic'.
"""
[docs]
def set_password(self, key: str, value: str) -> None:
"""
Shop command string 'set password <value>'.
"""
[docs]
def set_power_head_optimization(self, on: bool) -> None:
"""
Shop command string 'set power_head_optimization /on|/off'.
"""
[docs]
def set_ramping(self, mode: typing.SupportsInt | typing.SupportsIndex) -> None:
"""
Shop command string 'set ramping <value>'.
"""
[docs]
def set_reserve_ramping_cost(self, value: typing.SupportsFloat | typing.SupportsIndex) -> None:
"""
Shop command string 'set reserve_ramping_cost <value>'.
"""
[docs]
def set_reserve_slack_cost(self, value: typing.SupportsFloat | typing.SupportsIndex) -> None:
"""
Shop command string 'set reserve_slack_cost <value>'.
"""
[docs]
def set_time_delay_unit_hour(self) -> None:
"""
Shop command string 'set time_delay_unit hour'.
"""
[docs]
def set_time_delay_unit_minute(self) -> None:
"""
Shop command string 'set time_delay_unit minute'.
"""
[docs]
def set_time_delay_unit_time_step_length(self) -> None:
"""
Shop command string 'set time_delay_unit time_step_length'.
"""
[docs]
def set_timelimit(self, value: typing.SupportsInt | typing.SupportsIndex) -> None:
"""
Shop command string 'set timelimit <value>'.
"""
[docs]
def set_universal_mip_not_set(self) -> None:
"""
Shop command string 'set universal_mip /not_set'.
"""
[docs]
def set_universal_mip_off(self) -> None:
"""
Shop command string 'set universal_mip /off'.
"""
[docs]
def set_universal_mip_on(self) -> None:
"""
Shop command string 'set universal_mip /on'.
"""
[docs]
def set_xmllog(self, on: bool) -> None:
"""
Shop command string 'set xmllog /on|/off'.
"""
[docs]
def start_shopsim(self) -> None:
"""
Shop command string 'start shopsim'.
"""
[docs]
def start_sim(self, iterations: typing.SupportsInt | typing.SupportsIndex) -> None:
"""
Shop command string 'start sim <iterations>'.
"""
[docs]
class ShopSystem:
"""
A shop system, managing a session to the shop core.
"""
@staticmethod
def _pybind11_conduit_v1_(*args, **kwargs):
...
[docs]
@staticmethod
def environment() -> None:
"""
Print all environment variables to standard output.
"""
[docs]
@staticmethod
def environment_string() -> str:
"""
Get all environment variables as a newline delimited string value.
"""
[docs]
@staticmethod
def optimize(stm_system: shyft.energy_market.stm.StmSystem, time_axis: shyft.time_series.TimeAxis, commands: collections.abc.Sequence[shyft.energy_market.stm.ShopCommand], logging_to_stdstreams: bool, logging_to_files: bool) -> None:
...
[docs]
@staticmethod
def optimize2(stm_system: shyft.energy_market.stm.StmSystem, time_begin: shyft.time_series.time, time_end: shyft.time_series.time, time_step: shyft.time_series.time, commands: collections.abc.Sequence[shyft.energy_market.stm.ShopCommand], logging_to_stdstreams: bool, logging_to_files: bool) -> None:
...
@typing.overload
def __init__(self, arg0: shyft.time_series.UtcPeriod, arg1: shyft.time_series.time) -> None:
"""
Create shop system, initialize with fixed time resolution. note that you should provide valid period and reasonable dt
"""
@typing.overload
def __init__(self, arg0: shyft.time_series.TimeAxis) -> None:
...
[docs]
def collect(self, stm_system: shyft.energy_market.stm.StmSystem) -> None:
...
[docs]
def command_raw(self, command: str) -> None:
...
[docs]
def complete(self, stm_system: shyft.energy_market.stm.StmSystem) -> None:
...
[docs]
def emit(self, stm_system: shyft.energy_market.stm.StmSystem) -> None:
"""
Emit a stm system into the shop core.
"""
[docs]
def export_data(self, all: bool = False) -> None:
...
[docs]
def export_data_string(self, all: bool = False) -> str:
...
[docs]
def export_topology(self, all: bool = False, raw: bool = False) -> None:
...
[docs]
def export_topology_string(self, all: bool = False, raw: bool = False) -> str:
...
[docs]
def export_yaml_string(self, input_only: bool = False, output_only: bool = False, compress_txy: bool = False, compress_connection: bool = False) -> str:
...
[docs]
def get_executed_commands_raw(self) -> list[str]:
...
@typing.overload
def get_log_buffer(self, limit: typing.SupportsInt | typing.SupportsIndex) -> list[shyft.energy_market.stm.LogEntry]:
...
@typing.overload
def get_log_buffer(self) -> list[shyft.energy_market.stm.LogEntry]:
...
[docs]
def get_status(self) -> shyft.energy_market.stm.shop.Status | None:
...
[docs]
def get_version_info(self) -> str:
"""
Get version information from the shop core.
"""
[docs]
def set_logging_to_files(self, on: bool = True) -> None:
...
[docs]
def set_logging_to_stdstreams(self, on: bool = True) -> None:
...
@property
def commander(self) -> ShopCommander:
"""
Get shop commander object.
"""
[docs]
class Status:
"""
Describes SHOP solver status
Members:
NOT_SET
OPTIMAL_SOLUTION
OPTIMAL_INTEGER_SOLUTION
OPTIMAL_WITHIN_TOLERANCES
TIMEOUT_SOLUTION_EXISTS
OPTIMAL_SOLUTION_SCALED
SUBOPTIMAL_SOLUTION
INFEASIBLE
INTEGER_INFEASIBLE
INTEGER_INFEASIBLE_OR_UNBOUNDED
UNBOUNDED
TIMEOUT_INTEGER
TIMEOUT
"""
INFEASIBLE: typing.ClassVar[Status] # value = <Status.INFEASIBLE: 7>
INTEGER_INFEASIBLE: typing.ClassVar[Status] # value = <Status.INTEGER_INFEASIBLE: 8>
INTEGER_INFEASIBLE_OR_UNBOUNDED: typing.ClassVar[Status] # value = <Status.INTEGER_INFEASIBLE_OR_UNBOUNDED: 9>
NOT_SET: typing.ClassVar[Status] # value = <Status.NOT_SET: 0>
OPTIMAL_INTEGER_SOLUTION: typing.ClassVar[Status] # value = <Status.OPTIMAL_INTEGER_SOLUTION: 2>
OPTIMAL_SOLUTION: typing.ClassVar[Status] # value = <Status.OPTIMAL_SOLUTION: 1>
OPTIMAL_SOLUTION_SCALED: typing.ClassVar[Status] # value = <Status.OPTIMAL_SOLUTION_SCALED: 5>
OPTIMAL_WITHIN_TOLERANCES: typing.ClassVar[Status] # value = <Status.OPTIMAL_WITHIN_TOLERANCES: 3>
SUBOPTIMAL_SOLUTION: typing.ClassVar[Status] # value = <Status.SUBOPTIMAL_SOLUTION: 6>
TIMEOUT: typing.ClassVar[Status] # value = <Status.TIMEOUT: 12>
TIMEOUT_INTEGER: typing.ClassVar[Status] # value = <Status.TIMEOUT_INTEGER: 11>
TIMEOUT_SOLUTION_EXISTS: typing.ClassVar[Status] # value = <Status.TIMEOUT_SOLUTION_EXISTS: 4>
UNBOUNDED: typing.ClassVar[Status] # value = <Status.UNBOUNDED: 10>
__members__: typing.ClassVar[dict[str, Status]] # value = {'NOT_SET': <Status.NOT_SET: 0>, 'OPTIMAL_SOLUTION': <Status.OPTIMAL_SOLUTION: 1>, 'OPTIMAL_INTEGER_SOLUTION': <Status.OPTIMAL_INTEGER_SOLUTION: 2>, 'OPTIMAL_WITHIN_TOLERANCES': <Status.OPTIMAL_WITHIN_TOLERANCES: 3>, 'TIMEOUT_SOLUTION_EXISTS': <Status.TIMEOUT_SOLUTION_EXISTS: 4>, 'OPTIMAL_SOLUTION_SCALED': <Status.OPTIMAL_SOLUTION_SCALED: 5>, 'SUBOPTIMAL_SOLUTION': <Status.SUBOPTIMAL_SOLUTION: 6>, 'INFEASIBLE': <Status.INFEASIBLE: 7>, 'INTEGER_INFEASIBLE': <Status.INTEGER_INFEASIBLE: 8>, 'INTEGER_INFEASIBLE_OR_UNBOUNDED': <Status.INTEGER_INFEASIBLE_OR_UNBOUNDED: 9>, 'UNBOUNDED': <Status.UNBOUNDED: 10>, 'TIMEOUT_INTEGER': <Status.TIMEOUT_INTEGER: 11>, 'TIMEOUT': <Status.TIMEOUT: 12>}
@staticmethod
def _pybind11_conduit_v1_(*args, **kwargs):
...
def __eq__(self, other: typing.Any) -> bool:
...
def __getstate__(self) -> int:
...
def __hash__(self) -> int:
...
def __index__(self) -> int:
...
[docs]
def __init__(self, value: typing.SupportsInt | typing.SupportsIndex) -> None:
...
def __int__(self) -> int:
...
def __ne__(self, other: typing.Any) -> bool:
...
@typing.overload
def __repr__(self) -> str:
...
@typing.overload
def __repr__(self) -> int:
...
def __setstate__(self, state: typing.SupportsInt | typing.SupportsIndex) -> None:
...
@typing.overload
def __str__(self) -> str:
...
@typing.overload
def __str__(self) -> str:
...
[docs]
def to_log_severity(self) -> shyft.energy_market.stm.LogSeverity:
...
@property
def name(self) -> str:
...
@property
def value(self) -> int:
...
__version__: str = '35.2.0'
busbar_power_deficit_url: str = 'planning.output.power_deficit'
busbar_power_excess_url: str = 'planning.output.power_excess'
gate_ramp_cost_url: str = 'planning.input.gate_ramp_cost'
global_settings_scale_bp_curves_by_best_point_mc_url: str = 'planning.input.scaled_bp_curves'
market_load_price_url: str = 'planning.input.load_price'
power_plant_ramping_steps_direction_url: str = 'planning.input.production.ramping_steps_direction'
power_plant_schedule_penalty_cost_url: str = 'planning.input.schedule.penalty.cost'
river_discharge_result_downstream_url: str = 'planning.output.discharge.result_downstream'
shop_api_version: str = '17.16.1'
shyft_with_shop: bool = True
transmission_line_max_backward_flow_url: str = 'planning.output.max_backward_flow'
transmission_line_n_segments_url: str = 'planning.input.n_segments'