--- jupytext: text_representation: extension: .md format_name: myst format_version: 0.13 jupytext_version: 1.13.8 kernelspec: display_name: 'Python 3' name: python3 --- (setting)= # setting Simulation settings. Exactly one instance is mandatory (added automatically). | | | |---|---| |Input connections|| |Output connections|| |License|PRODRISK_OPEN| |Release version|9.6.1| ```{contents} :local: :depth: 1 ``` ## Attributes ```{code-cell} ipython3 :tags: ['remove-input', 'full-width'] import itables as itables from itables import init_notebook_mode init_notebook_mode(all_interactive=True, connected=True) import pandas as pd from IPython.core.display import HTML table = pd.read_csv('../../../attributes.csv') core_type_dict = {'int' : 'integer','double':'float','string':'string','int_array':'list-of-integer-values','double_array':'list-of-double-values','xy':'table-xy-curve','xy_array':'list-of-tables','txy':'time-series','txy_stochastic':'stochastic-time-series'} object_attributes = table[table["Object type"] == "setting"].reset_index().iloc[:, 1:] for index, row in object_attributes.iterrows(): object_attributes.at[index, "Attribute name"] = f"""{row['Attribute name']}""" object_attributes.at[index, "Core data type"] = f"""{row['Core data type']}""" itables.show(object_attributes, dom='tlip', search={'regex': True, "caseInsensitive": True}, column_filters='header', columns=[ { 'name': '', 'className': 'dt-control', 'orderable': False, 'data': None, 'defaultContent': '', }, { 'name': 'Attribute name', 'className': 'dt-body-left' }, { 'name': 'Python data type', 'className': 'dt-body-left' }, { 'name': 'Core data type', 'className': 'dt-body-left' }, { 'name': 'unit', 'className': 'dt-body-left' }, { 'name': 'I/O', 'className': 'dt-body-left' }, { 'name': 'License', 'className': 'dt-body-left' }, { 'name': 'Version added', 'className': 'dt-body-left' }, { 'name': 'Description', 'visible': False } ] ) HTML('''''') ``` (setting:start_day)= ### start_day Start day input in CLI interactive dialogue. May take values from 1 to 6, 1 is default. Input and result series start at day 1 in the first week, even if start_day>1. (unit: none) (setting:mpi_path)= ### mpi_path Full path to MPI bin folder, for example C:\Program Files\Microsoft MPI\Bin. (unit: none) (setting:inflow_model)= ### inflow_model The type of inflow model used in optimization (lognormal, principal, residual) (unit: none) (setting:min_discharge_cost_d_price)= ### min_discharge_cost_d_price Cost of violating minimum discharge constraint (unit: EUR/MWh) (setting:read_head_coefficients)= ### read_head_coefficients Set to 0 to skip reading head coefficients from result files. (unit: none) (setting:relaxation_tolerance)= ### relaxation_tolerance Tolerance in the relaxation process (unit: none) (setting:log_file_path)= ### log_file_path The full path to the directory where the session log file will be written. Default: Folder 'LogFiles' in prodriskPath. (unit: none) (setting:read_start_time_water_values)= ### read_start_time_water_values Read water values at start time from result file indvan.prd. (unit: none) (setting:overflow_cost)= ### overflow_cost Penalty cost for reservoir overflow. (unit: EUR/MWh) (setting:last_iteration_generated_scenarios)= ### last_iteration_generated_scenarios Last iteration where generated scenarios are included in the optimization (unit: none) (setting:min_bypass_cost_volume)= ### min_bypass_cost_volume Cost of violating minimum bypass constraint (unit: EUR/1000m3) (setting:inf)= ### inf Used as unlimited for certain variables in weekly LP problems. (unit: none) (setting:cut_negative_residual_inflow)= ### cut_negative_residual_inflow If the residual inflow model is used (setting residual_model=1), cut negative inflows to zero if this setting is 1 (recommended, default). (unit: none) (setting:water_ration_cost)= ### water_ration_cost Penalty cost for breaking min filling restrictions. (unit: EUR/MWh) (setting:cuts_as_endvalue_setting)= ### cuts_as_endvalue_setting Use input cuts as end value setting (if provided) if set to 1. Default value is 0. (unit: none) (setting:min_iterations)= ### min_iterations Min number of SDDP iterations run (unit: none) (setting:is_series_simulation)= ### is_series_simulation Set to 1 to enable series simulation mode (used for investment planning) (unit: none) (setting:sim_convex)= ### sim_convex Adds command line option -SIMCONVEX. This ensures same model is used in the forward and backward iterations. (unit: none) (setting:min_reservoir_cost_volume)= ### min_reservoir_cost_volume Cost of violating minimum reservoir constraint (unit: EUR/1000m3) (setting:n_sample_scenarios)= ### n_sample_scenarios Number of sampled inflow scenarios to generate percentiles or extremes from (unit: none) (setting:ramping_down_cost_volume)= ### ramping_down_cost_volume Cost of violating ramping down constraint. (unit: EUR/1000m3) (setting:min_discharge_cost_energy)= ### min_discharge_cost_energy Cost of violating minimum discharge constraint (unit: EUR/MWh) (setting:backward_spilling_cost_volume)= ### backward_spilling_cost_volume Cost of spilling in backward recursion (unit: EUR/1000m3) (setting:ramping_up_cost_energy)= ### ramping_up_cost_energy Cost of violating ramping up constraint. (unit: EUR/MWh) (setting:buffer_reservoir_cost_energy)= ### buffer_reservoir_cost_energy Cost of deviating from the guideline curve for buffer reservoirs (unit: EUR/MWh) (setting:command_line_option)= ### command_line_option Command line option, see the Prodrisk documentation (unit: none) (setting:prepare_shop_input)= ### prepare_shop_input Create cut file(s) for SHOP (SHOP, Ja in interactive dialogue). (unit: none) (setting:surplus_power_cost)= ### surplus_power_cost Penalty cost for surplus power. (unit: EUR/MWh) (setting:head_coeff_and_cut_id)= ### head_coeff_and_cut_id Setting this value to 0 together with cut input will force a -NOHEAD run. In -SIM runs with no head coefficients set, this id must either be set to 0, or the -NOHEAD option should be used. (unit: none) (setting:bypass_cost)= ### bypass_cost Global bypass cost (unit: EUR/MWh) (setting:n_principal_comp)= ### n_principal_comp The number of principal components in the inflow model (unit: none) (setting:read_lognormal_model)= ### read_lognormal_model If set to 1, Prodrisk will read and use a pre-existing lognormal model for inflow (unit: none) (setting:user_defined_price_model)= ### user_defined_price_model Take area->priceBand and area->priceTransition as input and skip GENPRIS (unit: none) (setting:backward_spilling_cost_energy)= ### backward_spilling_cost_energy Cost of spilling in backward recursion (unit: EUR/MWh) (setting:n_kmeans)= ### n_kmeans Number of sample points used in K means clustering (unit: none) (setting:end_week_new_cuts)= ### end_week_new_cuts End week for calculating new cuts, option#5 in CLI interactive dialogue. Cuts given as input for later weeks are used in the final simulation of the whole simulation period. (unit: none) (setting:future_cost)= ### future_cost Future cost for the cuts to SHOP (unit: kEUR) (setting:first_relaxation_parameter)= ### first_relaxation_parameter Parameter in the relaxation process (unit: none) (setting:shop_file_name)= ### shop_file_name Prefix to the file names of the SHOP-files copied to shop_directory. Default: 'SHOP-SYSTEM'. (unit: none) (setting:deficit_power_cost)= ### deficit_power_cost Penalty cost for deficit power. (unit: EUR/MWh) (setting:reservoir_balance_option)= ### reservoir_balance_option Reservoir balances during the week. Default 0 (weekly reservoir balances) (unit: none) (setting:backward_bypass_cost_volume)= ### backward_bypass_cost_volume Cost of bypassing in backward recursion (unit: EUR/1000m3) (setting:min_discharge_cost_volume)= ### min_discharge_cost_volume Cost of violating minimum discharge constraint (unit: EUR/1000m3) (setting:read_shop_water_values)= ### read_shop_water_values Read cuts from result file SHOP-SYSTEM.dat (standard SHOP cut format). Currently only available in the WCF interface. (unit: none) (setting:read_mean_reservoir_trajectories)= ### read_mean_reservoir_trajectories Set to 0 to skip reading mean reservoir trajectories from result files. (unit: none) (setting:use_reserve_up)= ### use_reserve_up Set to 1 to include reserve up capacity market (unit: none) (setting:price_scenario_option)= ### price_scenario_option Reserved for future use (?): feature with multiple price scenarios per inflow scenarios currently not available through the API. (unit: none) (setting:shop_cut_week)= ### shop_cut_week Week number standard SHOP cut file should be made for. May be set to 1 or 2. Default value is 1. (unit: none) (setting:temp_dir)= ### temp_dir Path to where temp working dir should be created. Special characters are forbidden. Default: prodriskPath. (unit: none) (setting:write_penalty_logfiles)= ### write_penalty_logfiles Set to 1 to make detailed penalty information available. Default is 0, as this might increase the computation time. (unit: none) (setting:alfa_max)= ### alfa_max Used as unlimited for objective function in weekly LP problems. (unit: none) (setting:min_iterations_without_generated_scenarios)= ### min_iterations_without_generated_scenarios Minimum number of iterations without generated scenarios at the end of the optimization (unit: none) (setting:use_input_pq_curve)= ### use_input_pq_curve Binary option: 1 = use input PQ curve 0 = make PQ curve convex (unit: none) (setting:ignore_headcoeff_meanres)= ### ignore_headcoeff_meanres If nonzero, head coefficients and mean reservoir trajectories are ignored even if set as input. (unit: none) (setting:price_periods)= ### price_periods The hours of each week are aggregated into price periods with the same price to save simulation time. This aggregation is represented as a time series, where each hour in the week is given a tag to represent the corresponding price period. Three different time resolutions may be used for different set of weeks in an optimization: sequential price period, accumulated price periods and weekly resolution. (unit: none) (setting:n_price_levels)= ### n_price_levels The number of price levels used in the price model, including max and min. (unit: none) (setting:min_iterations_first_run)= ### min_iterations_first_run Min. no. of iterations in initial strategy computation (to compute head coefficients) (unit: none) (setting:ramping_down_cost_energy)= ### ramping_down_cost_energy Cost of violating ramping down constraint. (unit: EUR/MWh) (setting:reference_price)= ### reference_price Reference price for the calculation of water values for SHOP (unit: EUR/MWh) (setting:node_price_profile)= ### node_price_profile Set to 1 to use the Node dependent price profile functionality. (unit: none) (setting:forward_spilling_cost_d_price)= ### forward_spilling_cost_d_price Cost of spilling in forward simulation (unit: EUR/MWh) (setting:sequential_price_period_end_week)= ### sequential_price_period_end_week Last week with sequential price period resolution (unit: none) (setting:use_reserve_down)= ### use_reserve_down Set to 1 to include reserve down capacity market (unit: none) (setting:suppress_seq_res)= ### suppress_seq_res Set to 0 to get all module results with sequential price period resolution (unit: none) (setting:windows_core_delay)= ### windows_core_delay Safety delay before envoking core programs on temporary run directory on Windows systems. Default 10000ms. (unit: ms) (setting:backward_bypass_cost_energy)= ### backward_bypass_cost_energy Cost of bypassing in backward recursion (unit: EUR/MWh) (setting:n_principal_comp_discrete_values)= ### n_principal_comp_discrete_values The number of discrete values for each principal component (unit: none) (setting:forward_model_option)= ### forward_model_option 1 - Forward simulation as final simulation, 0 - Convex forward simulation (unit: none) (setting:max_iterations_first_run)= ### max_iterations_first_run Max. no. of iterations in initial strategy computation (to compute head coefficients) (unit: none) (setting:shop_directory)= ### shop_directory Path to where SHOP files should be copied. (unit: none) (setting:prodrisk_path)= ### prodrisk_path The full path to the folder containing the .exe and .dll files for running Prodrisk (unit: none) (setting:lognormal_model)= ### lognormal_model If set to 1, the lognormal model for inflow will be used (unit: none) (setting:forward_spilling_cost_volume)= ### forward_spilling_cost_volume Cost of spilling in forward simulation (unit: EUR/1000m3) (setting:use_owner_share)= ### use_owner_share Binary variable to control the use of owner share of modules. Production and pump capacities are scaled with ownerShare attributes on the module- and pump objects. (unit: none) (setting:second_relaxation_parameter)= ### second_relaxation_parameter Parameter in the relaxation process (unit: none) (setting:forward_bypass_cost_volume)= ### forward_bypass_cost_volume Cost of bypassing in forward simulation (unit: EUR/1000m3) (setting:min_bypass_cost_energy)= ### min_bypass_cost_energy Cost of violating minimum bypass constraint (unit: EUR/MWh) (setting:use_coin_osi)= ### use_coin_osi Binary variable to choose between running Prodrisk with OSI (1) or CPLEX (0). Default is 0. (unit: none) (setting:max_reservoir_cost_volume)= ### max_reservoir_cost_volume Cost of violating maximum reservoir constraint (unit: EUR/1000m3) (setting:inflow_seasons)= ### inflow_seasons Define inflow seasons by setting a unique integer tag at the beginning of the first week of each season. A negative tag means that correlations will be zeroed in that season. Default: One season spanning over the whole simulation period. (unit: none) (setting:n_processes)= ### n_processes The number of processes to run in parallel in the simulation (unit: none) (setting:shop_cut_weeks)= ### shop_cut_weeks Week numbers extended SHOP cut files should be made for. (unit: none) (setting:print_all)= ### print_all Adds command line option -printall. Will give some more detailed logging, including a file with F-cost per scenario per iteration. (unit: none) (setting:max_cuts_created)= ### max_cuts_created Number of cuts created (unit: none) (setting:log_file_name)= ### log_file_name The name of the session log file, including the file extension (the content is always plain text). By default, the name is inherited from the Prodrisk session and has the format 'session_YYYY-MM-DD-hh-mm-ss.txt' (with a time stamp), unless the name of the session is set otherwise (pyprodrisk: with sim_id). (unit: none) (setting:backward_spilling_cost_d_price)= ### backward_spilling_cost_d_price Cost of spilling in backward recursion (unit: EUR/MWh) (setting:max_reservoir_cost_d_price)= ### max_reservoir_cost_d_price Cost of violating maximum reservoir constraint (unit: EUR/MWh) (setting:ramping_down_cost_d_price)= ### ramping_down_cost_d_price Cost of violating ramping down constraint. (unit: EUR/MWh) (setting:forward_spilling_cost_energy)= ### forward_spilling_cost_energy Cost of spilling in forward simulation (unit: EUR/MWh) (setting:aggregated_price_period_start_week)= ### aggregated_price_period_start_week Use weekly resolution from this week (unit: none) (setting:forward_bypass_cost_energy)= ### forward_bypass_cost_energy Cost of bypassing in forward simulation (unit: EUR/MWh) (setting:min_reservoir_cost_energy)= ### min_reservoir_cost_energy Cost of violating minimum reservoir constraint (unit: EUR/MWh) (setting:residual_model)= ### residual_model If set to 1, the residual model for inflow will be used instead of the principal component analysis (unit: none) (setting:buffer_reservoir_cost_d_price)= ### buffer_reservoir_cost_d_price Cost of deviating from the guideline curve for buffer reservoirs (unit: EUR/MWh) (setting:generated_inflow_type)= ### generated_inflow_type Type of generated inflow sampling (0: Random, 1: Percentiles, 2: Extremes) (unit: none) (setting:prodrisk_variant)= ### prodrisk_variant Name of Prodrisk executable. May be used on linux to test different MPI versions than Intel MPI. (unit: none) (setting:reservoir_soft_restriction_cost)= ### reservoir_soft_restriction_cost Penalty cost for breaking soft reservoir restrictions. (unit: EUR/m3) (setting:backward_bypass_cost_d_price)= ### backward_bypass_cost_d_price Cost of bypassing in backward recursion (unit: EUR/MWh) (setting:sequential_price_period_start_week)= ### sequential_price_period_start_week First week with sequential price period resolution (unit: none) (setting:use_non_convex_pq_curve)= ### use_non_convex_pq_curve Enable feature: non convex PQ curve using integer variables in the final simulation (large computation time!). (unit: none) (setting:ramping_up_cost_volume)= ### ramping_up_cost_volume Cost of violating ramping up constraint. (unit: EUR/1000m3) (setting:buffer_reservoir_cost_volume)= ### buffer_reservoir_cost_volume Cost of deviating from the guideline curve for buffer reservoirs (unit: EUR/1000m3) (setting:max_reservoir_cost_energy)= ### max_reservoir_cost_energy Cost of violating maximum reservoir constraint (unit: EUR/MWh) (setting:max_relaxation_iterations)= ### max_relaxation_iterations Maximum number of iterations in the relaxation process (unit: none) (setting:ramping_up_cost_d_price)= ### ramping_up_cost_d_price Cost of violating ramping up constraint. (unit: EUR/MWh) (setting:forward_bypass_cost_d_price)= ### forward_bypass_cost_d_price Cost of bypassing in forward simulation (unit: EUR/MWh) (setting:min_bypass_cost_d_price)= ### min_bypass_cost_d_price Cost of violating minimum bypass constraint (unit: EUR/MWh) (setting:convergence_criteria)= ### convergence_criteria Convergence tolerance. (unit: %) (setting:n_generated_scenarios)= ### n_generated_scenarios Number of generated scenarios to include in the optimization (unit: none) (setting:real_interest_rate)= ### real_interest_rate Real interest rate, used to set weekly discount factors for cash flows in future weeks. (unit: %) (setting:windows_api_delay)= ### windows_api_delay Safety delay when launching processes from the API on Windows systems. Default 3000ms. (unit: ms) (setting:max_iterations)= ### max_iterations Max number of SDDP iterations run (unit: none) (setting:min_scenarios_per_price_node)= ### min_scenarios_per_price_node Minimum number of scenarios per price node in the price model. (unit: none) (setting:min_reservoir_cost_d_price)= ### min_reservoir_cost_d_price Cost of violating minimum reservoir constraint (unit: EUR/MWh)