Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

Attributes

iLab Assistant

Each object type has a defined set of input and output attributes that hold the majority of all data in the SHOP model. The table lists all 1461 attributes. Filter on any column, click ▸ to show the description of an attribute, and click the attribute name for its full documentation on the object page.

Object typeAttribute nameData typeI/ORequiredUnitDefault valueLicenseVersion addedNaN AllowedDescription
reservoirlatitudedoubleInputNoNO_UNIT0.0SHOP_OPEN13.0.0.aNoReserved for future use.
reservoirlongitudedoubleInputNoNO_UNIT0.0SHOP_OPEN13.0.0.aNoReserved for future use.
reservoirmax_voldoubleInputYesMM30.0SHOP_OPEN13.0.0.aNoMaximum volume of the reservoir.
reservoirlrldoubleInputYesMETER0.0SHOP_OPEN13.0.0.aNoLowest Regulation Level (meter above sea level) of the reservoir.
reservoirhrldoubleInputYesMETER0.0SHOP_OPEN13.0.0.aNoHighest Regulation Level (meter above sea level) of the reservoir.
reservoirvol_levelxyInputYesx: MM3 and y: METERNone/nullSHOP_OPEN13.0.0.aNoThe volume (Mm3) and water level (meter above sea level) relation of the reservoir. The list should cover all feasible reservoir level values so that the volume-head conversion is always successful.
reservoirlevel_areaxyInputNox: METER and y: KM2None/nullSHOP_OPEN14.6.0.0NoThe water level (meter above sea level) and surface area (Km2) relation of the reservoir.
reservoirelevation_adjustmenttimeseriesInputNoMETERNone/nullSHOP_ELEVATION_ADJUSTMENT13.0.0.aNoAdjustment for the lowest regulation level (lrl), highest regulation level (hrl), and the volume (Mm3) and water level (meter above sea level) relation of the reservoir.
reservoirstart_voldoubleInputNoMM30.0SHOP_OPEN13.0.0.aNoReservoir start volume. If start_vol and start_level are both defined, the value of the prefer_start_vol attribute on global_settings will decide which is used.
reservoirstart_leveldoubleInputNoMETER0.0SHOP_OPEN13.0.0.aNoReservoir start water level (meter above sea level). If start_vol and start_level are both defined, the value of the prefer_start_vol attribute on global_settings will decide which is used.
reservoirinflowtimeseriesInputNoM3/SNone/nullSHOP_OPEN13.0.0.aNoNatural inflow to reservoir.
reservoirinflow_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.2.0.aNoFlag determining whether the inflow to a reservoir should be used as input or calculated as output in the simulation: 0 = input; 1 = output.
reservoirsim_inflow_flagtimeseriesInputNoNO_UNITNone/nullSHOP_SIMULATION13.0.0.aNoFlag determining whether inflow should be simulated to reservoir or not.
reservoirflow_descrxyInputNox: METER and y: M3/SNone/nullSHOP_OPEN13.0.0.aNoThe water level (meter above sea level) and overflow (m3/s) relation of the reservoir. Only used when a spill gate is connected, please see the overflow modelling example.
reservoiroverflow_mip_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OVERFLOW_MIP13.0.0.aNoFlag determining whether the binary variables should be used to prevent non-physical spill.
reservoiroverflow_costtimeseriesInputNoNOK/MM3None/nullSHOP_OPEN13.0.0.aYesOverflow cost for the reservoir.
reservoiroverflow_cost_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aNoFlag determining whether overflow cost for this reservoir should be included in the optimization model.
reservoirmin_vol_constrtimeseriesInputNoMM3None/nullSHOP_OPEN13.0.0.aYesTime-dependent minimum volume limit for the reservoir.
reservoirmin_vol_constr_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aNoFlag determining whether the time-dependent minimum volume limit for the reservoir should be included in the optimization model.
reservoirmax_vol_constrtimeseriesInputNoMM3None/nullSHOP_OPEN13.0.0.aYesTime-dependent maximum volume limit for the reservoir.
reservoirmax_vol_constr_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aNoFlag determining whether the time-dependent maximum volume limit for the reservoir should be included in the optimization model.
reservoirmin_level_constrtimeseriesInputNoMETERNone/nullSHOP_OPEN14.0.0.1YesTime-dependent minimum water level limit for the reservoir. The min_vol_constr attribute is preferred if it is present for the same reservoir.
reservoirmin_level_constr_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN14.0.0.1NoFlag determining whether the time-dependent minimum water level limit for the reservoir should be included in the optimization model.
reservoirmax_level_constrtimeseriesInputNoMETERNone/nullSHOP_OPEN14.0.0.1YesTime-dependent maximum water level limit for the reservoir. The max_vol_constr attribute is preferred if it is present for the same reservoir.
reservoirmax_level_constr_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN14.0.0.1NoFlag determining whether the time-dependent maximum water level limit for the reservoir should be included in the optimization model.
reservoirtactical_limit_mintimeseriesInputNoMM3None/nullSHOP_TACTICAL_LIMIT13.0.0.aYesTactical (soft) minimum volume limit for the reservoir.
reservoirtactical_limit_min_flagtimeseriesInputNoNO_UNITNone/nullSHOP_TACTICAL_LIMIT13.0.0.aNoFlag determining whether the tactical minimum volume limit should be included in the optimization model.
reservoirtactical_cost_mintimeseriesInputNoNOK/MM3HNone/nullSHOP_TACTICAL_LIMIT13.0.0.aYesGiven penalty cost for violating the tactical minimum volume limit for the reservoir.
reservoirtactical_cost_min_flagtimeseriesInputNoNO_UNITNone/nullSHOP_TACTICAL_LIMIT13.0.0.aNoFlag determining whether the penalty cost for violating the tactical minimum volume limit should be included in the optimization model.
reservoirtactical_limit_maxtimeseriesInputNoMM3None/nullSHOP_TACTICAL_LIMIT13.0.0.aYesTactical (soft) maximum volume limit for the reservoir.
reservoirtactical_limit_max_flagtimeseriesInputNoNO_UNITNone/nullSHOP_TACTICAL_LIMIT13.0.0.aNoFlag determining whether the tactical maximum volume limit should be included in the optimization model.
reservoirtactical_cost_maxtimeseriesInputNoNOK/MM3HNone/nullSHOP_TACTICAL_LIMIT13.0.0.aYesGiven penalty cost for violating the tactical maximum volume limit for the reservoir.
reservoirtactical_cost_max_flagtimeseriesInputNoNO_UNITNone/nullSHOP_TACTICAL_LIMIT13.0.0.aNoFlag determining whether the penalty cost for violating the tactical maximum volume limit should be included in the optimization model.
reservoirtactical_level_limit_mintimeseriesInputNoMETERNone/nullSHOP_TACTICAL_LIMIT15.7.0.0YesTactical minimum level limit for the reservoir.
reservoirtactical_level_limit_maxtimeseriesInputNoMETERNone/nullSHOP_TACTICAL_LIMIT15.7.0.0YesTactical maximum level limit for the reservoir.
reservoirupper_slacktimeseriesInputNoMM3None/nullSHOP_OPEN13.0.0.aYesUsed to expand the upper reservoir limit when running with an active reservoir schedule so that the volume can be between the schedule and upper_slack.
reservoirlower_slacktimeseriesInputNoMM3None/nullSHOP_OPEN13.0.0.aYesUsed to expand the lower reservoir limit when running with an active reservoir schedule so that the volume can be between the schedule and lower_slack.
reservoirscheduletimeseriesInputNoMM3None/nullSHOP_OPEN13.0.0.aYesReservoir volume schedule used to specify the volume of the reservoir in each time step. Must be combined with a schedule_flag to be active.
reservoirschedule_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aNoFlag determining whether the reservoir volume schedule should be included in the optimization model: 0 = no schedule; 1 = the endpoint interval upper_slack and lower_slack is valid; 2 = reservoir volume schedule is valid anywhere during the optimization period.
reservoirsim_volume_scheduletimeseriesInputNoMM3None/nullSHOP_OPEN13.0.0.aNoReservoir volume schedule used in the SHOP simulator when simulating reservoir inflow with the /inflow command option. The sim_volume_schedule takes precedence over the sim_level_schedule if both are defined. If neither attribute is defined, the storage attribute (result from the optimization) is used.
reservoirsim_level_scheduletimeseriesInputNoMETERNone/nullSHOP_OPEN13.0.0.aNoReservoir water level schedule used in the SHOP simulator when simulating reservoir inflow with the /inflow command option. The sim_volume_schedule takes precedence over the sim_level_schedule if both are defined. If neither attribute is defined, the storage attribute (result from the optimization) is used.
reservoirvolume_ramping_uptimeseriesInputNoMM3/HOURNone/nullSHOP_OPEN14.0.0.1YesMaximum limit for increase in reservoir volume per hour.
reservoirvolume_ramping_downtimeseriesInputNoMM3/HOURNone/nullSHOP_OPEN14.0.0.1YesMaximum limit for decrease in reservoir volume per hour.
reservoirlevel_ramping_uptimeseriesInputNoMETER/HOURNone/nullSHOP_OPEN14.0.0.1YesMaximum limit for increase in reservoir level per hour.
reservoirlevel_ramping_downtimeseriesInputNoMETER/HOURNone/nullSHOP_OPEN14.0.0.1YesMaximum limit for decrease in reservoir level per hour.
reservoirwater_value_inputxy_arrayInputNox: MM3 and y: NOK/MM3None/nullSHOP_OPEN14.0.0.1NoThe input water value description of water values referred to the sea. Can be a single constant value, a water value table (xy), or cut coefficients for a single or multiple price nodes. In the case of price dependent cut coefficients, the reference value of each xy in the xy_array should be the relevant price level.
reservoirenergy_value_inputdoubleInputNoNOK/MWH0.0SHOP_OPEN14.0.0.1NoThe input local energy value of the reservoir which will be converted to a global water value internally.
reservoirpeak_volume_cost_curvexyInputNox: MM3 and y: NOK/MM3None/nullSHOP_FLOOD_SUPPORT14.2.2.0NoA piece-wise constant increasing cost which is applied to the highest reservoir volume reached in the optimization horizon.
reservoirflood_volume_cost_curvexyInputNox: MM3 and y: NOK/MM3None/nullSHOP_FLOOD_SUPPORT14.2.2.0NoA piece-wise constant increasing cost curve which is used to penalize the reservoir volume level in each hour of the optimzation.
reservoirevaporation_ratetimeseriesInputNoMETER/HOURNone/nullSHOP_OPEN14.6.0.0NoEvaporation rate of water from the reservoir.
reservoirlevel_rolling_ramping_penalty_costtimeseriesInputNoNOK/METERNone/nullSHOP_COMPLEX_RAMPING15.2.0.0NoThe penalty cost for breaking any rolling ramping constraint applied to the reservoir level.
reservoirlevel_period_ramping_penalty_costtimeseriesInputNoNOK/METERNone/nullSHOP_COMPLEX_RAMPING15.2.0.0NoThe penalty cost for breaking any period ramping constraint applied to the reservoir level.
reservoiraverage_level_rolling_ramping_upxytInputNox: MINUTE and y: METERNone/nullSHOP_COMPLEX_RAMPING15.2.0.0YesInput to specify rolling ramping constraints that constrain the reservoir level upwards from the average reservoir level in a rolling time window. The x-values represent the length of the rolling time window and the y-values specify the number of meters the reservoir level can increase above the average rolling level. Each (x, y) point in each XY curve represents a rolling ramping constraint.
reservoiraverage_level_rolling_ramping_downxytInputNox: MINUTE and y: METERNone/nullSHOP_COMPLEX_RAMPING15.2.0.0YesInput to specify rolling ramping constraints that constrain the reservoir level downwards from the average reservoir level in a rolling time window. The x-values represent the length of the rolling time window and the y-values specify the number of meters the reservoir level can decrease below the average rolling level. Each (x, y) point in each XY curve represents a rolling ramping constraint.
reservoirlimit_level_rolling_ramping_upxytInputNox: MINUTE and y: METERNone/nullSHOP_COMPLEX_RAMPING15.2.0.0YesInput to specify rolling ramping constraints that constrain the reservoir level upwards from the minimal reservoir level in a rolling time window. The x-values represent the length of the rolling time window and the y-values specify the number of meters the reservoir level can increase above the minimal rolling level. Each (x, y) point in each XY curve represents a rolling ramping constraint.
reservoirlimit_level_rolling_ramping_downxytInputNox: MINUTE and y: METERNone/nullSHOP_COMPLEX_RAMPING15.2.0.0YesInput to specify rolling ramping constraints that constrain the reservoir level downwards from the maximal reservoir level in a rolling time window. The x-values represent the length of the rolling time window and the y-values specify the number of meters the reservoir level can decrease below the maximal rolling level. Each (x, y) point in each XY curve represents a rolling ramping constraint.
reservoiraverage_level_period_ramping_upxytInputNox: MINUTE and y: METERNone/nullSHOP_COMPLEX_RAMPING15.2.0.0YesInput to specify period ramping constraints that constrain the reservoir level upwards from the average reservoir level in a fixed time window. The x-values represent the length of the fixed time window and the y-values specify the number of meters the reservoir level can increase above the average level in the previous fixed time period. Each (x, y) point in each XY curve represents a period ramping constraint.
reservoiraverage_level_period_ramping_downxytInputNox: MINUTE and y: METERNone/nullSHOP_COMPLEX_RAMPING15.2.0.0YesInput to specify period ramping constraints that constrain the reservoir level downwards from the average reservoir level in a fixed time window. The x-values represent the length of the fixed time window and the y-values specify the number of meters the reservoir level can decrease below the average level in the previous fixed time period. Each (x, y) point in each XY curve represents a period ramping constraint.
reservoirlimit_level_period_ramping_upxytInputNox: MINUTE and y: METERNone/nullSHOP_COMPLEX_RAMPING15.2.0.0YesInput to specify period ramping constraints that constrain the reservoir level upwards from the minimal reservoir level in a fixed time window. The x-values represent the length of the fixed time window and the y-values specify the number of meters the reservoir level can increase above the minimal level in the previous fixed time period. Each (x, y) point in each XY curve represents a period ramping constraint.
reservoirlimit_level_period_ramping_downxytInputNox: MINUTE and y: METERNone/nullSHOP_COMPLEX_RAMPING15.2.0.0YesInput to specify period ramping constraints that constrain the reservoir level downwards from the maximal reservoir level in a fixed time window. The x-values represent the length of the fixed time window and the y-values specify the number of meters the reservoir level can decrease below the maximal level in the previous fixed time period. Each (x, y) point in each XY curve represents a period ramping constraint.
reservoirhistorical_leveltimeseriesInputNoMETERNone/nullSHOP_OPEN15.2.0.0NoThe reservoir level for times before the optimization start. The input start volume or start level of the reservoir will override any value in this timeseries that corresponds to the start time of the optimization, values inside the optimization horizon are ignored. The datatype of this attribute changed from XY to timeseries in version 15.3.1.0.
reservoiraverage_level_period_ramping_up_offsetsyInputNos: STRING and y: MINUTENone/nullSHOP_COMPLEX_RAMPING15.3.3.0NoThe y-values must be the same as the period lengths used in the average_level_period_ramping_up attribute, while the strings are timestamps that specify when the first whole ramping period starts for each of the average ramping up period constraints.
reservoiraverage_level_period_ramping_down_offsetsyInputNos: STRING and y: MINUTENone/nullSHOP_COMPLEX_RAMPING15.3.3.0NoThe y-values must be the same as the period lengths used in the average_level_period_ramping_down attribute, while the strings are timestamps that specify when the first whole ramping period starts for each of the average ramping down period constraints.
reservoirlimit_level_period_ramping_up_offsetsyInputNos: STRING and y: MINUTENone/nullSHOP_COMPLEX_RAMPING15.3.3.0NoThe y-values must be the same as the period lengths used in the limit_level_period_ramping_up attribute, while the strings are timestamps that specify when the first whole ramping period starts for each of the limit ramping up period constraints.
reservoirlimit_level_period_ramping_down_offsetsyInputNos: STRING and y: MINUTENone/nullSHOP_COMPLEX_RAMPING15.3.3.0NoThe y-values must be the same as the period lengths used in the limit_level_period_ramping_down attribute, while the strings are timestamps that specify when the first whole ramping period starts for each of the limit ramping up period constraints.
reservoirvolume_nonseq_ramping_limit_upxytInputNox: MINUTE and y: MM3None/nullSHOP_NONSEQ_AMPLITUDE_RSV_RAMP15.3.5.0NoLimit volume ramping between two non-sequential time steps. Start time is given by time T, duration by X and ramping by Y.
reservoirvolume_nonseq_ramping_limit_downxytInputNox: MINUTE and y: MM3None/nullSHOP_NONSEQ_AMPLITUDE_RSV_RAMP15.3.5.0NoLimit volume ramping between two non-sequential time steps. Start time is given by time T, duration by X and ramping by Y.
reservoirvolume_amplitude_ramping_limit_upxytInputNox: MINUTE and y: MM3None/nullSHOP_NONSEQ_AMPLITUDE_RSV_RAMP15.3.5.0NoLimit volume ramping between in time interval. Start time is given by time T, duration by X and ramping by Y.
reservoirvolume_amplitude_ramping_limit_downxytInputNox: MINUTE and y: MM3None/nullSHOP_NONSEQ_AMPLITUDE_RSV_RAMP15.3.5.0NoLimit volume ramping between in time interval. Start time is given by time T, duration by X and ramping by Y.
reservoirlevel_nonseq_ramping_limit_upxytInputNox: MINUTE and y: METERNone/nullSHOP_NONSEQ_AMPLITUDE_RSV_RAMP15.3.5.0NoLimit level ramping between two non-sequential time steps. Start time is given by time T, duration by X and ramping by Y.
reservoirlevel_nonseq_ramping_limit_downxytInputNox: MINUTE and y: METERNone/nullSHOP_NONSEQ_AMPLITUDE_RSV_RAMP15.3.5.0NoLimit level ramping between two non-sequential time steps. Start time is given by time T, duration by X and ramping by Y.
reservoirlevel_amplitude_ramping_limit_upxytInputNox: MINUTE and y: METERNone/nullSHOP_NONSEQ_AMPLITUDE_RSV_RAMP15.3.5.0NoLimit level ramping between in time interval. Start time is given by time T, duration by X and ramping by Y.
reservoirlevel_amplitude_ramping_limit_downxytInputNox: MINUTE and y: METERNone/nullSHOP_NONSEQ_AMPLITUDE_RSV_RAMP15.3.5.0NoLimit level ramping between in time interval. Start time is given by time T, duration by X and ramping by Y.
reservoirdynamic_level_limitxytInputNox: MINUTE and y: METERNone/nullSHOP_OPEN17.1.0NoInput to specify the maximum difference between the max and min reservoir level within given time periods. The x-values represent the length of the fixed time period and the y-values specify the max difference in reservoir level within that time period.
reservoirdynamic_level_limit_offsetsyInputNos: STRING and y: MINUTENone/nullSHOP_OPEN17.1.0NoThe y-values must be the same as the period lengths used in the dynamic_level_limit attribute, while the strings are timestamps that specify when the first whole dynamic level limit period starts for each of the dynamic level limit constraints.
reservoirdynamic_level_limit_penalty_costtimeseriesInputNoNOK/METERNone/nullSHOP_OPEN17.1.0NoThe penalty cost for breaking the dynamic reservoir level limits.
reservoirdisable_penaltiesintInputNoNO_UNIT0SHOP_OPEN17.11.0NoDisable the use of reservoir penalty variables by setting this parameter to 1. This means that SHOP is unable to create or destroy water in this reservoir by using penalties, but the optimization model may become infeasible. If the corresponding global settings attribute ‘disable_rsv_penalties’ is set to 1, this takes precedence over any individual reservoir specification.
reservoirstoragetimeseriesOutputNoMM3None/nullSHOP_OPEN13.0.0.aNoResulting reservoir volume, includes both the start volume and the final end volume in the optimization.
reservoirsim_storagetimeseriesOutputNoMM3None/nullSHOP_OPEN13.2.0.aNoSimulated reservoir volume.
reservoirleveltimeseriesOutputNoMETERNone/nullSHOP_OPEN13.0.0.aNoResulting reservoir water level (meter above sea level), calculated by converting the volume of the reservoir with the vol_level curve.
reservoirareatimeseriesOutputNoKM2None/nullSHOP_OPEN14.6.0.0NoResulting reservoir surface area (km2), used to calculate evaporation.
reservoirsim_leveltimeseriesOutputNoMETERNone/nullSHOP_OPEN13.2.0.aNoSimulated reservoir water level (meter above sea level).
reservoirsim_inflowtimeseriesOutputNoM3/SNone/nullSHOP_OPEN13.2.0.aNoSimulated inflow to the reservoir that is calculated when the SHOP simulator is used to calculate inflow with the /inflow command option.
reservoirsim_water_surplustimeseriesOutputNoMM3None/nullSHOP_OPEN16.8.0NoSimulated reservoir volume that has been subtracted from the simulation to maintain the reservoir below the maximal volume defined in the vol_level curve. Similar to reservoir penalty from the optimization.
reservoirsim_water_deficittimeseriesOutputNoMM3None/nullSHOP_OPEN16.8.0NoSimulated reservoir volume that has been added from the simulation to maintain the reservoir above 0 Mm3. Similar to reservoir penalty from the optimization.
reservoirendpoint_penaltytimeseriesOutputNoMM3None/nullSHOP_OPEN13.0.0.aNoResulting penalty when the maximum or minimum volume limit for the reservoir at the end of the optimization period is violated.
reservoirpenaltytimeseriesOutputNoMM3None/nullSHOP_OPEN13.0.0.aNoResulting penalty when the maximum or minimum volume limit for the reservoir during the optimization period is violated.
reservoirtactical_penalty_uptimeseriesOutputNoMM3None/nullSHOP_TACTICAL_LIMIT13.0.0.aNoResulting penalty when the tactical maximum volume limit for the reservoir is violated.
reservoirtactical_penalty_downtimeseriesOutputNoMM3None/nullSHOP_TACTICAL_LIMIT13.0.0.aNoResulting penalty when the tactical minimum volume limit for the reservoir is violated.
reservoirend_penaltytimeseriesOutputNoNOKNone/nullSHOP_OPEN13.0.0.aNoResulting penalty cost when the maximum or minimum volume limit for the reservoir at the end of the optimization period is violated.
reservoirpenalty_noktimeseriesOutputNoNOKNone/nullSHOP_OPEN13.0.0.aNoResulting penalty cost when the maximum or minimum volume limit for the reservoir during the optimization period is violated.
reservoirtactical_penaltytimeseriesOutputNoNOKNone/nullSHOP_OPEN13.0.0.aNoResulting penalty cost when the tactical maximum or minimum volume limit for the reservoir is violated.
reservoirwater_value_global_resulttimeseriesOutputNoNOK/MM3None/nullSHOP_OPEN13.0.0.aNoMarginal cost of 1 Mm3 of the water in the reservoir calculated using the sum of the best efficiency point of all cascaded plants below this reservoir.
reservoirwater_value_local_resulttimeseriesOutputNoNOK/MM3None/nullSHOP_OPEN13.0.0.aNoMarginal cost of 1 Mm3 of the water discharged from the reservoir through the downstream plant.
reservoirenergy_value_local_resulttimeseriesOutputNoNOK/MWHNone/nullSHOP_OPEN13.0.0.aNoMarginal cost of 1 MWh power that generated from the water in the reservoir through the downstream plant.
reservoirend_valuetimeseriesOutputNoNOKNone/nullSHOP_OPEN13.0.0.aNoValue of reservoir contents at the end of the optimization period.
reservoirchange_in_end_valuetimeseriesOutputNoNOKNone/nullSHOP_OPEN13.0.0.aNoRelative change in value of reservoir contents between the start and the end of the optimization horizon.
reservoirvow_in_transittimeseriesOutputNoNOKNone/nullSHOP_OPEN13.0.0.aNoValue of delayed water on its way to this reservoir after the end of the optimization period.
reservoircalc_global_water_valuedoubleOutputNoNOK/MM30.0SHOP_OPEN14.0.0.1NoThe resulting global water value of the reservoir after the local energy value has been converted internally based on the energy_conversion_factor reservoir attribute.
reservoirenergy_conversion_factordoubleOutputNoMWH/MM30.0SHOP_OPEN14.0.0.1NoThe calculated conversion factor between MWh and Mm3 based on the first plant below the reservoir and initial start head.
reservoirglobal_energy_conversion_factordoubleOutputNoMWH/MM30.0SHOP_OPEN18.4.0NoThe total calculated energy conversion factor for this reservoir all the way down to sea. Based on the energy_conversion_factor of the reservoir and all subsequent reservoirs in the watercourse and initial start head.
reservoirwater_value_cut_resultxy_arrayOutputNox: MM3 and y: NOK/MM3None/nullSHOP_SCENARIO_FUNCTIONALITY14.0.0.1NoThe resulting output water value cut coefficients when SHOP is used to create cuts.
reservoiradded_to_networkintOutputNoNO_UNIT0SHOP_TUNNEL13.0.0.aNoFlag determining whether the model has determined that this reservoir is part of a tunnel network.
reservoirnetwork_nointOutputNoNO_UNIT0SHOP_TUNNEL13.0.0.aNoNetwork identification number set by the model to indicate which tunnel network this reservoir is part of.
reservoirpeak_volume_penaltytimeseriesOutputNoNOKNone/nullSHOP_FLOOD_SUPPORT14.0.1.1NoThe peak volume penalty incurred for the reservoir, zero in all time steps except for when the reservoir volume peak occurs.
reservoirflood_volume_penaltytimeseriesOutputNoNOKNone/nullSHOP_FLOOD_SUPPORT14.2.2.0NoThe penalty incurred for the reservoir based on the optimized reservoir volume and the flood_volume_cost_curve.
reservoirphysical_spilldoubleOutputNoMM30.0SHOP_OPEN18.3.0NoThe 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 reservoir.
reservoirnonphysical_spilldoubleOutputNoMM30.0SHOP_OPEN18.3.0NoThe 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 reservoir.
plantnum_genintOutputNoNO_UNIT0SHOP_OPEN13.0.0.aNoNumber of generators in the plant.
plantnum_pumpintOutputNoNO_UNIT0SHOP_OPEN13.0.0.aNoNumber of pumps in the plant.
plantless_distribution_epsdoubleInputNoNO_UNIT0.001SHOP_OPEN13.0.0.aNoThe tolerance level for heuristically distributing discharge on generators.
plantlatitudedoubleInputNoNO_UNIT0.0SHOP_OPEN13.0.0.aNoReserved for future use.
plantlongitudedoubleInputNoNO_UNIT0.0SHOP_OPEN13.0.0.aNoReserved for future use.
plantpower_head_optimization_factordoubleInputNoNO_UNIT1.0SHOP_OPEN15.5.0.0NoIndividual scale factor for plant power head optimization.
plantexclude_from_bp_calculationsintInputNoNO_UNIT0SHOP_OPEN17.15.0NoSetting this attribute to 1 will skip the plant in the Best Profit calculations.
plantownershipdoubleInputNo%100.0SHOP_OWNERSHIP13.0.0.aNoPercentage of ownership of plant in case of shared ownership. Used to scale generator efficiency curves accordingly.
plantprod_areatimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aYesDeprecated: use a busbar object per price area and connect the appropriate units and markets to the busbars. Production from this plant will be sold in markets connected to the given price area.
plantprod_area_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aNoDeprecated: use a busbar object per price area and connect the appropriate units and markets to the busbars. Flag determining whether production area connection should be included in the optimization model.
plantprod_factordoubleInputNoKWH/MM30.0SHOP_OPEN13.0.0.aNoOptional fixed production factor for the plant in KWh/m3, which is used to convert between NOK/MWh and NOK/Mm3. If this is not specified (value of 0.0), SHOP will calculate a production factor for the plant based on best point operation given the initial plant head.
plantoutlet_linedoubleInputNoMETER0.0SHOP_OPEN13.0.0.aNoThe level (meter above sea level) of the outlet tunnel from the plant.
plantintake_linetimeseriesInputNoMETERNone/nullSHOP_EXTENDED_PUMP_FUNCTIONALITY13.0.0.aNoMinimum upper level used to calculate the height the pump must lift water to. The upper reservoir water level is used if it is above the value of intake_line.
plantmain_lossdouble_arrayInputYesS2/M5None/nullSHOP_OPEN13.0.0.aNoThe loss factor for the main tunnel of the plant. Loss is assumed to be a quadratic function of flow.
plantpenstock_lossdouble_arrayInputYesS2/M5None/nullSHOP_OPEN13.0.0.aNoThe list of loss factors for the penstocks of the plant, multiple units may share a penstock. Loss is assumed to be a quadratic function of flow.
planttailrace_lossxy_arrayInputNox: M3/S and y: METERNone/nullSHOP_OPEN13.0.0.aNoThe head loss curve for the tailrace of the plant which can be modelled as an additional head loss related to the discharge of the plant (and bypass if intake_loss_from_bypass_flag is active). Each XY curve is referred to a downstream level in masl.
planttailrace_loss_from_bypass_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aNoFlag determining whether bypass discharge should be included in the calculation of tailrace loss for the plant. If the flag is zero or not set, only plant discharge is used to calculate tailrace loss. If the flag is 1, the flow in the rivers and the discharge in the bypass gates that carry water past the plant are counted towards the tailrace loss calculation in addition to the plant discharge. When the plant discharges into a river, SHOP uses the flow at the top of the first river downstream where the plant discharge meets other water, since this is where the total flow in the watercourse just below the plant is found. If the plant discharges into a reservoir, all bypass gates and all rivers that discharge into this reservoir are counted. The rivers that are used can be given explicitly with the tailrace_loss_river_names attribute.
planttailrace_loss_river_namesstring_arrayInputNoSTRINGNone/nullSHOP_OPEN18.5.0NoNames of the rivers whose flow at the top of the river should be used as bypass flow when calculating tailrace loss for the plant, used instead of the rivers SHOP identifies from the topology. The plant discharge is subtracted from the sum of the flow in these rivers if the plant discharges into one of them or into a river above one of them. Only relevant if tailrace_loss_from_bypass_flag is set to 1. Leave empty to let SHOP find the rivers from the topology, and see the log for the rivers and gates that are used. Naming two rivers where one flows into the other counts the water in between twice and is warned about.
plantintake_lossxy_arrayInputNox: M3/S and y: METERNone/nullSHOP_OPEN13.0.0.aNoThe head loss curve for the intake of the plant which can be modelled as an additional head loss related to the discharge of the plant (and bypass if intake_loss_from_bypass_flag is active). Each XY curve is referred to an upstream level in masl.
plantintake_loss_from_bypass_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aNoFlag determining whether bypass discharge should be included in the calculation of intake loss for the plant. If the flag is zero or not set, only plant discharge is used to calculate intake loss. If the flag is 1 and the plant is connected to an upstream reservoir, all bypass gates and all rivers that discharge out of this reservoir are counted towards the intake loss calculation in addition to the plant discharge. The rivers that are used can be given explicitly with the intake_loss_river_names attribute.
plantintake_loss_river_namesstring_arrayInputNoSTRINGNone/nullSHOP_OPEN18.5.0NoNames of the rivers whose flow at the top of the river should be used as bypass flow when calculating intake loss for the plant, used instead of the rivers flowing out of the reservoir above the plant that SHOP identifies from the topology. Only relevant if intake_loss_from_bypass_flag is set to 1. Leave empty to let SHOP find the rivers from the topology, and see the log for the rivers and gates that are used.
planttidestimeseriesInputNoDELTA_METERNone/nullSHOP_OPEN13.0.0.aNoThe change of plant head related to tides.
planttime_delayintInputNoNO_UNIT0SHOP_OPEN13.0.0.aNoDeprecated: All time delay should be modelled by using the river object (does not require additional license). The delay between the water leaving the plant and until it ends up in the downstream reservoir.
plantshape_dischargexyInputNox: HOUR and y: NO_UNITNone/nullSHOP_DYNAMIC_DELAY13.0.0.aNoDeprecated: All time delay should be modelled by using the river object (does not require additional license). Describes the shape of the delayed discharge as a wave function of ratios per time step.
plantdischarge_feetimeseriesInputNoNOK/MM3None/nullSHOP_OPEN13.0.0.aYesExtra cost for plant discharge referring to the time when it was discharged by the plant.
plantdischarge_fee_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aNoFlag determining whether the discharge fee should be included in the optimization model.
plantdischarge_cost_curvexyInputNox: M3/S and y: NOK/H/M3/SNone/nullSHOP_BLOCK_MERGE13.0.0.aNoExtra cost depending on the discharge of the plant.
plantfeeding_feetimeseriesInputNoNOK/MWHNone/nullSHOP_FEEDING_FEE13.0.0.aYesExtra cost for feeding electricity into the grid. The feeding fee is added as an extra production cost in the objective function.
plantfeeding_fee_flagtimeseriesInputNoNO_UNITNone/nullSHOP_FEEDING_FEE13.0.0.aNoFlag determining whether the feed-in fee should be included in the optimization model.
plantproduction_feetimeseriesInputNoNOK/MWHNone/nullSHOP_CONSUMPTION_FEE13.0.0.aYesFee that is used to reduce the sale price for energy delivered by this plant.
plantproduction_fee_flagtimeseriesInputNoNO_UNITNone/nullSHOP_CONSUMPTION_FEE13.0.0.aNoFlag determining whether the production fee should be included in the optimization model.
plantconsumption_feetimeseriesInputNoNOK/MWHNone/nullSHOP_CONSUMPTION_FEE13.0.0.aYesFee that is used to increase the buy price for energy consumed by this plant.
plantconsumption_fee_flagtimeseriesInputNoNO_UNITNone/nullSHOP_CONSUMPTION_FEE13.0.0.aNoFlag determining whether the consumption fee should be included in the optimization model.
plantlinear_startup_flagtimeseriesInputNoNO_UNITNone/nullSHOP_SCENARIO_FUNCTIONALITY13.0.0.aNoFlag determining whether the plant should have linear startup costs when MIP is not active.
plantmaintenance_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN14.0.0.1NoFlag determining whether the plant is out for maintenance or not.
plantmip_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aNoFlag determining for which time steps to use binary variables to model generator startup and min production.
plantmip_lengthtimeseriesInputNoNO_UNITNone/nullSHOP_FLEX_MIP13.0.0.aYesSet the binary variable length to another value other than the default length of one time step.
plantmip_length_flagtimeseriesInputNoNO_UNITNone/nullSHOP_FLEX_MIP13.0.0.aNoFlag determining whether the mip_length should be included in the optimization model.
plantgen_priorityint_arrayInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aNoPrioritization for startup order of generators. If no generators have timeseries priority, use this static generator priority. Use positive values to set priority. Value 0 means that no priority has been defined.
plantn_seg_downtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aNoThe number of segments below the best efficiency point of the unit in the building of original PQ curve in incremental mode.
plantn_seg_uptimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aNoThe number of segments above the best efficiency point of the unit in the building of original PQ curve in incremental mode.
plantn_mip_seg_downtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aNoThe number of segments below the best efficiency point of the unit in the building of original PQ curve in full mode.
plantn_mip_seg_uptimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aNoThe number of segments below the best efficiency point of the unit in the building of original PQ curve in full mode.
plantdyn_pq_seg_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aNoFlag determining whether dynamically define the segments in the building of the original PQ curve for all the units in this plant in incremental mode.
plantdyn_mip_pq_seg_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN14.0.0.1NoFlag determining whether dynamically define the segments in the building of the original PQ curve for all the units in this plant in full mode.
plantbuild_original_pq_curves_by_discharge_limitstimeseriesInputNoNO_UNITNone/nullSHOP_OPEN16.0.0YesFlag determining whether the original PQ curve should only consider only physical discharge-related limits or take into account all the operating limits.
plantmin_p_constrtimeseriesInputNoMWNone/nullSHOP_OPEN13.0.0.aYesTime-dependent minimum production limit for the plant.
plantmin_p_constr_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aNoFlag determining whether the time-dependent minimum production limit for the plant should be included in the optimization model. If the flag is set equal to 2, all downward FCR-N, FCR-D, FRR, and RR reserve capcity allocated on the generators in the plant is also included in the constraint.
plantmin_p_penalty_flagtimeseriesInputNoNO_UNITNone/nullSHOP_SOFT_CONSTRAINTS13.0.0.aNoFlag determining whether the time-dependent minimum production limit for the plant should be a hard or soft constraint: 0 = hard; 1 = soft.
plantmin_p_penalty_costtimeseriesInputNoNOK/MWHNone/nullSHOP_SOFT_CONSTRAINTS13.0.0.aYesGiven penalty cost for violating the time-dependent minimum production limit for the plant (if min_p_penalty_flag is set as 1).
plantmin_p_penalty_cost_flagtimeseriesInputNoNO_UNITNone/nullSHOP_SOFT_CONSTRAINTS13.0.0.aNoFlag determining whether the cost for violating the minimum production constraint should be included in the optimization model.
plantmax_p_constrtimeseriesInputNoMWNone/nullSHOP_OPEN13.0.0.aYesTime-dependent maximum production limit for the plant.
plantmax_p_constr_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aNoFlag determining whether the time-dependent maximum production limit for the plant should be included in the optimization model.
plantmax_p_penalty_flagtimeseriesInputNoNO_UNITNone/nullSHOP_SOFT_CONSTRAINTS13.0.0.aNoFlag determining whether the time-dependent maximum production limit for the plant should be a hard or soft constraint: 0 = hard; 1 = soft.
plantmax_p_penalty_costtimeseriesInputNoNOK/MWHNone/nullSHOP_SOFT_CONSTRAINTS13.0.0.aYesGiven penalty cost for violating the time-dependent maximum production limit for the plant (if max_p_penalty_flag is set as 1).
plantmax_p_penalty_cost_flagtimeseriesInputNoNO_UNITNone/nullSHOP_SOFT_CONSTRAINTS13.0.0.aNoFlag determining whether the cost for violating the maximum production constraint should be included in the optimization model.
plantmin_q_constrtimeseriesInputNoM3/SNone/nullSHOP_OPEN13.0.0.aYesTime-dependent minimum discharge limit for the plant.
plantmin_q_constr_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aNoFlag determining whether the time-dependent minimum discharge limit for the plant should be included in the optimization.
plantmin_q_penalty_flagtimeseriesInputNoNO_UNITNone/nullSHOP_SOFT_CONSTRAINTS13.0.0.aNoFlag determining whether the time-dependent minimum discharge limit for the plant should be a hard or soft constraint: 0 = hard; 1 = soft.
plantmin_q_penalty_costtimeseriesInputNoNOK/MM3None/nullSHOP_SOFT_CONSTRAINTS13.0.0.aYesGiven penalty cost for violating the time-dependent minimum discharge limit for the plant (if min_q_penalty_flag is set as 1).
plantmin_q_penalty_cost_flagtimeseriesInputNoNO_UNITNone/nullSHOP_SOFT_CONSTRAINTS13.0.0.aNoFlag determining whether the cost for violating the minimum discharge constraint should be included in the optimization model.
plantmax_q_constrtimeseriesInputNoM3/SNone/nullSHOP_OPEN13.0.0.aYesTime-dependent maximum discharge limit for the plant.
plantmax_q_constr_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aNoFlag determining whether the time-dependent maximum discharge limit for the plant should be included in the optimization model.
plantmax_q_penalty_flagtimeseriesInputNoNO_UNITNone/nullSHOP_SOFT_CONSTRAINTS13.0.0.aNoFlag determining whether the time-dependent maximum discharge limit for the plant should be a hard or soft constraint: 0 = hard; 1 = soft.
plantmax_q_penalty_costtimeseriesInputNoNOK/MM3None/nullSHOP_SOFT_CONSTRAINTS13.0.0.aYesGiven penalty cost for violating the time-dependent maximum discharge limit for the plant by (if max_q_penalty_flag is set as 1).
plantmax_q_penalty_cost_flagtimeseriesInputNoNO_UNITNone/nullSHOP_SOFT_CONSTRAINTS13.0.0.aNoFlag determining whether the cost for violating the maximum discharge constraint should be included in the optimization model.
plantmax_q_limit_rsv_upxyInputNox: METER and y: M3/SNone/nullSHOP_OPEN13.0.0.aNoMaximum plant discharge limit (m3/s) and upstream reservoir water level (meter above sea level) relation.
plantmax_q_limit_rsv_downxyInputNox: METER and y: M3/SNone/nullSHOP_OPEN13.0.0.aNoMaximum plant discharge limit (m3/s) and downstream reservoir water level (meter above sea level) relation.
plantproduction_scheduletimeseriesInputNoMWNone/nullSHOP_OPEN13.0.0.aYesPlant production schedule.
plantproduction_schedule_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aNoFlag determining whether the plant production schedule should be included in the optimization model.
plantdischarge_scheduletimeseriesInputNoM3/SNone/nullSHOP_OPEN13.0.0.aYesDischarge schedule.
plantdischarge_schedule_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aNoFlag determining whether the plant discharge schedule should be included in the optimization model.
plantconsumption_scheduletimeseriesInputNoMWNone/nullSHOP_OPEN13.0.0.aYesPlant consumption schedule.
plantconsumption_schedule_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aNoFlag determining whether the plant consumption schedule should be included in the optimization model.
plantupflow_scheduletimeseriesInputNoM3/SNone/nullSHOP_OPEN13.0.0.aYesPlant upflow schedule.
plantupflow_schedule_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aNoFlag determining whether the plant upflow schedule should be included in the optimization model.
plantsched_penalty_cost_downdoubleInputNoNOKSHOP_SOFT_CONSTRAINTS13.0.0.aYesGiven penalty cost for deviating below the plant schedule.
plantsched_penalty_cost_updoubleInputNoNOKSHOP_SOFT_CONSTRAINTS13.0.0.aYesGiven penalty cost for deviating above the plant schedule.
plantpower_ramping_uptimeseriesInputNoMW_HOURNone/nullSHOP_OPEN13.0.0.aYesMaximum limit for increase in plant production per hour.
plantpower_ramping_downtimeseriesInputNoMW_HOURNone/nullSHOP_OPEN13.0.0.aYesMaximum limit for decrease in plant production per hour.
plantdischarge_ramping_uptimeseriesInputNoM3SEC_HOURNone/nullSHOP_OPEN13.0.0.aYesMaximum limit for increase in plant discharge per hour.
plantdischarge_ramping_downtimeseriesInputNoM3SEC_HOURNone/nullSHOP_OPEN13.0.0.aYesMaximum limit for decrease in plant discharge per hour.
plantblock_merge_tolerancetimeseriesInputNoMWNone/nullSHOP_OPEN13.0.0.aYesMaximum deviation in production between two time steps that allows SHOP to force these hours to have the same production in later iterations.
plantblock_generation_mwhtimeseriesInputNoMINUTENone/nullSHOP_BLOCK_GENERATION13.0.0.aNoGives a constant production for the plant in one or more blocks of time steps. The t-value denotes the time of the block start and the y-value the block length in minutes. The block length is repeated until a new t-value and corresponding y-value is given.
plantblock_generation_m3stimeseriesInputNoMINUTENone/nullSHOP_BLOCK_GENERATION13.0.0.aNoGives a constant discharge for the plant in one or more blocks of time steps. The t-value denotes the time of the block start and the y-value the block length in minutes. The block length is repeated until a new t-value and corresponding y-value is given.
plantfrr_up_mintimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesMinimum FRR_UP delivery for the plant.
plantfrr_up_maxtimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesMaximum FRR_UP delivery for the plant.
plantfrr_down_mintimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesMinimum FRR_DOWN delivery for the plant.
plantfrr_down_maxtimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesMaximum FRR_DOWN delivery for the plant.
plantrr_up_mintimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesMinimum RR_UP delivery for the plant.
plantrr_down_mintimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP15.5.3.0YesMinimum RR_DOWN delivery for the plant.
plantfrr_symmetric_flagtimeseriesInputNoNO_UNITNone/nullSHOP_RESERVE_GROUP13.0.0.aNoFlag determining whether all the generators in the plant should deliver both FRR_UP and FRR_DOWN as long as they are assigned for the FRR reserve.
plantbp_dyn_wv_flagtimeseriesInputNoNO_UNITNone/nullSHOP_BEST_PROFIT13.0.0.aNoFlag determining whether water values in the best profit calculation should be based on dynamic results per time step from the optimization or the static end value description.
plantref_prodtimeseriesOutputNoMWNone/nullSHOP_BEST_PROFIT13.0.0.aNoProduction of the plant indicating the planned operating point as starting point for the best profit calculation.
plantplant_unbalance_recommittimeseriesInputNoNO_UNITNone/nullSHOP_OPEN14.0.0.1NoFlag determining whether the generators in the plant should be recommitted when the optimization model changes from full mode to incremental mode and the resulting plant discharge is smaller than the optimal discharge from solver.
plantspinning_reserve_up_maxtimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP14.3.5.0YesSets a maximum limit for the sum of spinning reserves delivered in the upward direction for the plant. The sum ranges over reserves delivered on all generators and pumps in the plant.
plantspinning_reserve_down_maxtimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP14.3.5.0YesSets a maximum limit for the sum of spinning reserves delivered in the downward direction for the plant. The sum ranges over reserves delivered on all generators and pumps in the plant.
plantramping_stepsxy_arrayInputNox: MW and y: MW_HOURNone/nullSHOP_RAMP_STEP15.0.1.0NoX-value: Defines the production steps with different ramping values (p_max of the plant should be the final value). Y-value: Maximum change in production per hour if the production in the previous time step is in this ramping interval. Ref: Select which series to use based on input from ramping_step_reference_discharge. Changed from xy to xy_array from 15.3.4.0.
plantramping_steps_upxy_arrayInputNox: MW and y: MW_HOURNone/nullSHOP_RAMP_STEP17.16.0NoSame as the ramping_steps attribute, but only applies ramping constraints in the upward direction. The ramping_steps attribute is preferred over this attribute if both are defined, and the ramping_steps_direction attribute has no effect when using this attribute.
plantramping_steps_downxy_arrayInputNox: MW and y: MW_HOURNone/nullSHOP_RAMP_STEP17.16.0NoSame as the ramping_steps attribute, but only applies ramping constraints in the downward direction. The ramping_steps attribute is preferred over this attribute if both are defined, and ramping_steps_direction attribute has no effect when using this attribute.
plantramping_steps_directionstringInputNoSTRINGBOTHSHOP_RAMP_STEP17.7.0NoDecides whether the ramping_steps constraints should be applied in the upward direction (‘UP’), downward direction (‘DOWN’), or in both directions (‘BOTH’, default). Note that ramping_steps_up and ramping_steps_down can be used to apply different ramping limits upwards and downwards.
plantrelax_ramping_steps_on_shutdowntimeseriesInputNoNO_UNITNone/nullSHOP_OPEN17.6.0NoSpecifies whether the stepwise ramping defined by the XYN attribute ramping_steps should be relaxed when units are shutting down. If the attribute is set to 1, the generators are allowed to shut down even though it would violate the ramping constraints.
plantrelax_ramping_steps_on_startuptimeseriesInputNoNO_UNITNone/nullSHOP_OPEN17.6.0NoSpecifies whether the stepwise ramping defined by the XYN attribute ramping_steps should be relaxed when units are starting up. If the attribute is set to 1, the generators are allowed to start up even though it would violate the ramping constraints.
plantdischarge_rolling_ramping_penalty_costtimeseriesInputNoNOK/M3/SNone/nullSHOP_COMPLEX_RAMPING15.2.0.0NoThe penalty cost for breaking any rolling ramping constraint applied to the plant discharge.
plantdischarge_period_ramping_penalty_costtimeseriesInputNoNOK/M3/SNone/nullSHOP_COMPLEX_RAMPING15.2.0.0NoThe penalty cost for breaking any period ramping constraint applied to the plant discharge.
plantaverage_discharge_rolling_ramping_upxytInputNox: MINUTE and y: M3/SNone/nullSHOP_COMPLEX_RAMPING15.2.0.0YesInput to specify rolling ramping constraints that constrain the plant discharge upwards from the average plant discharge in a rolling time window. The x-values represent the length of the rolling time window and the y-values specify the number of meters the plant discharge can increase above the average rolling discharge. Each (x, y) point in each XY curve represents a rolling ramping constraint.
plantaverage_discharge_rolling_ramping_downxytInputNox: MINUTE and y: M3/SNone/nullSHOP_COMPLEX_RAMPING15.2.0.0YesInput to specify rolling ramping constraints that constrain the plant discharge downwards from the average plant discharge in a rolling time window. The x-values represent the length of the rolling time window and the y-values specify the number of meters the plant discharge can decrease below the average rolling discharge. Each (x, y) point in each XY curve represents a rolling ramping constraint.
plantlimit_discharge_rolling_ramping_upxytInputNox: MINUTE and y: M3/SNone/nullSHOP_COMPLEX_RAMPING15.2.0.0YesInput to specify rolling ramping constraints that constrain the plant discharge upwards from the minimal plant discharge in a rolling time window. The x-values represent the length of the rolling time window and the y-values specify the number of meters the plant discharge can increase above the minimal rolling discharge. Each (x, y) point in each XY curve represents a rolling ramping constraint.
plantlimit_discharge_rolling_ramping_downxytInputNox: MINUTE and y: M3/SNone/nullSHOP_COMPLEX_RAMPING15.2.0.0YesInput to specify rolling ramping constraints that constrain the plant discharge downwards from the maximal plant discharge in a rolling time window. The x-values represent the length of the rolling time window and the y-values specify the number of meters the plant discharge can decrease below the maximal rolling discharge. Each (x, y) point in each XY curve represents a rolling ramping constraint.
plantaverage_discharge_period_ramping_upxytInputNox: MINUTE and y: M3/SNone/nullSHOP_COMPLEX_RAMPING15.2.0.0YesInput to specify period ramping constraints that constrain the plant discharge upwards from the average plant discharge in a fixed time window. The x-values represent the length of the fixed time window and the y-values specify the number of meters the plant discharge can increase above the average discharge in the previous fixed time period. Each (x, y) point in each XY curve represents a period ramping constraint.
plantaverage_discharge_period_ramping_downxytInputNox: MINUTE and y: M3/SNone/nullSHOP_COMPLEX_RAMPING15.2.0.0YesInput to specify period ramping constraints that constrain the plant discharge downwards from the average plant discharge in a fixed time window. The x-values represent the length of the fixed time window and the y-values specify the number of meters the plant discharge can decrease below the average discharge in the previous fixed time period. Each (x, y) point in each XY curve represents a period ramping constraint.
plantlimit_discharge_period_ramping_upxytInputNox: MINUTE and y: M3/SNone/nullSHOP_COMPLEX_RAMPING15.2.0.0YesInput to specify period ramping constraints that constrain the plant discharge upwards from the minimal plant discharge in a fixed time window. The x-values represent the length of the fixed time window and the y-values specify the number of meters the plant discharge can increase above the minimal discharge in the previous fixed time period. Each (x, y) point in each XY curve represents a period ramping constraint.
plantlimit_discharge_period_ramping_downxytInputNox: MINUTE and y: M3/SNone/nullSHOP_COMPLEX_RAMPING15.2.0.0YesInput to specify period ramping constraints that constrain the plant discharge downwards from the maximal plant discharge in a fixed time window. The x-values represent the length of the fixed time window and the y-values specify the number of meters the plant discharge can decrease below the maximal discharge in the previous fixed time period. Each (x, y) point in each XY curve represents a period ramping constraint.
planthistorical_dischargetimeseriesInputNoM3/SNone/nullSHOP_OPEN15.2.0.0NoThe plant discharge for times before the optimization start, values after the start time of the optimization are ignored. The datatype of this attribute changed from XY to timeseries in version 15.3.1.0. historical_discharge on the connected generators will be used if this is not specified.
plantaverage_discharge_period_ramping_up_offsetsyInputNos: STRING and y: MINUTENone/nullSHOP_COMPLEX_RAMPING15.3.3.0NoThe y-values must be the same as the period lengths used in the average_discharge_period_ramping_up attribute, while the strings are timestamps that specify when the first whole ramping period starts for each of the average ramping up period constraints.
plantaverage_discharge_period_ramping_down_offsetsyInputNos: STRING and y: MINUTENone/nullSHOP_COMPLEX_RAMPING15.3.3.0NoThe y-values must be the same as the period lengths used in the average_discharge_period_ramping_down attribute, while the strings are timestamps that specify when the first whole ramping period starts for each of the average ramping down period constraints.
plantlimit_discharge_period_ramping_up_offsetsyInputNos: STRING and y: MINUTENone/nullSHOP_COMPLEX_RAMPING15.3.3.0NoThe y-values must be the same as the period lengths used in the limit_discharge_period_ramping_up attribute, while the strings are timestamps that specify when the first whole ramping period starts for each of the limit ramping up period constraints.
plantlimit_discharge_period_ramping_down_offsetsyInputNos: STRING and y: MINUTENone/nullSHOP_COMPLEX_RAMPING15.3.3.0NoThe y-values must be the same as the period lengths used in the limit_discharge_period_ramping_down attribute, while the strings are timestamps that specify when the first whole ramping period starts for each of the limit ramping down period constraints.
plantfcr_n_up_activation_timedoubleInputNoHOUR-1.0SHOP_RESERVE_GROUP15.3.0.0NoThe number of hours that one expects the FCR-N up reserves allocated on the units of the plant to be activated. The default value of -1 will ignore the activation factor and instead use the activation factor on global_settings.
plantfcr_n_down_activation_timedoubleInputNoHOUR-1.0SHOP_RESERVE_GROUP15.3.0.0NoThe number of hours that one expects the FCR-N down reserves allocated on the units of the plant to be activated. The default value of -1 will ignore the activation factor and instead use the activation factor on global_settings.
plantfcr_d_up_activation_timedoubleInputNoHOUR-1.0SHOP_RESERVE_GROUP15.3.0.0NoThe number of hours that one expects the FCR-D up reserves allocated on the units of the plant to be activated. The default value of -1 will ignore the activation factor and instead use the activation factor on global_settings.
plantfcr_d_down_activation_timedoubleInputNoHOUR-1.0SHOP_RESERVE_GROUP15.3.0.0NoThe number of hours that one expects the FCR-D down reserves allocated on the units of the plant to be activated. The default value of -1 will ignore the activation factor and instead use the activation factor on global_settings.
plantfrr_up_activation_timedoubleInputNoHOUR-1.0SHOP_RESERVE_GROUP15.3.0.0NoThe number of hours that one expects the FRR up reserves allocated on the units of the plant to be activated. The default value of -1 will ignore the activation factor and instead use the activation factor on global_settings.
plantfrr_down_activation_timedoubleInputNoHOUR-1.0SHOP_RESERVE_GROUP15.3.0.0NoThe number of hours that one expects the FRR down reserves allocated on the units of the plant to be activated. The default value of -1 will ignore the activation factor and instead use the activation factor on global_settings.
plantrr_up_activation_timedoubleInputNoHOUR-1.0SHOP_RESERVE_GROUP15.3.0.0NoThe number of hours that one expects the RR up reserves allocated on the units of the plant to be activated. The default value of -1 will ignore the activation factor and instead use the activation factor on global_settings.
plantrr_down_activation_timedoubleInputNoHOUR-1.0SHOP_RESERVE_GROUP15.3.0.0NoThe number of hours that one expects the RR down reserves allocated on the units of the plant to be activated. The default value of -1 will ignore the activation factor and instead use the activation factor on global_settings.
plantfcr_n_up_activation_factortimeseriesInputNoNO_UNITNone/nullSHOP_RESERVE_GROUP15.3.0.0YesThe fraction (between 0.0 and 1.0) of the allocated FCR-N up reserves on the units of the plant that is expected to be activated.
plantfcr_n_down_activation_factortimeseriesInputNoNO_UNITNone/nullSHOP_RESERVE_GROUP15.3.0.0YesThe fraction (between 0.0 and 1.0) of the allocated FCR-N down reserves on the units of the plant that is expected to be activated.
plantfcr_d_up_activation_factortimeseriesInputNoNO_UNITNone/nullSHOP_RESERVE_GROUP15.3.0.0YesThe fraction (between 0.0 and 1.0) of the allocated FCR-D up reserves on the units of the plant that is expected to be activated.
plantfcr_d_down_activation_factortimeseriesInputNoNO_UNITNone/nullSHOP_RESERVE_GROUP15.3.0.0YesThe fraction (between 0.0 and 1.0) of the allocated FCR-D down reserves on the units of the plant that is expected to be activated.
plantfrr_up_activation_factortimeseriesInputNoNO_UNITNone/nullSHOP_RESERVE_GROUP15.3.0.0YesThe fraction (between 0.0 and 1.0) of the allocated FRR up reserves on the units of the plant that is expected to be activated.
plantfrr_down_activation_factortimeseriesInputNoNO_UNITNone/nullSHOP_RESERVE_GROUP15.3.0.0YesThe fraction (between 0.0 and 1.0) of the allocated FRR down reserves on the units of the plant that is expected to be activated.
plantrr_up_activation_factortimeseriesInputNoNO_UNITNone/nullSHOP_RESERVE_GROUP15.3.0.0YesThe fraction (between 0.0 and 1.0) of the allocated RR up reserves on the units of the plant that is expected to be activated.
plantrr_down_activation_factortimeseriesInputNoNO_UNITNone/nullSHOP_RESERVE_GROUP15.3.0.0YesThe fraction (between 0.0 and 1.0) of the allocated RR down reserves on the units of the plant that is expected to be activated.
plantfcr_n_up_activation_penalty_costtimeseriesInputNoNOK/MM3None/nullSHOP_RESERVE_GROUP15.3.0.0NoThe penalty cost for violating the reserve activation constraints caused by FCR-N up reserves on this plant.
plantfcr_n_down_activation_penalty_costtimeseriesInputNoNOK/MM3None/nullSHOP_RESERVE_GROUP15.3.0.0NoThe penalty cost for violating the reserve activation constraints caused by FCR-N down reserves on this plant.
plantfcr_d_up_activation_penalty_costtimeseriesInputNoNOK/MM3None/nullSHOP_RESERVE_GROUP15.3.0.0NoThe penalty cost for violating the reserve activation constraints caused by FCR-D up reserves on this plant.
plantfcr_d_down_activation_penalty_costtimeseriesInputNoNOK/MM3None/nullSHOP_RESERVE_GROUP15.3.0.0NoThe penalty cost for violating the reserve activation constraints caused by FCR-D down reserves on this plant.
plantfrr_up_activation_penalty_costtimeseriesInputNoNOK/MM3None/nullSHOP_RESERVE_GROUP15.3.0.0NoThe penalty cost for violating the reserve activation constraints caused by FRR up reserves on this plant.
plantfrr_down_activation_penalty_costtimeseriesInputNoNOK/MM3None/nullSHOP_RESERVE_GROUP15.3.0.0NoThe penalty cost for violating the reserve activation constraints caused by FRR down reserves on this plant.
plantrr_up_activation_penalty_costtimeseriesInputNoNOK/MM3None/nullSHOP_RESERVE_GROUP15.3.0.0NoThe penalty cost for violating the reserve activation constraints caused by RR up reserves on this plant.
plantrr_down_activation_penalty_costtimeseriesInputNoNOK/MM3None/nullSHOP_RESERVE_GROUP15.3.0.0NoThe penalty cost for violating the reserve activation constraints caused by RR down reserves on this plant.
plantsum_reserve_up_maxtimeseriesInputNoMWNone/nullSHOP_ADVANCED_RESERVE_ACTIVATION15.3.0.0YesSets a maximum limit for the sum of all upward reserve types delivered for the plant. The sum ranges over reserves delivered on all generators and pumps in the plant.
plantsum_reserve_down_maxtimeseriesInputNoMWNone/nullSHOP_ADVANCED_RESERVE_ACTIVATION15.3.0.0YesSets a maximum limit for the sum of all downward reserve types delivered for the plant. The sum ranges over reserves delivered on all generators and pumps in the plant.
plantmax_q_reserve_constrtimeseriesInputNoM3/SNone/nullSHOP_ADVANCED_RESERVE_ACTIVATION15.3.0.0YesThe maximal discharge allowed through the plant when potential upward reserve activation is considered in addition to the planned plant discharge.
plantmin_q_reserve_constrtimeseriesInputNoM3/SNone/nullSHOP_ADVANCED_RESERVE_ACTIVATION15.3.0.0YesThe minimal discharge allowed through the plant when potential downward reserve activation is considered in addition to the planned plant discharge.
plantmax_q_reserve_constr_penalty_costtimeseriesInputNoNOK/H/M3/SNone/nullSHOP_ADVANCED_RESERVE_ACTIVATION15.3.0.0NoThe penalty cost incurred for violating the max_q_reserve_constr constraint, the max_q_constr_penalty_cost is used otherwise.
plantmin_q_reserve_constr_penalty_costtimeseriesInputNoNOK/H/M3/SNone/nullSHOP_ADVANCED_RESERVE_ACTIVATION15.3.0.0NoThe penalty cost incurred for violating the min_q_reserve_constr constraint, the min_q_constr_penalty_cost is used otherwise.
plantsum_reserve_up_max_penalty_costtimeseriesInputNoNOK/MWHNone/nullSHOP_ADVANCED_RESERVE_ACTIVATION15.3.0.0NoThe penalty cost incurred for violating the sum_reserve_up_max constraint, the reserve_penalty_cost is used otherwise.
plantsum_reserve_down_max_penalty_costtimeseriesInputNoNOK/MWHNone/nullSHOP_ADVANCED_RESERVE_ACTIVATION15.3.0.0NoThe penalty cost incurred for violating the sum_reserve_down_max constraint, the reserve_penalty_cost is used otherwise.
plantreserve_tactical_activation_cost_scalingdoubleInputNoNO_UNIT-1.0SHOP_ADVANCED_RESERVE_ACTIVATION15.3.0.0NoThe penalty cost for violating the tactical reservoir volumes is decided by the reserve activation penalty cost scaled by this factor. If the default value of -1 is not changed, the reserve_tactical_activation_cost_scaling attribute on the global_settings object will be used instead.
plantcoupled_fcr_activation_flagtimeseriesInputNoNO_UNITNone/nullSHOP_ADVANCED_RESERVE_ACTIVATION15.3.0.0NoIf this flag is set to 1, 100% of the FCR-N reserves will be considered activated when building FCR-D reserve activation constraints for the reservoirs around this power plant.
plantramping_step_reference_dischargetimeseriesInputNoNO_UNITNone/nullSHOP_OPEN15.3.4.0NoIf multiple ramping steps XY curves are given, this timeseries decides which curve is used. The curve with reference that is both smaller than and closest to the timeseries value. If no curve references are smaller, the closest one will be used.
plantmin_uptimeintInputNoMINUTE0SHOP_MIN_UPTIME_DOWNTIME15.7.0.0NoMinimum up-time on plant level, given in whole minutes.
plantmin_downtimeintInputNoMINUTE0SHOP_MIN_UPTIME_DOWNTIME15.7.0.0NoMinimum down-time on plant level, given in whole minutes.
plantmin_uptime_flagtimeseriesInputNoNO_UNITNone/nullSHOP_MIN_UPTIME_DOWNTIME15.7.0.0NoFlag for turning on/off the minimum plant up-time constraints.
plantmin_downtime_flagtimeseriesInputNoNO_UNITNone/nullSHOP_MIN_UPTIME_DOWNTIME15.7.0.0NoFlag for turning on/off the minimum plant down-time constraints.
planthistorical_productiontimeseriesInputNoMWNone/nullSHOP_OPEN15.7.0.0NoThe plant production for times before the optimization start. If not provided, historical production on generator level is checked.
planthistorical_consumptiontimeseriesInputNoMWNone/nullSHOP_OPEN15.7.0.0NoThe plant consumption for times before the optimization start. If not provided, historical consumption on pump level is checked.
plantsimultanous_generating_pumping_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN16.0.0NoFlag determining whether simultanously generating and pumping is allowed in the plant. Default setting is 0 (not allowed).
plantmax_prod_reserve_strategystringInputNoSTRINGNOT SETSHOP_RESERVE_GROUP16.2.0NoOverrides the global_setting attribute ‘plant_max_prod_reserve_strategy’ if set to a value other than ‘NOT SET’ (default), see the documentation for ‘plant_max_prod_reserve_strategy’ for a description of the different strategies.
plantmin_prod_reserve_strategystringInputNoSTRINGNOT SETSHOP_RESERVE_GROUP16.2.0NoOverrides the global_setting attribute ‘plant_min_prod_reserve_strategy’ if set to a value other than ‘NOT SET’ (default), see the documentation for ‘plant_min_prod_reserve_strategy’ for a description of the different strategies.
plantmax_prod_reserve_penalty_costtimeseriesInputNoNOK/MWHNone/nullSHOP_RESERVE_GROUP16.2.0NoThe penalty cost for violating the maximum limits for plant production including upward reserve capacity created by ‘plant_max_prod_reserve_strategy’. If not specified, the penalty is the same as for violating the max_p_constr plant constraint.
plantmin_prod_reserve_penalty_costtimeseriesInputNoNOK/MWHNone/nullSHOP_RESERVE_GROUP16.2.1NoThe penalty cost for violating the minimum limits for plant production including downward reserve capacity created by ‘plant_min_prod_reserve_strategy’. If not specified, the penalty is the same as for violating the min_p_constr plant constraint.
plantstrict_pq_uploading_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN16.5.0NoIf this flag is set to 1 for a time step, strict uploading constraints using binary variables for each PQ curve segment can be built for all generators on the plant object. See the attribute description for strict_pq_uploading_upon_detection for more information about automatic selection of hours to build strict PQ curve uploading. No strict uploading constraints are built for time steps where the flag is set to zero, or if the flag is not defined (default).
plantstrict_pq_uploading_upon_detectionintInputNoNO_UNIT0SHOP_OPEN16.5.0NoSetting this attribute to 1 will turn on building of strict PQ curve uploading constraints for the genarators of the plant. These constraints will only be built if incorrrect uploading has been detected for the plant and time step in a previous iteration AND if the strict_pq_uploading_flag is set to 1. Building these constraints upon detection is turned off when this attribute is set to zero (default), which means that all hours where strict_pq_uploading_flag = 1 will include the constraints.
plantmin_consumptiontimeseriesInputNoMWNone/nullSHOP_OPEN17.8.0NoTime-dependent minimum consumption limit for the plant.
plantmin_consumption_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN17.8.0NoFlag determining whether the time-dependent minimum consumption limit for the plant should be included in the optimization model.
plantmin_consumption_penalty_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN17.8.0NoFlag determining whether the time-dependent minimum consumption limit for the plant should be a hard or soft constraint: 0 = hard; 1 = soft.
plantmin_consumption_penalty_costtimeseriesInputNoNOK/MWHNone/nullSHOP_OPEN17.8.0NoGiven penalty cost for violating the time-dependent minimum consumption limit for the plant (if min_p_penalty_flag is set as 1).
plantmax_consumptiontimeseriesInputNoMWNone/nullSHOP_OPEN17.8.0NoTime-dependent maximum consumption limit for the plant.
plantmax_consumption_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN17.8.0NoFlag determining whether the time-dependent maximum consumption limit for the plant should be included in the optimization model.
plantmax_consumption_penalty_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN17.8.0NoFlag determining whether the time-dependent maximum consumption limit for the plant should be a hard or soft constraint: 0 = hard; 1 = soft.
plantmax_consumption_penalty_costtimeseriesInputNoNOK/MWHNone/nullSHOP_OPEN17.8.0NoGiven penalty cost for violating the time-dependent maximum consumption limit for the plant (if min_p_penalty_flag is set as 1).
plantmin_upflowtimeseriesInputNoMWNone/nullSHOP_OPEN17.8.0NoTime-dependent minimum upflow limit for the plant.
plantmin_upflow_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN17.8.0NoFlag determining whether the time-dependent minimum upflow limit for the plant should be included in the optimization model.
plantmin_upflow_penalty_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN17.8.0NoFlag determining whether the time-dependent minimum upflow limit for the plant should be a hard or soft constraint: 0 = hard; 1 = soft.
plantmin_upflow_penalty_costtimeseriesInputNoNOK/MWHNone/nullSHOP_OPEN17.8.0NoGiven penalty cost for violating the time-dependent minimum upflow limit for the plant (if min_p_penalty_flag is set as 1).
plantmax_upflowtimeseriesInputNoMWNone/nullSHOP_OPEN17.8.0NoTime-dependent maximum upflow limit for the plant.
plantmax_upflow_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN17.8.0NoFlag determining whether the time-dependent maximum upflow limit for the plant should be included in the optimization model.
plantmax_upflow_penalty_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN17.8.0NoFlag determining whether the time-dependent maximum upflow limit for the plant should be a hard or soft constraint: 0 = hard; 1 = soft.
plantmax_upflow_penalty_costtimeseriesInputNoNOK/MWHNone/nullSHOP_OPEN17.8.0NoGiven penalty cost for violating the time-dependent maximum upflow limit for the plant (if min_p_penalty_flag is set as 1).
plantmin_consumption_include_reserves_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN17.8.0NoFlag determining whether reserves should be included in the minimum consumption constraints.
plantmax_consumption_include_reserves_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN17.8.0NoFlag determining whether reserves should be included in the maximum consumption constraints.
plantrr_up_maxtimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP17.17.0YesMaximum RR_UP delivery for the plant.
plantrr_down_maxtimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP17.17.0YesMaximum RR_DOWN delivery for the plant.
plantproductiontimeseriesOutputNoMWNone/nullSHOP_OPEN13.0.0.aNoResulting plant production, i.e. sum of resulting generator production.
plantsolver_productiontimeseriesOutputNoMWNone/nullSHOP_OPEN14.0.0.1NoPreliminary result for the sum of generator production that is returned by the linearized optimization problem.
plantsim_productiontimeseriesOutputNoMWNone/nullSHOP_OPEN13.2.0.aNoSimulated plant production.
plantprod_unbalancetimeseriesOutputNoMWNone/nullSHOP_OPEN13.0.0.aNoDifference between the result of the non-linear post-calculation (production) and the production determined by the linear optimization problem (solver_production).
plantconsumptiontimeseriesOutputNoMWNone/nullSHOP_OPEN13.0.0.aNoResulting plant consumption, i.e. sum of resulting pump consumption.
plantsim_consumptiontimeseriesOutputNoMWNone/nullSHOP_SIMULATION13.0.0.aNoSimulated plant consumption, i.e. sum of resulting pump consumption.
plantsolver_consumptiontimeseriesOutputNoMWNone/nullSHOP_OPEN14.0.0.1NoPreliminary result for the sum of pump consumption that is returned by the linearized optimization problem.
plantcons_unbalancetimeseriesOutputNoMWNone/nullSHOP_OPEN13.0.0.aNoDifference between the result of the non-linear post-calculation (consumption) and the consumption determined by the linear optimization problem (solver_consumption).
plantdischargetimeseriesOutputNoM3/SNone/nullSHOP_OPEN13.0.0.aNoResulting plant discharge, i.e. sum of resulting generator discharge.
plantsolver_dischargetimeseriesOutputNoM3/SNone/nullSHOP_OPEN14.0.0.1NoPreliminary result for the sum of generator discharge that is returned by the linearized optimization problem.
plantsim_dischargetimeseriesOutputNoM3/SNone/nullSHOP_OPEN13.2.0.aNoSimulated plant discharge.
plantupflowtimeseriesOutputNoM3/SNone/nullSHOP_OPEN13.0.0.aNoResulting plant upflow, i.e. sum of resulting pump upflow.
plantsim_upflowtimeseriesOutputNoM3/SNone/nullSHOP_SIMULATION13.0.0.aNoSimulated plant upflow, i.e. sum of resulting pump upflow.
plantsolver_upflowtimeseriesOutputNoM3/SNone/nullSHOP_OPEN14.0.0.1NoPreliminary result for the sum of pump upflow that is returned by the linearized optimization problem.
plantgross_headtimeseriesOutputNoMETERNone/nullSHOP_OPEN14.0.0.1NoPlant gross head, i.e. the difference between upstream reservoir water level and max(plant outlet_line, downstream reservoir water level).
planteff_headtimeseriesOutputNoMETERNone/nullSHOP_OPEN13.0.0.aNoResulting plant effective head. If overall generating, effective plant head is defined as the lowest eff_head of the generators. If overall pumping, effective plant head is defined as the highest eff_head of the pumps.
planthead_losstimeseriesOutputNoMETERNone/nullSHOP_OPEN13.0.0.aNoPlant head loss, i.e. the plant gross head minus the lowest effective head of the unit in the plant. If overall generating, plant head loss is positive. If overall pumping, plant head loss is negative.
plantmin_p_penaltytimeseriesOutputNoMWNone/nullSHOP_OPEN13.0.0.aNoResulting penalty when the time-dependent maximum production limit for the plant is violated.
plantmax_p_penaltytimeseriesOutputNoMWNone/nullSHOP_OPEN13.0.0.aNoResulting penalty when the time-dependent maximum production limit for the plant is violated.
plantmin_q_penaltytimeseriesOutputNoMM3None/nullSHOP_OPEN13.0.0.aNoResulting penalty when the time-dependent minimum discharge limit for the plant is violated.
plantmax_q_penaltytimeseriesOutputNoMM3None/nullSHOP_OPEN13.0.0.aNoResulting penalty when the time-dependent maximum discharge limit for the plant is violated.
plantp_constr_penaltytimeseriesOutputNoNOKNone/nullSHOP_OPEN13.0.0.aNoResulting penalty cost when the time-dependent maximum or minimum production limit for the plant is violated.
plantq_constr_penaltytimeseriesOutputNoNOKNone/nullSHOP_OPEN13.0.0.aNoResulting penalty cost when the time-dependent maximum or minimum discharge limit for the plant is violated.
plantschedule_up_penaltytimeseriesOutputNoNOKNone/nullSHOP_OPEN13.0.0.aNoResulting penalty when deviating above the plant schedule.
plantschedule_down_penaltytimeseriesOutputNoNOKNone/nullSHOP_OPEN13.0.0.aNoResulting penalty when deviating below the plant schedule.
plantschedule_penaltytimeseriesOutputNoNOKNone/nullSHOP_OPEN13.0.0.aNoResulting penalty cost for violation of the plant schedule.
plantmax_prod_alltimeseriesOutputNoMWNone/nullSHOP_OPEN15.2.1.0NoMaximum plant production if all generators not on maintenance in the plant are producing at maximum.
plantmax_prod_availabletimeseriesOutputNoMWNone/nullSHOP_OPEN16.1.0NoMaximum plant production if all generators not on maintenance or committed off in the plant are producing at maximum.
plantmax_prod_spinningtimeseriesOutputNoMWNone/nullSHOP_OPEN16.1.0NoMaximum plant production if all the spinning generators in the plant are producing at maximum.
plantmin_prod_spinningtimeseriesOutputNoMWNone/nullSHOP_OPEN16.1.0NoMinimum plant production if all the spinning generators in the plant are producing at minimum.
plantbest_profit_qxytOutputNox: MW and y: M3/SNone/nullSHOP_BEST_PROFIT13.0.0.aNoPlant discharge after changing the production of the plant from the current operating point to a new point in the best profit curve of the plant. Created after the command ‘create bp_curves’ has been performed.
plantbest_profit_mcxytOutputNox: MW and y: NOK/MWNone/nullSHOP_BEST_PROFIT13.0.0.aNoMarginal production cost after changing the production of the plant from the current operating point to a new point in the best profit curve of the plant. Created after the command ‘create bp_curves’ has been performed.
plantbest_profit_acxytOutputNox: MW and y: NOK/MWNone/nullSHOP_BEST_PROFIT13.0.0.aNoAverage production cost after changing the production of the plant from the current operating point to a new point in the best profit curve of the plant. Created after the command ‘create bp_curves’ has been performed.
plantbest_profit_commitment_costxytOutputNox: MW and y: NOKNone/nullSHOP_BEST_PROFIT13.5.4.eNoSum of startup costs or shutdown costs after changing the production of the plant from the current operating point to a new point in the best profit curve of the plant. Created after the command ‘create bp_curves’ has been performed.
plantbest_profit_bid_matrixxytOutputNox: MW and y: NOK/MWNone/nullSHOP_BEST_PROFIT14.2.2.0NoA plant bid matrix created by reducing the best_profit_mc curves when the command ‘print bp_bid_matrix’ is called. The maximum number of price columns in the bid matrix is set by the attribute bp_bid_matrix_points on the global_settings object.
planttimes_of_wrong_pq_uploadingintOutputNoNO_UNIT0SHOP_OPEN14.0.0.9NoHow many times the unit PQ segments are wrongly uploaded, i.e. the latter segments are fulfilled first.
plantmax_prod_reserve_violationtimeseriesOutputNoMWNone/nullSHOP_OPEN16.2.0NoThe violation of the maximum limit for plant production including upward reserve capacity that is created by choosing a plant_max_prod_reserve_strategy.
plantmin_prod_reserve_violationtimeseriesOutputNoMWNone/nullSHOP_OPEN16.2.0NoThe violation of the minimum limit for plant production including downward reserve capacity that is created by choosing a plant_min_prod_reserve_strategy.
plantmin_consumption_penaltytimeseriesOutputNoMWNone/nullSHOP_OPEN17.8.0NoResulting penalty when the time-dependent maximum consumption limit for the plant is violated.
plantmax_consumption_penaltytimeseriesOutputNoMWNone/nullSHOP_OPEN17.8.0NoResulting penalty when the time-dependent maximum consumption limit for the plant is violated.
plantmin_upflow_penaltytimeseriesOutputNoMM3None/nullSHOP_OPEN17.8.0NoResulting penalty when the time-dependent minimum upflow limit for the plant is violated.
plantmax_upflow_penaltytimeseriesOutputNoMM3None/nullSHOP_OPEN17.8.0NoResulting penalty when the time-dependent maximum upflow limit for the plant is violated.
plantconsumption_penalty_costtimeseriesOutputNoNOKNone/nullSHOP_OPEN17.8.0NoResulting penalty cost when the time-dependent maximum or minimum consumption limit for the plant is violated.
plantupflow_penalty_costtimeseriesOutputNoNOKNone/nullSHOP_OPEN17.8.0NoResulting penalty cost when the time-dependent maximum or minimum upflow limit for the plant is violated.
plantincorrect_pq_uploadingtimeseriesOutputNoNOKNone/nullSHOP_OPEN17.9.0NoThis timeseries is set to 1 for all time steps where incorrect uploading of the PQ curve has happened for any generator on this plant in any previous iteration. This is used for the strict pq uploading functionality.
generatortypeintOutputNoNO_UNIT0SHOP_OPEN13.0.0.aNoSpecification of type of generator when using ASCII-files as input. 0 indicates Francis or Kaplan turbine while PELTON indicates a Pelton unit (or a unit where forbidden operating zones is modelled as Pelton).
generatornum_needle_combintOutputNoNO_UNIT0SHOP_OPEN13.0.0.aNoNumber of needle combinations for Pelton units.
generatorprod_areatimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aYesDeprecated: use a busbar object per price area and connect the appropriate units and markets to the busbars. Production from this generator will be sold in markets connected to the given price area.
generatorinitial_stateintInputNoNO_UNIT-1SHOP_OPEN13.0.0.aNoThe initial operation state of the generator before the optimization period: -1 = not set; 0 = not running; 1 = running.
generatorpenstockintInputYesNO_UNIT0SHOP_OPEN13.0.0.aNoThe penstock number the generator is connected to in the plant, must be a number between 1 and the size of the penstock_loss attribute on the plant object.
generatorseparate_droopintInputNoNO_UNIT0SHOP_SEPARATE_DROOP15.1.0.0NoA flag to turn on (1) or off (0, default) the building of separate droop variables for FCR-N, FCR-D up, and FCR-D down for the generator.
generatorp_mindoubleInputNoMW0.0SHOP_OPEN13.0.0.aNoStatic minimum production for the generator.
generatorp_maxdoubleInputYesMW0.0SHOP_OPEN13.0.0.aNoStatic maximum production for the generator.
generatorp_nomdoubleInputYesMW0.0SHOP_OPEN13.0.0.aNoThe nominal production that is the rated capacity of the generator, only used in droop calculations.
generatorgen_eff_curvexyInputNox: MW and y: %None/nullSHOP_OPEN13.0.0.aNoThe generator efficiency curve as a function of the produced power.
generatorturb_eff_curvesxy_arrayInputYesx: M3/S and y: %None/nullSHOP_OPEN13.0.0.aNoThe turbine efficiency curve(s) as a function of discharge through the turbine. Several curves can be specified for different head levels (reference value in the XY) to make the efficiency head-dependent.
generatormaintenance_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aNoFlag determining whether the generator is out for maintenance for a given time step.
generatorstartcosttimeseriesInputNoNOKNone/nullSHOP_OPEN13.0.0.aNoGenerator startup cost when turning on the unit in one time step.
generatorstartcost_constdoubleInputNoNOK0.0SHOP_OPEN17.5.0NoA constant startup cost when turning on the generator in one time step. The timeseries attribute startcost is preferred over startcost_const if both are set.
generatorstopcosttimeseriesInputNoNOKNone/nullSHOP_BLOCK_MERGE13.0.0.aNoGenerator shutdown cost when turning off the unit in one time step.
generatorstopcost_constdoubleInputNoNOK0.0SHOP_OPEN17.5.0NoA constant shutdown cost when turning off the generator in one time step. The timeseries attribute stopcost is preferred over stopcost_const if both are set.
generatordischarge_cost_curvexyInputNox: M3/S and y: NOK/H/M3/SNone/nullSHOP_OPEN13.0.0.aNoExtra cost depending on the discharge of the generator.
generatorprioritytimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aYesTime-dependent generators priority to define the uploading order among all the generators in a plant. Plant gen_priority will be ignored if generator priority is set.
generatorcommitted_intimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aYesCommitted status given by the user used to define the operating status of the generator in the optimization: 0 - committed not to run; 1 - committed to run.
generatorcommitted_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aNoFlag determining whether the input commit status should be used for a given time step or not.
generatormin_p_constrtimeseriesInputNoMWNone/nullSHOP_OPEN13.0.0.aYesTime-dependent minimum production limit for the generator that will replace static p_min if it is more constraining. Note that the generator may still be turned off if a min_p_constr > 0 is set, use the committed_in attribute to force the generator to be on.
generatormin_p_constr_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aNoFlag determining whether the time-dependent minimum production limit for the generator should be included in the building of the original PQ curve.
generatormax_p_constrtimeseriesInputNoMWNone/nullSHOP_OPEN13.0.0.aYesTime-dependent maximum production limit for the generator that will replace static p_max if it is more constraining.
generatormax_p_constr_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aNoFlag determining whether the time-dependent maximum production limit for the generator should be included in the building of the original PQ curve.
generatormin_q_constrtimeseriesInputNoM3/SNone/nullSHOP_OPEN13.0.0.aYesTime-dependent minimum discharge limit for the generator. Note that the generator may still be turned off if a min_q_constr > 0 is set, use the committed_in attribute to force the generator to be on.
generatormin_q_constr_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aNoFlag determining whether the time-dependent minimum discharge limit for the generator should be included in the building of the original PQ curve.
generatormax_q_constrtimeseriesInputNoM3/SNone/nullSHOP_OPEN13.0.0.aYesTime-dependent maximum discharge limit for the generator.
generatormax_q_constr_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aNoFlag determining whether the time-dependent maximum discharge limit for the generator should be included in the building of the original PQ curve.
generatormax_q_limit_rsv_downxyInputNox: METER and y: M3/SNone/nullSHOP_OPEN13.0.0.aNoMaximum generator discharge limit (m3/s) and downstream reservoir water level (meter above sea level) relation.
generatorupstream_mintimeseriesInputNoMETERNone/nullSHOP_RESIDUAL_RESERVOIR13.0.0.aYesMinimum water level of upstream reservoir required for running the generator. If the plant is connected to an upstream tunnel network, the smallest reservoir is used to build the constraints.
generatorupstream_min_flagtimeseriesInputNoNO_UNITNone/nullSHOP_RESIDUAL_RESERVOIR13.0.0.aNoFlag determining whether the minimum water level of upstream reservoir required for running the generator should be included in the optimization model.
generatordownstream_maxtimeseriesInputNoMETERNone/nullSHOP_OPEN13.0.0.aYesMaximum water level of downstream reservoir allowed when running the generator. If the plant is connected to a downstream tunnel network, the smallest reservoir is used to build the constraints.
generatordownstream_max_flagtimeseriesInputNoNO_UNITNone/nullSHOP_RESIDUAL_RESERVOIR13.0.0.aNoFlag determining whether the maximum water level of downstream allowed when running the generator should be included in the optimization model.
generatorproduction_scheduletimeseriesInputNoMWNone/nullSHOP_OPEN13.0.0.aYesGenerator production schedule. Note that setting a schedule higher or lower than the operating limits of the generator is allowed, but this might lead to inaccurate results due to lacking efficiency data.
generatorproduction_schedule_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aNoFlag determining whether the generator production schedule should be included in the optimization model.
generatordischarge_scheduletimeseriesInputNoM3/SNone/nullSHOP_OPEN13.0.0.aYesGenerator discharge schedule. Note that setting a schedule higher or lower than the operating limits of the generator is allowed, but this might lead to inaccurate results due to lacking efficiency data. The three special flag values 1e41, 1e42, and 1e43 can be set to make the generator run at best, minimum, and maximum output, respectively.
generatordischarge_schedule_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aNoFlag determining whether the generator discharge schedule should be included in the optimization model.
generatorfcr_mip_flagtimeseriesInputNoNO_UNITNone/nullSHOP_RESERVE_GROUP13.0.0.aNoFlag determining whether binary variables should be used to indicate that the generator can contribute to FCR only if its unused capacity is no less than 2 % of the maximum production limit.
generatorp_fcr_mintimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesTemporary minimum production for the generator when delivering FCR. If this is not set, the head-dependent minimum production of the generator will be used instead. Note that the p_fcr_n_min and p_fcr_d_min attributes will take precedence over this attribute if both are specified.
generatorp_fcr_n_mintimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP16.6.1YesTemporary minimum production for the generator when delivering FCR-N. If this attribute is not specified, the p_fcr_min attribute on the generator object will be used instead.
generatorp_fcr_d_mintimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP16.6.1YesTemporary minimum production for the generator when delivering FCR-D. If this attribute is not specified, the p_fcr_min attribute on the generator object will be used instead.
generatorp_fcr_maxtimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesTemporary maximum production for the generator when delivering FCR. If this is not set, the head-dependent maximum production of the generator will be used instead. Note that the p_fcr_n_max and p_fcr_d_max attributes will take precedence over this attribute if both are specified.
generatorp_fcr_n_maxtimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP16.6.1YesTemporary maximum production for the generator when delivering FCR-N. If this attribute is not specified, the p_fcr_max attribute on the generator object will be used instead.
generatorp_fcr_d_maxtimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP16.6.1YesTemporary maximum production for the generator when delivering FCR-D. If this attribute is not specified, the p_fcr_max attribute on the generator object will be used instead.
generatorp_frr_mintimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP15.0.1.0YesMinimum production for the generator when delivering FRR. If not specified, the head-dependent minimum production for the generator (or needle_combination for Pelton units) is used as lower bound for downward FRR.
generatorp_frr_maxtimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP15.0.1.0YesMaximum production for the generator when delivering FRR. If not specified, the head-dependent maximum production for the generator (or needle_combination for Pelton units) is used as upper bound for upward FRR.
generatorp_rr_mintimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesTemporary, user-overridden minimum production for the generator when delivering RR. If not specified, or set above p_min on the generator, it defaults to p_min. The attribute ‘rr_down_stop_mip_flag’ on the generator or the attribute ‘rr_down_stop_mip’ on global_settings ensures valid delivery of RR-DOWN reserves down to full stop and also prohibits RR-DOWN allocation in the forbidden production region between 0 and p_rr_min.
generatorfrr_up_mintimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesMinimum FRR_UP delivery for the generator.
generatorfrr_up_maxtimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesMaximum FRR_UP delivery for the generator.
generatorfrr_down_mintimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesMinimum FRR_DOWN delivery for the generator.
generatorfrr_down_maxtimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesMaximum FRR_DOWN delivery for the generator.
generatorfcr_n_up_mintimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesMinimum FCR_N_UP delivery for the generator.
generatorfcr_n_up_maxtimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesMaximum FCR_N_UP delivery for the generator.
generatorfcr_n_down_mintimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesMinimum FCR_N_DOWN delivery for the generator.
generatorfcr_n_down_maxtimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesMaximum FCR_N_DOWN delivery for the generator.
generatorfcr_d_up_mintimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesMinimum FCR_D_UP delivery for the generator.
generatorfcr_d_up_maxtimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesMaximum FCR_D_UP delivery for the generator.
generatorfcr_d_down_mintimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP14.2.0.0YesMinimum FCR_D_DOWN delivery for the generator.
generatorfcr_d_down_maxtimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP14.2.0.0YesMaximum FCR_D_DOWN delivery for the generator.
generatorrr_up_mintimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesMinimum RR_UP delivery for the generator.
generatorrr_up_maxtimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesMaximum RR_UP delivery for the generator.
generatorrr_down_mintimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesMinimum RR_DOWN delivery for the generator.
generatorrr_down_maxtimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesMaximum RR_DOWN delivery for the generator.
generatorfcr_n_up_scheduletimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesGenerator FCR_N_UP delivery schedule.
generatorfcr_n_up_schedule_flagtimeseriesInputNoNO_UNITNone/nullSHOP_RESERVE_GROUP13.0.0.aNoFlag determining whether the generator FCR_N_UP delivery schedule should be included in the optimization model.
generatorfcr_n_down_scheduletimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesGenerator FCR_N_DOWN delivery schedule.
generatorfcr_n_down_schedule_flagtimeseriesInputNoNO_UNITNone/nullSHOP_RESERVE_GROUP13.0.0.aNoFlag determining whether the generator FCR_N_DOWN delivery schedule should be included in the optimization model.
generatorfcr_d_up_scheduletimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesGenerator FCR_D_UP delivery schedule.
generatorfcr_d_up_schedule_flagtimeseriesInputNoNO_UNITNone/nullSHOP_RESERVE_GROUP13.0.0.aNoFlag determining whether the generator FCR_D_UP delivery schedule should be included in the optimization model.
generatorfcr_d_down_scheduletimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP14.2.0.0YesGenerator FCR_D_DOWN delivery schedule.
generatorfcr_d_down_schedule_flagtimeseriesInputNoNO_UNITNone/nullSHOP_RESERVE_GROUP14.2.0.0NoFlag determining whether the generator FCR_D_DOWN delivery schedule should be included in the optimization model.
generatorfrr_up_scheduletimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesGenerator FRR_UP delivery schedule.
generatorfrr_up_schedule_flagtimeseriesInputNoNO_UNITNone/nullSHOP_RESERVE_GROUP13.0.0.aNoFlag determining whether the generator FRR_UP delivery schedule should be included in the optimization model.
generatorfrr_down_scheduletimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesGenerator FRR_DOWN delivery schedule.
generatorfrr_down_schedule_flagtimeseriesInputNoNO_UNITNone/nullSHOP_RESERVE_GROUP13.0.0.aNoFlag determining whether the generator FRR_DOWN delivery schedule should be included in the optimization model.
generatorrr_up_scheduletimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesGenerator RR_UP delivery schedule.
generatorrr_up_schedule_flagtimeseriesInputNoNO_UNITNone/nullSHOP_RESERVE_GROUP13.0.0.aNoFlag determining whether the generator RR_UP delivery schedule should be included in the optimization model.
generatorrr_down_scheduletimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesGenerator RR_DOWN delivery schedule.
generatorrr_down_schedule_flagtimeseriesInputNoNO_UNITNone/nullSHOP_RESERVE_GROUP13.0.0.aNoFlag determining whether the generator RR_DOWN delivery schedule should be included in the optimization model.
generatordroop_costtimeseriesInputNoNOKNone/nullSHOP_RESERVE_GROUP13.0.0.aNoThe cost for the inverse unit droop when it is modelled as a variable in the optimization model, which makes SHOP prefer high droop settings. The default droop_cost on global_settings is used if this attribute is not specified.
generatorfixed_drooptimeseriesInputNoNO_UNITNone/nullSHOP_RESERVE_GROUP13.0.0.aYesFixed unit droop given as input data.
generatorfixed_droop_flagtimeseriesInputNoNO_UNITNone/nullSHOP_RESERVE_GROUP13.0.0.aNoFlag determining whether the fixed droop setting should be included in the optimization model.
generatordroop_mintimeseriesInputNoNO_UNITNone/nullSHOP_RESERVE_GROUP13.0.0.aYesThe lower bound of the unit droop when it is modelled as a variable in the optimization model. This bound is applied together with other FCR constraints, where the most restrictive will limit the FCR delivery.
generatordroop_maxtimeseriesInputNoNO_UNITNone/nullSHOP_RESERVE_GROUP13.0.0.aYesThe upper bound of the unit droop when it is modelled as a variable in the optimization model. This bound is applied together with other FCR constraints, where the most restrictive will limit the FCR delivery.
generatordiscrete_droop_valuesdouble_arrayInputNoNO_UNITNone/nullSHOP_DISCRETE_DROOP14.0.1.0NoA list of all legal droop values for the generator. If the functionality for fixing the unit droop is activated by the ‘set droop_discretization_limit’ command, this list of discrete values will be used when fixing the generator droop.
generatorfcr_n_discrete_droop_valuesdouble_arrayInputNoNO_UNITNone/nullSHOP_SEPARATE_DROOP15.1.0.0NoA list of all legal droop values for FCR-N reserves when the generator is built with separate droop. If the functionality for fixing the unit droop is activated by the ‘set droop_discretization_limit’ command, this list of discrete values will be used when fixing the generator droop.
generatorfcr_d_up_discrete_droop_valuesdouble_arrayInputNoNO_UNITNone/nullSHOP_SEPARATE_DROOP15.1.0.0NoA list of all legal droop values for FCR-D up reserves when the generator is built with separate droop. If the functionality for fixing the unit droop is activated by the ‘set droop_discretization_limit’ command, this list of discrete values will be used when fixing the generator droop.
generatorfcr_d_down_discrete_droop_valuesdouble_arrayInputNoNO_UNITNone/nullSHOP_SEPARATE_DROOP15.1.0.0NoA list of all legal droop values for FCR-D down reserves when the generator is built with separate droop. If the functionality for fixing the unit droop is activated by the ‘set droop_discretization_limit’ command, this list of discrete values will be used when fixing the generator droop.
generatorreserve_ramping_cost_uptimeseriesInputNoNOKNone/nullSHOP_RESERVE_CLUSTERING_FUNCTIONALITY13.0.0.aYesUpward reserve ramping cost for changing reserve delivery of the generator.
generatorreserve_ramping_cost_downtimeseriesInputNoNOKNone/nullSHOP_RESERVE_CLUSTERING_FUNCTIONALITY13.0.0.aYesDownward reserve ramping cost for changing reserve delivery of the generator.
generatorref_productiontimeseriesInputNoMWNone/nullSHOP_OPEN13.0.0.aYesProduction of the generator indicating the planned operating point as starting point for the best profit calculation.
generatorschedule_deviation_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aNoFlag determining whether the generator can deviate from the input schedule when calculating marginal cost and best profit curves. Implicitly generated based on the ref_prod attribute if the command ‘set prod_from_ref_prod’ is used.
generatorgen_turn_off_limittimeseriesInputNoNO_UNIT0.5SHOP_OPEN14.0.0.1NoA decimal number between 0 and 1 that signifies if the generator operates below the fraction (the decimal number) of its minimum operating limit in a full mode without MIP, the unit will be turned off.
generatorfcr_n_up_costtimeseriesInputNoNOK/MWHNone/nullSHOP_RESERVE_GROUP14.3.4.0NoThe cost of allocating FCR-N up reserves on this generator.
generatorfcr_n_down_costtimeseriesInputNoNOK/MWHNone/nullSHOP_RESERVE_GROUP14.3.4.0NoThe cost of allocating FCR-N down reserves on this generator.
generatorfcr_d_up_costtimeseriesInputNoNOK/MWHNone/nullSHOP_RESERVE_GROUP14.3.4.0NoThe cost of allocating FCR-D up reserves on this generator.
generatorfcr_d_down_costtimeseriesInputNoNOK/MWHNone/nullSHOP_RESERVE_GROUP14.3.4.0NoThe cost of allocating FCR-D down reserves on this generator.
generatorfrr_up_costtimeseriesInputNoNOK/MWHNone/nullSHOP_RESERVE_GROUP14.3.4.0NoThe cost of allocating FRR up reserves on this generator.
generatorfrr_down_costtimeseriesInputNoNOK/MWHNone/nullSHOP_RESERVE_GROUP14.3.4.0NoThe cost of allocating FRR down reserves on this generator.
generatorrr_up_costtimeseriesInputNoNOK/MWHNone/nullSHOP_RESERVE_GROUP14.3.4.0NoThe cost of allocating RR up reserves on this generator.
generatorrr_down_costtimeseriesInputNoNOK/MWHNone/nullSHOP_RESERVE_GROUP14.3.4.0NoThe cost of allocating RR down reserves on this generator.
generatorspinning_reserve_up_maxtimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP14.3.5.0YesSets a maximum limit for the sum of spinning reserves delivered in the upward direction on the generator.
generatorspinning_reserve_down_maxtimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP14.3.5.0YesSets a maximum limit for the sum of spinning reserves delivered in the downward direction on the generator.
generatorfcr_n_droop_costtimeseriesInputNoNOKNone/nullSHOP_SEPARATE_DROOP15.1.0.0NoThe cost for the inverse unit droop for FCR-N reserves when it is modelled as a variable in the optimization model and droop is built separately for FCR-N and FCR-D. The droop_cost attribute on the generator or global_settings is used if this attribut is not specified.
generatorfcr_d_up_droop_costtimeseriesInputNoNOKNone/nullSHOP_SEPARATE_DROOP15.1.0.0NoThe cost for the inverse unit droop for FCR-D up reserves when it is modelled as a variable in the optimization model and droop is built separately for FCR-N and FCR-D. The droop_cost attribute on the generator or global_settings is used if this attribut is not specified.
generatorfcr_d_down_droop_costtimeseriesInputNoNOKNone/nullSHOP_SEPARATE_DROOP15.1.0.0NoThe cost for the inverse unit droop for FCR-D down reserves when it is modelled as a variable in the optimization model and droop is built separately for FCR-N and FCR-D. The droop_cost attribute on the generator or global_settings is used if this attribut is not specified.
generatorfcr_n_fixed_drooptimeseriesInputNoNO_UNITNone/nullSHOP_SEPARATE_DROOP15.1.0.0YesFixed unit droop schedule for FCR-N reserves when droop is built separately for FCR-N and FCR-D.
generatorfcr_d_up_fixed_drooptimeseriesInputNoNO_UNITNone/nullSHOP_SEPARATE_DROOP15.1.0.0YesFixed unit droop schedule for FCR-D up reserves when droop is built separately for FCR-N and FCR-D.
generatorfcr_d_down_fixed_drooptimeseriesInputNoNO_UNITNone/nullSHOP_SEPARATE_DROOP15.1.0.0YesFixed unit droop schedule for FCR-D down reserves when droop is built separately for FCR-N and FCR-D.
generatorfcr_n_droop_mintimeseriesInputNoNO_UNITNone/nullSHOP_SEPARATE_DROOP15.1.0.0YesThe lower bound of the unit droop for FCR-N reserves when it is modelled as a variable in the optimization model and droop is built separately for FCR-N and FCR-D. This bound is applied together with other FCR-N constraints, where the most restrictive will limit the FCR delivery.
generatorfcr_d_up_droop_mintimeseriesInputNoNO_UNITNone/nullSHOP_SEPARATE_DROOP15.1.0.0YesThe lower bound of the unit droop for FCR-D up reserves when it is modelled as a variable in the optimization model and droop is built separately for FCR-N and FCR-D. This bound is applied together with other FCR-D up constraints, where the most restrictive will limit the FCR delivery.
generatorfcr_d_down_droop_mintimeseriesInputNoNO_UNITNone/nullSHOP_SEPARATE_DROOP15.1.0.0YesThe lower bound of the unit droop for FCR-D down reserves when it is modelled as a variable in the optimization model and droop is built separately for FCR-N and FCR-D. This bound is applied together with other FCR-D down constraints, where the most restrictive will limit the FCR delivery.
generatorfcr_n_droop_maxtimeseriesInputNoNO_UNITNone/nullSHOP_SEPARATE_DROOP15.1.0.0YesThe upper bound of the unit droop for FCR-N reserves when it is modelled as a variable in the optimization model and droop is built separately for FCR-N and FCR-D. This bound is applied together with other FCR-N constraints, where the most restrictive will limit the FCR delivery.
generatorfcr_d_up_droop_maxtimeseriesInputNoNO_UNITNone/nullSHOP_SEPARATE_DROOP15.1.0.0YesThe upper bound of the unit droop for FCR-D up reserves when it is modelled as a variable in the optimization model and droop is built separately for FCR-N and FCR-D. This bound is applied together with other FCR-D up constraints, where the most restrictive will limit the FCR delivery.
generatorfcr_d_down_droop_maxtimeseriesInputNoNO_UNITNone/nullSHOP_SEPARATE_DROOP15.1.0.0YesThe upper bound of the unit droop for FCR-D down reserves when it is modelled as a variable in the optimization model and droop is built separately for FCR-N and FCR-D. This bound is applied together with other FCR-D down constraints, where the most restrictive will limit the FCR delivery.
generatorcouple_fcr_delivery_flagtimeseriesInputNoNO_UNITNone/nullSHOP_ADVANCED_RESERVE_ACTIVATION15.3.3.0NoIf this flag is set to 1, no FCR-D capacity can be allocated to the generator unless the allocated FCR-N reserve capacity is at its maximal value. Upward and downward reserve capacity are handled separately.
generatorhistorical_productiontimeseriesInputNoMWNone/nullSHOP_OPEN15.4.1.0NoThe generator production for times before the optimization start.
generatormin_uptimeintInputNoMINUTE0SHOP_MIN_UPTIME_DOWNTIME15.4.1.0NoMinimum generator up-time, given in whole minutes.
generatormin_downtimeintInputNoMINUTE0SHOP_MIN_UPTIME_DOWNTIME15.4.1.0NoMinimum generator down-time, given in whole minutes.
generatormin_uptime_flagtimeseriesInputNoNO_UNITNone/nullSHOP_MIN_UPTIME_DOWNTIME15.4.1.0NoFlag for turning minimum uptime constraints on (1) or off (0). Constraints are built if no flag is given.
generatormin_downtime_flagtimeseriesInputNoNO_UNITNone/nullSHOP_MIN_UPTIME_DOWNTIME15.4.1.0NoFlag for turning minimum downtime constraints on (1) or off (0). Constraints are built if no flag is given.
generatorrr_down_stop_mip_flagtimeseriesInputNoNO_UNITNone/nullSHOP_RESERVE_GROUP15.6.0.0NoSetting this flag to 1 turns on the use of binary variables in full iterations to enable the generator to deliver valid RR-DOWN reserves down to full stop. This forces RR-DOWN to either be allocated as a spinning reserve down to p_rr_min (which defaults to p_min) or down to a full stop, and no other spinning reserves can be allocated on the unit if RR-DOWN is delivered down to stop. RR-DOWN allocation in the forbidden production region between 0 and p_rr_min is also prohibited. If the flag is not specified, the attribute ‘rr_down_stop_mip’ on global_settings is used.
generatormin_dischargexyInputNox: METER and y: M3/SNone/nullSHOP_OPEN16.0.0NoMinimum discharge as a function of net head.
generatormax_dischargexyInputNox: METER and y: M3/SNone/nullSHOP_OPEN16.0.0NoMaximum discharge as a function of net head.
generatorhistorical_dischargetimeseriesInputNoMWNone/nullSHOP_OPEN16.9.0NoThe generator discharge for times before the optimization start. This is mainly used when adding discharge ramping constraints on plant level if historical_discharge on the plant is not specified.
generatoronly_spinning_rr_upintInputNoNO_UNIT0SHOP_RESERVE_GROUP16.9.0NoSet this value to 1 to force the generator to only deliver RR-UP reserves if it is spinning. The default behaviour in SHOP (when this value is 0) is to allow offline generators to deliver RR-UP reserves.
generatorgross_head_mintimeseriesInputNoMETERNone/nullSHOP_OPEN17.6.0NoMinimum gross head limit for generator production. If there is a tunnel network above/below the plant, the gross head is found from the lowest/highest reservoir level in the tunnel network above/below.
generatorgross_head_maxtimeseriesInputNoMETERNone/nullSHOP_OPEN17.6.0NoMaximum gross head limit for generator production. If there is a tunnel network above/below the plant, the gross head is found from the lowest/highest reservoir level in the tunnel network above/below.
generatorgross_head_min_flagtimeseriesInputNoMETERNone/nullSHOP_OPEN17.6.0NoFlag for turning on/off the minimum gross head limit for generator production.
generatorgross_head_max_flagtimeseriesInputNoMETERNone/nullSHOP_OPEN17.6.0NoFlag for turning on/off the maximum gross head limit for generator production.
generatorstartup_gross_head_mintimeseriesInputNoMETERNone/nullSHOP_OPEN17.9.0YesMinimum gross head limit for generator startup, the unit is not allowed to start if the gross hed is below this limit. If there is a tunnel network above/below the plant, the gross head is found from the lowest/highest reservoir level in the tunnel network above/below.
generatorstartup_gross_head_min_flagtimeseriesInputNoMETERNone/nullSHOP_OPEN17.9.0NoFlag for turning on/off the minimum gross head limit for generator startup.
generatorfrr_mip_flagtimeseriesInputNoNO_UNITNone/nullSHOP_RESERVE_GROUP17.13.0NoSetting this flag to 1 will turn on the use of binary variables in full iterations to ensure that activated FRR reserves end up outside forbidden zones.
generatorpelton_change_needle_combination_costtimeseriesInputNoNOKNone/nullSHOP_PELTON18.2.0NoCost for changing the committed needle combination between time steps for pelton units. Any startup or shutdown cost defined on the generator should be larger thant this change cost.
generatoreff_headtimeseriesOutputNoMETERNone/nullSHOP_OPEN14.0.0.1NoResulting effective head of the generator.
generatorsim_eff_headtimeseriesOutputNoMETERNone/nullSHOP_OPEN13.5.4.cNoThe simulated effective head of the generator.
generatorhead_losstimeseriesOutputNoMETERNone/nullSHOP_OPEN14.0.0.1NoResulting head loss of the generator, i.e. the plant gross head (gross_head) minus the effective head of the generator (eff_head).
generatorsim_head_losstimeseriesOutputNoMETERNone/nullSHOP_OPEN16.7.0NoResulting head loss of the generator in the simulation, i.e. the plant gross head (gross_head) minus the effective head of the generator (eff_head).
generatorproductiontimeseriesOutputNoMWNone/nullSHOP_OPEN13.0.0.aNoResulting generator production, calculated base on discharge.
generatorsolver_productiontimeseriesOutputNoMWNone/nullSHOP_OPEN13.0.0.aNoPreliminary result for generator production that is returned by the linearized optimization problem.
generatorsim_productiontimeseriesOutputNoMWNone/nullSHOP_OPEN13.2.0.aNoSimulated generator production.
generatordischargetimeseriesOutputNoM3/SNone/nullSHOP_OPEN13.0.0.aNoResulting generator discharge. If solver_discharge >= gen_turn_off_limit, discharge is equal to solver_discharge. Otherwise, discharge = 0.
generatorsolver_dischargetimeseriesOutputNoM3/SNone/nullSHOP_OPEN13.0.0.aNoPreliminary result for generator discharge that is returned by the linearized optimization problem.
generatorsim_dischargetimeseriesOutputNoM3/SNone/nullSHOP_OPEN13.2.0.aNoSimulated generator discharge.
generatorcommitted_outtimeseriesOutputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aNoCommitted status of the generator based on the results of the optimization: 0 - not running; 1 - committed to run. The unit will be either turned on or off based on the optimized discharge in full iterations and the gen_turn_off_limit on global_settings. See also the solver_committed_fraction attribute for the actual optimized value of the (relaxed) binary variable used to model whether the generator is on or off. Note that if a Pelton is committed to run, the number of the committed needle_comb is returned.
generatorsolver_committed_fractiontimeseriesOutputNoNO_UNITNone/nullSHOP_OPEN17.6.0NoThe value of the (relaxed) binary variable uesed to model the on/off status of the generator in full iterations. The value could be a fractional number between 0 (off) and 1 (on) if the unit commitment constraints are relaxed (mip_flag turned off). For Pelton units, the fraction is the sum of the (fractional) commitment of all needle combinations.
generatorproduction_schedule_penaltytimeseriesOutputNoMWNone/nullSHOP_OPEN13.0.0.aNoResulting penalty when the generator production schedule is violated.
generatordischarge_schedule_penaltytimeseriesOutputNoMM3None/nullSHOP_OPEN13.0.0.aNoResulting penalty when the generator discharge schedule is violated.
generatorfcr_n_up_deliverytimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aNoResulting generator FCR_N_UP delivery.
generatorfcr_n_down_deliverytimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aNoResulting generator FCR_N_DOWN delivery.
generatorfcr_d_up_deliverytimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aNoResulting generator FCR_D_UP delivery.
generatorfcr_d_down_deliverytimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP14.2.0.0NoResulting generator FCR_D_DOWN delivery.
generatorfrr_up_deliverytimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aNoResulting generator FRR_UP delivery.
generatorfrr_down_deliverytimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aNoResulting generator FRR_DOWN delivery.
generatorrr_up_deliverytimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aNoResulting generator RR_UP delivery.
generatorrr_down_deliverytimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aNoResulting generator RR_DOWN delivery.
generatorfcr_n_up_delivery_physicaltimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP14.3.3.0NoResulting physical generator FCR_N delivery in the upward direction.
generatorfcr_n_down_delivery_physicaltimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP14.3.3.0NoResulting physical generator FCR_N delivery in the downward direction.
generatorfcr_d_up_delivery_physicaltimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP14.3.3.0NoResulting physical generator FCR_D delivery in the upward direction.
generatorfcr_d_down_delivery_physicaltimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP14.3.3.0NoResulting physical generator FCR_D delivery in the downward direction.
generatorfcr_n_up_schedule_penaltytimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aNoResulting penalty when the generator FCR_N_UP schedule is violated.
generatorfcr_n_down_schedule_penaltytimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aNoResulting penalty when the generator FCR_N_DOWN schedule is violated.
generatorfcr_d_up_schedule_penaltytimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aNoResulting penalty when the generator FCR_D_UP schedule is violated.
generatorfcr_d_down_schedule_penaltytimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP14.2.0.0NoResulting penalty when the generator FCR_D_DOWN schedule is violated.
generatorfrr_up_schedule_penaltytimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aNoResulting penalty when the generator FRR_UP schedule is violated.
generatorfrr_down_schedule_penaltytimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aNoResulting penalty when the generator FRR_DOWN schedule is violated.
generatorrr_up_schedule_penaltytimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aNoResulting penalty when the generator RR_UP schedule is violated.
generatorrr_down_schedule_penaltytimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aNoResulting penalty when the generator RR_DOWN schedule is violated.
generatordroop_resulttimeseriesOutputNoNO_UNITNone/nullSHOP_RESERVE_GROUP13.0.0.aNoResulting unit droop when it is modelled as a variable in the optimization model.
generatorbest_profit_qxytOutputNox: MW and y: M3/SNone/nullSHOP_BEST_PROFIT13.0.0.aNoOptimal discharge for the generator given a certain production level of the plant. Created after the command ‘create bp_curves’ has been performed.
generatorbest_profit_pxytOutputNox: MW and y: MWNone/nullSHOP_BEST_PROFIT13.0.0.aNoOptimal production for the generator given a certain production level of the plant. Created after the command ‘create bp_curves’ has been performed.
generatorbest_profit_q_pxytOutputNox: MW and y: M3/SNone/nullSHOP_BEST_PROFIT13.0.0.aNoRatio between discharge and production for the generator given a certain production level of the plant. Created after the command ‘create bp_curves’ has been performed.
generatorbest_profit_needle_combxytOutputNox: MW and y: NO_UNITNone/nullSHOP_BEST_PROFIT13.0.0.aNoOptimal needle combination for the generator given a certain production level of the plant. Created after the command ‘create bp_curves’ has been performed.
generatorstartup_cost_mip_objectivetimeseriesOutputNoNOKNone/nullSHOP_OPEN13.0.0.aNoCost in the objective function of the solver from startup costs originating from the time steps when MIP is used.
generatorstartup_cost_total_objectivetimeseriesOutputNoNOKNone/nullSHOP_OPEN13.0.0.aNoPost-optimization calculated startup costs based on change in commitment status for both time steps with and without MIP activated.
generatordischarge_fee_objectivetimeseriesOutputNoNOKNone/nullSHOP_OPEN13.0.0.aNoCost in the objective function resulting from discharge fees for this generator.
generatorfeeding_fee_objectivetimeseriesOutputNoNOKNone/nullSHOP_OPEN13.0.0.aNoCost in the objective function resulting from feed-in fees for this generator.
generatorschedule_penaltytimeseriesOutputNoNOKNone/nullSHOP_OPEN13.0.0.aNoResulting penalty cost when the generator schedule (production schedule and/or discharge schedule) for the generator is voilated.
generatormarket_incometimeseriesOutputNoNOKNone/nullSHOP_OPEN13.0.0.aNoIncome in the objective function from selling the energy produced on this generator.
generatororiginal_pq_curvesxytOutputNox: M3/S and y: MWNone/nullSHOP_OPEN13.5.2.aNoOriginal PQ-curve for the generator that includes non-convex regions.
generatorconvex_pq_curvesxytOutputNox: M3/S and y: MWNone/nullSHOP_OPEN13.5.2.aNoConvexified PQ-curve for the generator that includes all the time-dependent operating limits and removes all the non-concave points of the original PQ curve. The slope of each segment is non-increasing.
generatorfinal_pq_curvesxytOutputNox: M3/S and y: MWNone/nullSHOP_OPEN13.5.2.aNoFinal PQ curve for the generator that is the final form included into the optimization problem. The first point of the convex PQ curve is extended to Q=0.
generatormax_prod_individualtimeseriesOutputNoMWNone/nullSHOP_OPEN14.4.0.0NoThe head-dependent maximal production of the generator if all other units continue to operate at their current production level. Most accurate in incremental iterations.
generatormax_prod_alltimeseriesOutputNoMWNone/nullSHOP_OPEN16.1.0NoThe head-dependent maximal production of the generator if all generators not on maintenance in the plant are also producing at maximum.
generatormax_prod_availabletimeseriesOutputNoMWNone/nullSHOP_OPEN16.1.0NoThe head.dependent maximal production of the generator if all generators not on maintenance or committed off in the plant are also producing at maximum.
generatormax_prod_spinningtimeseriesOutputNoMWNone/nullSHOP_OPEN16.1.0NoThe head-dependent maximal production of the generator if all spinning generators in the plant are also producing at maximum.
generatormin_prod_individualtimeseriesOutputNoMWNone/nullSHOP_OPEN14.4.0.0NoThe head-dependent minimal production of the generator if all other units continue to operate at their current production level. Most accurate in incremental iterations.
generatormin_prod_spinningtimeseriesOutputNoMWNone/nullSHOP_OPEN16.1.0NoThe head-dependent minimal production of the generator if all spinning generators in the plant are also producing at minimum.
generatorfcr_n_droop_resulttimeseriesOutputNoNO_UNITNone/nullSHOP_SEPARATE_DROOP15.1.0.0NoThe optimized unit droop for FCR-N reserves when the droop is built separately for FCR-N and FCR-D. If all FCR reserves share a common droop setting, this timeseries is identical to the ‘droop_result’ attribute.
generatorfcr_d_up_droop_resulttimeseriesOutputNoNO_UNITNone/nullSHOP_SEPARATE_DROOP15.1.0.0NoThe optimized unit droop for FCR-D up reserves when the droop is built separately for FCR-N and FCR-D. If all FCR reserves share a common droop setting, this timeseries is identical to the ‘droop_result’ attribute.
generatorfcr_d_down_droop_resulttimeseriesOutputNoNO_UNITNone/nullSHOP_SEPARATE_DROOP15.1.0.0NoThe optimized unit droop for FCR-D down reserves when the droop is built separately for FCR-N and FCR-D. If all FCR reserves share a common droop setting, this timeseries is identical to the ‘droop_result’ attribute.
generatorfcr_binary_variable_resulttimeseriesOutputNoNO_UNITNone/nullSHOP_OPEN17.9.0NoThe (potentially fractional) result of the (relaxed) binary variable used when the fcr_mip_flag is set.
generatorpelton_rr_up_needle_committimeseriesOutputNoNO_UNITNone/nullSHOP_OPEN17.9.0NoThe needle combination that is chosen to deliver RR up reserves for pelton units. If -1, no needle combination is used to deliver RR up. If -2, attribute has not been set.
needle_combinationp_maxdoubleInputYesMW0.0SHOP_PELTON13.0.0.aNoStatic maximum production for the needle combination.
needle_combinationp_mindoubleInputNoMW0.0SHOP_PELTON13.0.0.aNoStatic minimum production for the needle combination.
needle_combinationp_nomdoubleInputYesMW0.0SHOP_PELTON13.0.0.aNoThe nominal production that is the rated capacity of the needle combination, only used for droop calculations.
needle_combinationturb_eff_curvesxy_arrayInputYesx: M3/S and y: %None/nullSHOP_PELTON13.0.0.aNoThe turbine efficiency curve(s) as a function of discharge through the turbine for this needle_combination. Several curves can be specified for different head levels (reference value in the XY) to make the efficiency head-dependent.
needle_combinationp_fcr_mintimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP14.3.4.0YesTemporary minimum production allowed for the needle combination when delivering FCR. If this is not set, any p_fcr_min attribute defined on the generator object will be used instead. Note that the p_fcr_n_min and p_fcr_d_min attributes on the needle_combination will take precedence over this attribute if both are specified.
needle_combinationp_fcr_n_mintimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP16.6.1YesTemporary minimum production allowed for the needle combination when delivering FCR-N. If this attribute is not specified, the p_fcr_min attribute on the needle_combination object will be used instead.
needle_combinationp_fcr_d_mintimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP16.6.1YesTemporary minimum production allowed for the needle combination when delivering FCR-D. If this attribute is not specified, the p_fcr_min attribute on the needle_combination object will be used instead.
needle_combinationp_fcr_maxtimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP14.3.4.0YesTemporary maximum production allowed for the needle combination when delivering FCR. If this is not set, any p_fcr_max attribute defined on the generator object will be used instead. Note that the p_fcr_n_max and p_fcr_d_max attributes on the needle_combination will take precedence over this attribute if both are specified.
needle_combinationp_fcr_n_maxtimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP16.6.1YesTemporary maximum production allowed for the needle combination when delivering FCR-N. If this attribute is not specified, the p_fcr_max attribute on the needle_combination object will be used instead.
needle_combinationp_fcr_d_maxtimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP16.6.1YesTemporary maximum production allowed for the needle combination when delivering FCR-D. If this attribute is not specified, the p_fcr_max attribute on the needle_combination object will be used instead.
needle_combinationp_frr_mintimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP15.0.1.0YesMinimum production allowed for the needle combination when delivering FRR. If not specified, the head-dependent minimum production for the needle combination is used as lower bound for downward FRR.
needle_combinationp_frr_maxtimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP15.0.1.0YesMaximum production allowed for the needle combination when delivering FRR. If not specified, the head-dependent maximum production for the needle combination is used as upper bound for upward FRR.
needle_combinationproduction_costxyInputNox: MW and y: NOK/MWNone/nullSHOP_OPEN15.0.0.aNoProduction cost depending on the production of the needle combination.
needle_combinationmin_dischargexyInputNox: NO_UNIT and y: NO_UNITNone/nullSHOP_OPEN16.0.0NoMinimum discharge as a function of net head.
needle_combinationmax_dischargexyInputNox: NO_UNIT and y: NO_UNITNone/nullSHOP_OPEN16.0.0NoMaximum discharge as a function of net head.
needle_combinationoriginal_pq_curvesxytOutputNox: M3/S and y: MWNone/nullSHOP_OPEN13.5.2.aNoOriginal PQ-curve for the needle combination that includes non-convex regions.
needle_combinationconvex_pq_curvesxytOutputNox: M3/S and y: MWNone/nullSHOP_OPEN13.5.2.aNoConvexified PQ-curve for the needle combination that includes all the time-dependent operating limits and remove all the non-concave points of the original PQ curve. The slope of each segment is non-increasing.
needle_combinationfinal_pq_curvesxytOutputNox: M3/S and y: MWNone/nullSHOP_OPEN13.5.2.aNoFinal PQ curve for the needle combination that is the final form included into the MILP optimization problem. The first point of the convex PQ curve is extended to Q=0.
needle_combinationmax_prodtimeseriesOutputNoMWNone/nullSHOP_OPEN14.4.0.0NoThe head dependent maximal production of the needle_combination, most accurate in incremental iterations.
needle_combinationmin_prodtimeseriesOutputNoMWNone/nullSHOP_OPEN14.4.0.0NoThe head dependent minimal production of the needle_combination, most accurate in incremental iterations.
needle_combinationsolver_committed_fractiontimeseriesOutputNoNO_UNITNone/nullSHOP_OPEN17.6.0NoThe value of the (relaxed) binary variable uesed to model the on/off status of the needle combination in full iterations. The value could be a fractional number between 0 (off) and 1 (on) if the unit commitment constraints are relaxed (mip_flag turned off).
pumpinitial_stateintInputNoNO_UNIT-1SHOP_OPEN13.0.0.aNoThe initial operation state of the pump before the optimization period: -1 = not set; 0 = not running; 1 = running.
pumppenstockintInputYesNO_UNIT0SHOP_OPEN13.0.0.aNoThe penstock number the pump is connected to.
pumpseparate_droopintInputNoNO_UNIT0SHOP_SEPARATE_DROOP15.1.0.0NoA flag to turn on (1) or off (0, default) the building of separate droop variables for FCR-N, FCR-D up, and FCR-D down for the pump.
pumpp_mindoubleInputNoMW0.0SHOP_OPEN13.0.0.aNoStatic minimum consumption for the pump.
pumpp_maxdoubleInputYesMW0.0SHOP_OPEN13.0.0.aNoStatic maximum consumption for the pump.
pumpp_nomdoubleInputYesMW0.0SHOP_OPEN13.0.0.aNoThe nominal consumption that is the rated capacity of the pump.
pumpgen_eff_curvexyInputNox: MW and y: %None/nullSHOP_OPEN13.0.0.aNoThe efficiency curve for the machine powering the pump.
pumpturb_eff_curvesxy_arrayInputYesx: M3/S and y: %None/nullSHOP_OPEN13.0.0.aNoThe turbine efficiency curve(s) as a function of upflow through the pump. Several curves can be specified for different head levels (reference value in the XY) to make the efficiency head-dependent.
pumpmaintenance_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aNoFlag determining whether the pump is out for maintenance for a given time step.
pumpstartcosttimeseriesInputNoNOKNone/nullSHOP_OPEN13.0.0.aNoPump startup cost for turning on the pump that can vary over time.
pumpstartcost_constdoubleInputNoNOK0.0SHOP_OPEN17.5.0NoA constant startup cost when turning on the pump in one time step. The timeseries attribute startcost is preferred over startcost_const if both are set.
pumpstopcosttimeseriesInputNoNOKNone/nullSHOP_OPEN13.0.0.aNoPump shutdown cost for turning off the pump that can vary over time.
pumpstopcost_constdoubleInputNoNOK0.0SHOP_OPEN17.5.0NoA constant shutdown cost when turning off the pump in one time step. The timeseries attribute stopcost is preferred over stopcost_const if both are set.
pumpcommitted_intimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aYesCommitted status given by the user used to define the operating status of the pump in the optimization: 0 - committed not to run; 1 - committed to run.
pumpcommitted_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aNoFlag determining whether to use the input commit status should be used for a given time step or not.
pumpupstream_maxtimeseriesInputNoMETERNone/nullSHOP_PUMPING_CONSTRAINT13.0.0.aYesMaximum water level of upstream reservoir allowed when operating the pump. If the plant is connected to an upstream tunnel network, the smallest reservoir is used to build the constraints.
pumpupstream_max_flagtimeseriesInputNoNO_UNITNone/nullSHOP_PUMPING_CONSTRAINT13.0.0.aNoFlag determining whether the maximum water level of upstream reservoir allowed when operating the pump should be included in the optimization model.
pumpdownstream_mintimeseriesInputNoMETERNone/nullSHOP_PUMPING_CONSTRAINT13.0.0.aYesMinimum water level of downstream reservoir required for operating the pump.
pumpdownstream_min_flagtimeseriesInputNoMETERNone/nullSHOP_PUMPING_CONSTRAINT13.0.0.aNoFlag determining whether the minimum water level of downstream reservoir required for operating the pump should be included in the optimization model. If the plant is connected to a downstream tunnel network, the smallest reservoir is used to build the constraints.
pumpconsumption_scheduletimeseriesInputNoMWNone/nullSHOP_OPEN13.0.0.aYesConsumption schedule.
pumpconsumption_schedule_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aNoFlag determining whether the pump consumption schedule should be included in the optimization model.
pumpupflow_scheduletimeseriesInputNoM3/SNone/nullSHOP_OPEN13.0.0.aYesPump upflow schedule.
pumpupflow_schedule_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aNoFlag determining whether the pump upflow schedule should be included in the optimization model.
pumpfcr_mip_flagtimeseriesInputNoNO_UNITNone/nullSHOP_RESERVE_GROUP13.0.0.aNoFlag determining whether binary variables should be used to enforce minimum available capacity requirement when delivering FCR.
pumpp_fcr_mintimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesTemporary minimum consumption for the pump when delivering FCR.
pumpp_fcr_maxtimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesTemporary maximum consumption for the pump when delivering FCR.
pumpp_rr_mintimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesTemporary, user-overridden minimum consumption for the pump when delivering RR. If not specified, or set above p_min on the pump, it defaults to p_min. The attribute ‘rr_up_stop_mip_flag’ on the pump or the attribute ‘rr_up_stop_mip’ on global_settings ensures valid delivery of RR-UP reserves up to full stop and also prohibits RR-UP allocation in the forbidden consumption region between 0 and p_rr_min.
pumpfrr_up_mintimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesMinimum FRR_UP delivery for the pump.
pumpfrr_up_maxtimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesMaximum FRR_UP delivery for the pump.
pumpfrr_down_mintimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesMinimum FRR_DOWN delivery for the pump.
pumpfrr_down_maxtimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesMaximum FRR_DOWN delivery for the pump.
pumpfcr_n_up_mintimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesMinimum FCR_N_UP delivery for the pump.
pumpfcr_n_up_maxtimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesMaximum FCR_N_UP delivery for the pump.
pumpfcr_n_down_mintimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesMinimum FCR_N_DOWN delivery for the pump.
pumpfcr_n_down_maxtimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesMaximum FCR_N_DOWN delivery for the pump.
pumpfcr_d_up_mintimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesMinimum FCR_D_UP delivery for the pump.
pumpfcr_d_up_maxtimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesMaximum FCR_D_UP delivery for the pump.
pumpfcr_d_down_mintimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP14.2.0.0YesMinimum FCR_D_DOWN delivery for the pump.
pumpfcr_d_down_maxtimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP14.2.0.0YesMaximum FCR_D_DOWN delivery for the pump.
pumprr_up_mintimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesMinimum RR_UP delivery for the pump.
pumprr_up_maxtimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesMaximum RR_UP delivery for the pump.
pumprr_down_mintimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesMinimum RR_DOWN delivery for the pump.
pumprr_down_maxtimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesMaximum RR_DOWN delivery for the pump.
pumpfcr_n_up_scheduletimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesPump FCR_N_UP delivery schedule.
pumpfcr_n_up_schedule_flagtimeseriesInputNoNO_UNITNone/nullSHOP_RESERVE_GROUP13.0.0.aNoFlag determining whether the pump FCR_N_UP delivery schedule should be included in the optimization model.
pumpfcr_n_down_scheduletimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesPump FCR_N_DOWN delivery schedule.
pumpfcr_n_down_schedule_flagtimeseriesInputNoNO_UNITNone/nullSHOP_RESERVE_GROUP13.0.0.aNoFlag determining whether the pump FCR_N_DOWN delivery schedule should be included in the optimization model.
pumpfcr_d_up_scheduletimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesPump FCR_D_UP delivery schedule.
pumpfcr_d_up_schedule_flagtimeseriesInputNoNO_UNITNone/nullSHOP_RESERVE_GROUP13.0.0.aNoFlag determining whether the pump FCR_D_UP delivery schedule should be included in the optimization model.
pumpfcr_d_down_scheduletimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP14.2.0.0YesPump FCR_D_DOWN delivery schedule.
pumpfcr_d_down_schedule_flagtimeseriesInputNoNO_UNITNone/nullSHOP_RESERVE_GROUP14.2.0.0NoFlag determining whether the pump FCR_D_DOWN delivery schedule should be included in the optimization model.
pumpfrr_up_scheduletimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesPump FRR_UP delivery schedule.
pumpfrr_up_schedule_flagtimeseriesInputNoNO_UNITNone/nullSHOP_RESERVE_GROUP13.0.0.aNoFlag determining whether the pump FRR_UP delivery schedule should be included in the optimization model.
pumpfrr_down_scheduletimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesPump FRR_DOWN delivery schedule.
pumpfrr_down_schedule_flagtimeseriesInputNoNO_UNITNone/nullSHOP_RESERVE_GROUP13.0.0.aNoFlag determining whether the pump FRR_DOWN delivery schedule should be included in the optimization model.
pumprr_up_scheduletimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesPump RR_UP delivery schedule.
pumprr_up_schedule_flagtimeseriesInputNoNO_UNITNone/nullSHOP_RESERVE_GROUP13.0.0.aNoFlag determining whether the pump RR_UP delivery schedule should be included in the optimization model.
pumprr_down_scheduletimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesPump RR_DOWN delivery schedule.
pumprr_down_schedule_flagtimeseriesInputNoNO_UNITNone/nullSHOP_RESERVE_GROUP13.0.0.aNoFlag determining whether the pump RR_DOWN delivery schedule should be included in the optimization model.
pumpdroop_costtimeseriesInputNoNOKNone/nullSHOP_RESERVE_GROUP13.0.0.aNoThe cost for the inverse unit droop when it is modelled as a variable in the optimization model, which makes SHOP prefer high droop settings. The default droop_cost on global_settings is used if this attribute is not specified.
pumpfixed_drooptimeseriesInputNoNO_UNITNone/nullSHOP_RESERVE_GROUP13.0.0.aYesFixed unit droop given as input data.
pumpfixed_droop_flagtimeseriesInputNoNO_UNITNone/nullSHOP_RESERVE_GROUP13.0.0.aYesFlag determining whether the fixed droop setting should be included in the optimization model.
pumpdroop_mintimeseriesInputNoNO_UNITNone/nullSHOP_RESERVE_GROUP13.0.0.aYesThe lower bound of the unit droop when it is modelled as a variable in the optimization model. This bound is applied together with other FCR constraints, where the most restrictive will limit the FCR delivery.
pumpdroop_maxtimeseriesInputNoNO_UNITNone/nullSHOP_RESERVE_GROUP13.0.0.aYesThe upper bound of the unit droop when it is modelled as a variable in the optimization model. This bound is applied together with other FCR constraints, where the most restrictive will limit the FCR delivery.
pumpreserve_ramping_cost_uptimeseriesInputNoNOK/MWNone/nullSHOP_RESERVE_CLUSTERING_FUNCTIONALITY13.0.0.aYesUpward reserve ramping cost for changing reserve delivery of the pump.
pumpreserve_ramping_cost_downtimeseriesInputNoNOK/MWNone/nullSHOP_RESERVE_CLUSTERING_FUNCTIONALITY13.0.0.aYesDownward reserve ramping cost for changing reserve delivery of the pump.
pumpdiscrete_droop_valuesdouble_arrayInputNoNO_UNITNone/nullSHOP_DISCRETE_DROOP14.0.1.0NoA list of all legal droop values for the pump. If the functionality for fixing the unit droop is activated by the ‘set droop_discretization_limit’ command, this list of discrete values will be used when fixing the pump droop.
pumpfcr_n_discrete_droop_valuesdouble_arrayInputNoNO_UNITNone/nullSHOP_SEPARATE_DROOP15.1.0.0NoA list of all legal droop values for FCR-N reserves when the pump is built with separate droop. If the functionality for fixing the unit droop is activated by the ‘set droop_discretization_limit’ command, this list of discrete values will be used when fixing the generator droop.
pumpfcr_d_up_discrete_droop_valuesdouble_arrayInputNoNO_UNITNone/nullSHOP_SEPARATE_DROOP15.1.0.0NoA list of all legal droop values for FCR-D up reserves when the pump is built with separate droop. If the functionality for fixing the unit droop is activated by the ‘set droop_discretization_limit’ command, this list of discrete values will be used when fixing the generator droop.
pumpfcr_d_down_discrete_droop_valuesdouble_arrayInputNoNO_UNITNone/nullSHOP_SEPARATE_DROOP15.1.0.0NoA list of all legal droop values for FCR-D down reserves when the pump is built with separate droop. If the functionality for fixing the unit droop is activated by the ‘set droop_discretization_limit’ command, this list of discrete values will be used when fixing the generator droop.
pumpfcr_n_up_costtimeseriesInputNoNOK/MWHNone/nullSHOP_RESERVE_GROUP14.3.4.0NoThe cost of allocating FCR-N up reserves on this pump.
pumpfcr_n_down_costtimeseriesInputNoNOK/MWHNone/nullSHOP_RESERVE_GROUP14.3.4.0NoThe cost of allocating FCR-N down reserves on this pump.
pumpfcr_d_up_costtimeseriesInputNoNOK/MWHNone/nullSHOP_RESERVE_GROUP14.3.4.0NoThe cost of allocating FCR-D up reserves on this pump.
pumpfcr_d_down_costtimeseriesInputNoNOK/MWHNone/nullSHOP_RESERVE_GROUP14.3.4.0NoThe cost of allocating FCR-D down reserves on this pump.
pumpfrr_up_costtimeseriesInputNoNOK/MWHNone/nullSHOP_RESERVE_GROUP14.3.4.0NoThe cost of allocating FRR up reserves on this pump.
pumpfrr_down_costtimeseriesInputNoNOK/MWHNone/nullSHOP_RESERVE_GROUP14.3.4.0NoThe cost of allocating FRR down reserves on this pump.
pumprr_up_costtimeseriesInputNoNOK/MWHNone/nullSHOP_RESERVE_GROUP14.3.4.0NoThe cost of allocating RR up reserves on this pump.
pumprr_down_costtimeseriesInputNoNOK/MWHNone/nullSHOP_RESERVE_GROUP14.3.4.0NoThe cost of allocating RR down reserves on this pump.
pumpspinning_reserve_up_maxtimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP14.3.5.0YesSets a maximum limit for the sum of spinning reserves delivered in the upward direction on the pump.
pumpspinning_reserve_down_maxtimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP14.3.5.0YesSets a maximum limit for the sum of spinning reserves delivered in the downward direction on the pump.
pumpfcr_n_droop_costtimeseriesInputNoNOKNone/nullSHOP_SEPARATE_DROOP15.1.0.0NoThe cost for the inverse unit droop for FCR-N reserves when it is modelled as a variable in the optimization model and droop is built separately for FCR-N and FCR-D. The droop_cost attribute on the pump or global_settings is used if this attribut is not specified.
pumpfcr_d_up_droop_costtimeseriesInputNoNOKNone/nullSHOP_SEPARATE_DROOP15.1.0.0NoThe cost for the inverse unit droop for FCR-D up reserves when it is modelled as a variable in the optimization model and droop is built separately for FCR-N and FCR-D. The droop_cost attribute on the pump or global_settings is used if this attribut is not specified.
pumpfcr_d_down_droop_costtimeseriesInputNoNOKNone/nullSHOP_SEPARATE_DROOP15.1.0.0NoThe cost for the inverse unit droop for FCR-D down reserves when it is modelled as a variable in the optimization model and droop is built separately for FCR-N and FCR-D. The droop_cost attribute on the pump or global_settings is used if this attribut is not specified.
pumpfcr_n_fixed_drooptimeseriesInputNoNO_UNITNone/nullSHOP_SEPARATE_DROOP15.1.0.0YesFixed unit droop schedule for FCR-N reserves when droop is built separately for FCR-N and FCR-D.
pumpfcr_d_up_fixed_drooptimeseriesInputNoNO_UNITNone/nullSHOP_SEPARATE_DROOP15.1.0.0YesFixed unit droop schedule for FCR-D up reserves when droop is built separately for FCR-N and FCR-D.
pumpfcr_d_down_fixed_drooptimeseriesInputNoNO_UNITNone/nullSHOP_SEPARATE_DROOP15.1.0.0YesFixed unit droop schedule for FCR-D down reserves when droop is built separately for FCR-N and FCR-D.
pumpfcr_n_droop_mintimeseriesInputNoNO_UNITNone/nullSHOP_SEPARATE_DROOP15.1.0.0YesThe lower bound of the unit droop for FCR-N reserves when it is modelled as a variable in the optimization model and droop is built separately for FCR-N and FCR-D. This bound is applied together with other FCR-N constraints, where the most restrictive will limit the FCR delivery.
pumpfcr_d_up_droop_mintimeseriesInputNoNO_UNITNone/nullSHOP_SEPARATE_DROOP15.1.0.0YesThe lower bound of the unit droop for FCR-D up reserves when it is modelled as a variable in the optimization model and droop is built separately for FCR-N and FCR-D. This bound is applied together with other FCR-D up constraints, where the most restrictive will limit the FCR delivery.
pumpfcr_d_down_droop_mintimeseriesInputNoNO_UNITNone/nullSHOP_SEPARATE_DROOP15.1.0.0YesThe lower bound of the unit droop for FCR-D down reserves when it is modelled as a variable in the optimization model and droop is built separately for FCR-N and FCR-D. This bound is applied together with other FCR-D down constraints, where the most restrictive will limit the FCR delivery.
pumpfcr_n_droop_maxtimeseriesInputNoNO_UNITNone/nullSHOP_SEPARATE_DROOP15.1.0.0YesThe upper bound of the unit droop for FCR-N reserves when it is modelled as a variable in the optimization model and droop is built separately for FCR-N and FCR-D. This bound is applied together with other FCR-N constraints, where the most restrictive will limit the FCR delivery.
pumpfcr_d_up_droop_maxtimeseriesInputNoNO_UNITNone/nullSHOP_SEPARATE_DROOP15.1.0.0YesThe upper bound of the unit droop for FCR-D up reserves when it is modelled as a variable in the optimization model and droop is built separately for FCR-N and FCR-D. This bound is applied together with other FCR-D up constraints, where the most restrictive will limit the FCR delivery.
pumpfcr_d_down_droop_maxtimeseriesInputNoNO_UNITNone/nullSHOP_SEPARATE_DROOP15.1.0.0YesThe upper bound of the unit droop for FCR-D down reserves when it is modelled as a variable in the optimization model and droop is built separately for FCR-N and FCR-D. This bound is applied together with other FCR-D down constraints, where the most restrictive will limit the FCR delivery.
pumphistorical_consumptiontimeseriesInputNoMWNone/nullSHOP_OPEN15.6.0.0NoThe pump consumption for times before the optimization start.
pumpmin_uptimeintInputNoMINUTE0SHOP_MIN_UPTIME_DOWNTIME15.6.0.0NoMinimum pump up-time, given in whole minutes.
pumpmin_downtimeintInputNoMINUTE0SHOP_MIN_UPTIME_DOWNTIME15.6.0.0NoMinimum pump down-time, given in whole minutes.
pumpmin_uptime_flagtimeseriesInputNoNO_UNITNone/nullSHOP_MIN_UPTIME_DOWNTIME15.6.0.0NoFlag for turning on/off the minimum pump up-time constraints.
pumpmin_downtime_flagtimeseriesInputNoNO_UNITNone/nullSHOP_MIN_UPTIME_DOWNTIME15.6.0.0NoFlag for turning on/off the minimum pump down-time constraints.
pumprr_up_stop_mip_flagtimeseriesInputNoNO_UNITNone/nullSHOP_RESERVE_GROUP15.6.1.0NoSetting this flag to 1 turns on the use of binary variables in full iterations to enable the pump to deliver valid RR-UP reserves up to full stop. This forces RR-UP to either be allocated as a spinning reserve up to p_rr_min (which defaults to p_min) or up to a full stop, and no other spinning reserves can be allocated on the unit if RR-UP is delivered up to stop. RR-UP allocation in forbidden consumption regions between 0 and p_rr_min is also prohibited. If the flag is not specified, the attribute ‘rr_up_stop_mip’ on global_settings is used.
pumpmax_p_constrtimeseriesInputNoMWNone/nullSHOP_OPEN16.4.1YesTime-dependent maximum consumption limit for the pump that will replace static p_max if it is more constraining.
pumpmax_p_constr_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN16.4.1NoFlag determining whether the time-dependent maximum consumption limit for the pump should be included in the building of the original PQ curve.
pumpmin_p_constrtimeseriesInputNoMWNone/nullSHOP_OPEN16.4.1YesTime-dependent minimum consumption limit for the pump that will replace static p_min if it is more constraining. Note that the pump may still be turned off if a min_p_constr > 0 is set, use the committed_in attribute to force the pump to be on.
pumpmin_p_constr_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN16.4.1NoFlag determining whether the time-dependent minimum consumption limit for the pump should be included in the building of the original PQ curve.
pumpmin_q_constrtimeseriesInputNoM3/SNone/nullSHOP_OPEN16.4.1YesTime-dependent minimum upflow limit for the pump. Note that the pump may still be turned off if a min_q_constr > 0 is set, use the committed_in attribute to force the pump to be on.
pumpmin_q_constr_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN16.4.1NoFlag determining whether the time-dependent minimum upflow limit for the pump should be included in the building of the original PQ curve.
pumpmax_q_constrtimeseriesInputNoM3/SNone/nullSHOP_OPEN16.4.1YesTime-dependent maximum upflow limit for the pump.
pumpmax_q_constr_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN16.4.1NoFlag determining whether the time-dependent maximum upflow limit for the pump should be included in the building of the original PQ curve.
pumponly_spinning_rr_downintInputNoNO_UNIT0SHOP_RESERVE_GROUP16.9.0NoSet this value to 1 to force the pump to only deliver RR-DOWN reserves if it is spinning. The default behaviour in SHOP (when this value is 0) is to allow offline pumps to deliver RR-DOWN reserves.
pumpgross_head_mintimeseriesInputNoMETERNone/nullSHOP_OPEN17.6.0NoMinimum gross head limit for pump consumption. If there is a tunnel network above/below the plant, the gross head is found from the lowest/highest reservoir level in the tunnel network above/below.
pumpgross_head_maxtimeseriesInputNoMETERNone/nullSHOP_OPEN17.6.0NoMaximum gross head limit for pump consumption. If there is a tunnel network above/below the plant, the gross head is found from the lowest/highest reservoir level in the tunnel network above/below.
pumpgross_head_min_flagtimeseriesInputNoMETERNone/nullSHOP_OPEN17.6.0NoFlag for turning on/off the minimum gross head limit for pump consumption.
pumpgross_head_max_flagtimeseriesInputNoMETERNone/nullSHOP_OPEN17.6.0NoFlag for turning on/off the maximum gross head limit for pump consumption.
pumpstartup_gross_head_mintimeseriesInputNoMETERNone/nullSHOP_OPEN17.9.0YesMinimum gross head limit for pump startup, the unit is not allowed to start if the gross hed is below this limit. If there is a tunnel network above/below the plant, the gross head is found from the lowest/highest reservoir level in the tunnel network above/below.
pumpstartup_gross_head_min_flagtimeseriesInputNoMETERNone/nullSHOP_OPEN17.9.0NoFlag for turning on/off the minimum gross head limit for pump startup.
pumpeff_headtimeseriesOutputNoMETERNone/nullSHOP_OPEN14.0.0.1NoResulting effective head of the pump.
pumpsim_eff_headtimeseriesOutputNoMETERNone/nullSHOP_OPEN16.7.0NoResulting effective head of the pump during simulation.
pumphead_losstimeseriesOutputNoMETERNone/nullSHOP_OPEN14.0.0.1NoResulting head loss of the pump, i.e. the effective head of the pump (eff_head) minus the plant gross head (gross_head).
pumpsim_head_losstimeseriesOutputNoMETERNone/nullSHOP_OPEN16.7.0NoResulting head loss of the pump in the simulation, i.e. the effective head of the pump (eff_head) minus the plant gross head (gross_head).
pumpconsumptiontimeseriesOutputNoMWNone/nullSHOP_OPEN13.0.0.aNoResulting pump consumption, calculated based on upflow.
pumpsim_consumptiontimeseriesOutputNoMWNone/nullSHOP_SIMULATION13.0.0.aNoSimulated pump consumption, calculated based on upflow.
pumpsolver_consumptiontimeseriesOutputNoMWNone/nullSHOP_OPEN13.0.0.aNoPreliminary result for pump consumption that is returned by the linearized optimization problem.
pumpupflowtimeseriesOutputNoM3/SNone/nullSHOP_OPEN13.0.0.aNoResulting pump upflow. If solver_upflow >= pump_turn_off_limit, upflow = solver_upflow. Otherwise, upflow = 0.
pumpsim_upflowtimeseriesOutputNoM3/SNone/nullSHOP_SIMULATION13.0.0.aNoSimulated pump upflow.
pumpsolver_upflowtimeseriesOutputNoM3/SNone/nullSHOP_OPEN13.0.0.aNoPreliminary result for pump upflow that is returned by the linearized optimization problem.
pumpcommitted_outtimeseriesOutputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aNoCommitted status of the pump based on the results of the optimization: 0 - not running; 1 - committed to run. The unit will be either turned on or off based on the optimized upflow in full iterations and the pump_turn_off_limit on global_settings. See also the solver_committed_fraction attribute for the actual optimized value of the (relaxed) binary variable used to model whether the pump is on or off.
pumpsolver_committed_fractiontimeseriesOutputNoNO_UNITNone/nullSHOP_OPEN17.6.0NoThe value of the (relaxed) binary variable uesed to model the on/off status of the pump in full iterations. The value could be a fractional number between 0 (off) and 1 (on) if the unit commitment constraints are relaxed (mip_flag turned off).
pumpconsumption_schedule_penaltytimeseriesOutputNoMWNone/nullSHOP_OPEN13.0.0.aNoResulting penalty when the pump consumption schedule is violated.
pumpupflow_schedule_penaltytimeseriesOutputNoMM3None/nullSHOP_OPEN13.0.0.aNoResulting penalty when the pump upflow schedule is violated.
pumpfcr_n_up_deliverytimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aNoResulting pump FCR_N_UP delivery.
pumpfcr_n_down_deliverytimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aNoResulting pump FCR_N_DOWN delivery.
pumpfcr_d_up_deliverytimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aNoResulting pump FCR_D_UP delivery.
pumpfcr_d_down_deliverytimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP14.2.0.0NoResulting pump FCR_D_DOWN delivery.
pumpfrr_up_deliverytimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aNoResulting pump FRR_UP delivery.
pumpfrr_down_deliverytimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aNoResulting pump FRR_DOWN delivery.
pumprr_up_deliverytimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aNoResulting pump RR_UP delivery.
pumprr_down_deliverytimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aNoResulting pump RR_DOWN delivery.
pumpfcr_n_up_delivery_physicaltimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP14.3.3.0NoResulting physical pump FCR_N delivery in the upward direction.
pumpfcr_n_down_delivery_physicaltimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP14.3.3.0NoResulting physical pump FCR_N delivery in the downward direction.
pumpfcr_d_up_delivery_physicaltimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP14.3.3.0NoResulting physical pump FCR_D delivery in the upward direction.
pumpfcr_d_down_delivery_physicaltimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP14.3.3.0NoResulting physical pump FCR_D delivery in the downward direction.
pumpfcr_n_up_schedule_penaltytimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aNoResulting penalty when the pump FCR_N_UP schedule is violated.
pumpfcr_n_down_schedule_penaltytimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aNoResulting penalty when the pump FCR_N_DOWN schedule is violated.
pumpfcr_d_up_schedule_penaltytimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aNoResulting penalty when the pump FCR_D_UP schedule is violated.
pumpfcr_d_down_schedule_penaltytimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP14.2.0.0NoResulting penalty when the pump FCR_D_DOWN schedule is violated.
pumpfrr_up_schedule_penaltytimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aNoResulting penalty when the pump FRR_UP schedule is violated.
pumpfrr_down_schedule_penaltytimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aNoResulting penalty when the pump FRR_DOWN schedule is violated.
pumprr_up_schedule_penaltytimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aNoResulting penalty when the pump RR_UP schedule is violated.
pumprr_down_schedule_penaltytimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aNoResulting penalty when the pump RR_DOWN schedule is violated.
pumpdroop_resulttimeseriesOutputNoNO_UNITNone/nullSHOP_RESERVE_GROUP13.0.0.aNoResulting unit droop when it is modelled as a variable in the optimization model.
pumporiginal_pq_curvesxytOutputNox: M3/S and y: MWNone/nullSHOP_OPEN13.5.2.aNoOriginal PQ-curve for the pump that includes non-convex regions.
pumpconvex_pq_curvesxytOutputNox: M3/S and y: MWNone/nullSHOP_OPEN13.5.2.aNoConvexified PQ-curve for the pump that removes all the non-concave points of the original PQ curve. The slope of each segment is non-decreasing.
pumpfinal_pq_curvesxytOutputNox: M3/S and y: MWNone/nullSHOP_OPEN13.5.2.aNoFinal PQ curve for the pump that is the final form included into the optimization problem. The first point of the convex PQ curve is extended to Q=0.
pumpmax_constimeseriesOutputNoMWNone/nullSHOP_OPEN14.4.0.0NoThe head-dependent maximal consumption of the pump. Most accurate in incremental iterations.
pumpmin_constimeseriesOutputNoMWNone/nullSHOP_OPEN14.4.0.0NoThe head-dependent minimal consumption of the pump. Most accurate in incremental iterations.
pumpfcr_n_droop_resulttimeseriesOutputNoNO_UNITNone/nullSHOP_SEPARATE_DROOP15.1.0.0NoThe optimized unit droop for FCR-N reserves when the droop is built separately for FCR-N and FCR-D. If all FCR reserves share a common droop setting, this timeseries is identical to the ‘droop_result’ attribute.
pumpfcr_d_up_droop_resulttimeseriesOutputNoNO_UNITNone/nullSHOP_SEPARATE_DROOP15.1.0.0NoThe optimized unit droop for FCR-D up reserves when the droop is built separately for FCR-N and FCR-D. If all FCR reserves share a common droop setting, this timeseries is identical to the ‘droop_result’ attribute.
pumpfcr_d_down_droop_resulttimeseriesOutputNoNO_UNITNone/nullSHOP_SEPARATE_DROOP15.1.0.0NoThe optimized unit droop for FCR-D down reserves when the droop is built separately for FCR-N and FCR-D. If all FCR reserves share a common droop setting, this timeseries is identical to the ‘droop_result’ attribute.
gatetime_delayintInputNoNO_UNIT0SHOP_OPEN13.0.0.aNoDeprecated: All time delay should be modelled by using the river object (does not require additional license). The delay between water leaving the gate and until it ends up in the downstream reservoir.
gateadd_slackintInputNoNO_UNIT1SHOP_OPEN13.0.0.aNoDeprecated: All gates should be modelled by using the river or tunnel objects (does not require additional license). Include slack variables for the corresponding delta meter gate.
gatemax_dischargedoubleInputNoM3/S100000.0SHOP_OPEN13.0.0.aNoDeprecated: All gates should be modelled by using the river or tunnel objects (does not require additional license). Maximum discharge capacity for the gate.
gatelin_rel_adoubleInputNoNO_UNITSHOP_GATE_FLOW_LIN_REL13.0.0.aYesDeprecated: All gates should be modelled by using the river or tunnel objects (does not require additional license). Linear approximation to model gate discharge (in Mm3) as a function of upstream reservoir volume: gate_flow = lin_rel_a*up_rsv_volume + lin_rel_b.
gatelin_rel_bdoubleInputNoMM3SHOP_GATE_FLOW_LIN_REL13.0.0.aYesDeprecated: All gates should be modelled by using the river or tunnel objects (does not require additional license). Linear approximation to model gate discharge (in Mm3) as a function of upstream reservoir volume: gate_flow = lin_rel_a*up_rsv_volume + lin_rel_b.
gateshape_dischargexyInputNox: HOUR and y: NO_UNITNone/nullSHOP_DYNAMIC_DELAY13.0.0.aNoDeprecated: All time delay should be modelled by using the river object (does not require additional license). Describes the wave shape of the delayed discharge for a gate by ratios as a function of time delays.
gatespill_cost_curvexyInputNox: M3/S and y: NOK/M3/SNone/nullSHOP_FLOOD_SUPPORT14.2.2.0NoDeprecated: All gates should be modelled by using the river or tunnel objects (does not require additional license). Describes a piece-wise constant cost curve for the flow in the gate. This is only available for spill gates, and overrides the default overflow penalty in SHOP.
gatepeak_flow_cost_curvexyInputNox: M3/S and y: NOK/M3/SNone/nullSHOP_FLOOD_SUPPORT14.2.2.0NoDeprecated: All gates should be modelled by using the river or tunnel objects (does not require additional license). Describes the piece-wise constant cost curve for the highest achieved flow rate in the gate over the optimization horizon.
gatepeak_flow_penaltytimeseriesOutputNoNOKNone/nullSHOP_FLOOD_SUPPORT14.0.1.0NoDeprecated: All gates should be modelled by using the river or tunnel objects (does not require additional license). The penalty incurred based on the peak_flow_cost_curve and the highest achieved flow rate in the gate over the optimization horizon.
gatefunctions_meter_m3sxy_arrayInputNox: METER and y: M3/SNone/nullSHOP_OPEN13.0.0.aNoDeprecated: All gates should be modelled by using the river or tunnel objects (does not require additional license). The relation between the head and opening of the gate or weir to define the discharge function of the gate.
gatefunctions_deltameter_m3sxy_arrayInputNox: DELTA_METER and y: M3/SNone/nullSHOP_OPEN13.0.0.aNoDeprecated: All gates should be modelled by using the river or tunnel objects (does not require additional license). Relationship between flow through the gate and water level in upper reservoir and difference in water level between upper and lower reservoir.
gatemin_flowtimeseriesInputNoM3/SNone/nullSHOP_OPEN13.0.0.aYesDeprecated: All gates should be modelled by using the river or tunnel objects (does not require additional license). Minimum flow constraint on the gate.
gatemin_flow_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aNoDeprecated: All gates should be modelled by using the river or tunnel objects (does not require additional license). Flag determining whether the min_flow should be used.
gatemax_flowtimeseriesInputNoM3/SNone/nullSHOP_OPEN13.0.0.aYesDeprecated: All gates should be modelled by using the river or tunnel objects (does not require additional license). Maximum flow constraint on the gate.
gatemax_flow_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aNoDeprecated: All gates should be modelled by using the river or tunnel objects (does not require additional license). Flag determining whether the max_flow should be used.
gateschedule_m3stimeseriesInputNoM3/SNone/nullSHOP_OPEN13.0.0.aYesDeprecated: All gates should be modelled by using the river or tunnel objects (does not require additional license). Gate discharge schedule.
gateschedule_percenttimeseriesInputNo%None/nullSHOP_OPEN13.0.0.aYesDeprecated: All gates should be modelled by using the river or tunnel objects (does not require additional license). Gate schedule in percent opening of the gate.
gateschedule_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aYesDeprecated: All gates should be modelled by using the river or tunnel objects (does not require additional license). Flag determining how the gate schedule should be used: 0 = no discharge schedule; 1 = discharge schedule; 2 = flow is calculated from reservoir water level and flow function for the gate.
gatesettingtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aYesDeprecated: All gates should be modelled by using the river or tunnel objects (does not require additional license). Predefined position of the gate to be used for determining gate flow together with functions and upstream water level.
gatesetting_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aNoDeprecated: All gates should be modelled by using the river or tunnel objects (does not require additional license). Flag determining whether the gate setting should be used to determine the flow through the gate.
gatedischarge_feetimeseriesInputNoNOK/MM3None/nullSHOP_OPEN13.0.0.aYesDeprecated: All gates should be modelled by using the river or tunnel objects (does not require additional license). Cost of discharging water through the gate referred to the time of discharge.
gatedischarge_fee_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aNoDeprecated: All gates should be modelled by using the river or tunnel objects (does not require additional license). Flag determining whether discharge_fee should be used in the optimization model.
gateblock_merge_tolerancetimeseriesInputNoM3/SNone/nullSHOP_OPEN13.0.0.aYesDeprecated: All gates should be modelled by using the river or tunnel objects (does not require additional license). Maximum deviation in discharge between two time steps that forces these hours to have the same discharge in later iterations.
gatemin_q_penalty_flagtimeseriesInputNoNO_UNITNone/nullSHOP_SOFT_CONSTRAINTS13.0.0.aNoDeprecated: All gates should be modelled by using the river or tunnel objects (does not require additional license). A flag enabling the penalty cost for the minimum discharge constraint on the gate.
gatemax_q_penalty_flagtimeseriesInputNoNO_UNITNone/nullSHOP_SOFT_CONSTRAINTS13.0.0.aNoDeprecated: All gates should be modelled by using the river or tunnel objects (does not require additional license). A flag enabling the penalty cost for the maximum discharge constraint on the gate.
gateramping_uptimeseriesInputNoM3SEC_HOURNone/nullSHOP_GATE_RAMPING13.5.4.aYesDeprecated: All gates should be modelled by using the river or tunnel objects (does not require additional license). Maximum limit for increase in gate discharge per hour.
gateramping_up_flagtimeseriesInputNoNO_UNITNone/nullSHOP_GATE_RAMPING13.5.4.aNoDeprecated: All gates should be modelled by using the river or tunnel objects (does not require additional license). A flag for toggling the upper ramping limit constraint on and off for this gate.
gateramping_downtimeseriesInputNoM3SEC_HOURNone/nullSHOP_GATE_RAMPING13.5.4.aYesDeprecated: All gates should be modelled by using the river or tunnel objects (does not require additional license). Maximum limit for decrease in gate discharge per hour.
gateramping_down_flagtimeseriesInputNoNO_UNITNone/nullSHOP_GATE_RAMPING13.5.4.aNoDeprecated: All gates should be modelled by using the river or tunnel objects (does not require additional license). A flag for toggling the lower ramping limit constraint on and off for this gate.
gateramp_penalty_costtimeseriesInputNoNOK/M3/SNone/nullSHOP_GATE_RAMPING13.5.4.aYesDeprecated: All gates should be modelled by using the river or tunnel objects (does not require additional license). The penalty cost for breaking the upper or lower discharge ramping limits for the gate.
gateramp_penalty_cost_flagtimeseriesInputNoNO_UNITNone/nullSHOP_GATE_RAMPING13.5.4.aNoDeprecated: All gates should be modelled by using the river or tunnel objects (does not require additional license). A flag for toggling the use of the specified ramping penalty cost for this gate on or off.
gatemax_q_penalty_costtimeseriesInputNoNOK/MM3None/nullSHOP_SOFT_CONSTRAINTS13.0.0.aYesDeprecated: All gates should be modelled by using the river or tunnel objects (does not require additional license). The penalty cost for the gate maximum discharge constraint.
gatemin_q_penalty_costtimeseriesInputNoNOK/MM3None/nullSHOP_SOFT_CONSTRAINTS13.0.0.aYesDeprecated: All gates should be modelled by using the river or tunnel objects (does not require additional license). The penalty cost for the gate minimum discharge constraint.
gatemax_q_penalty_cost_flagtimeseriesInputNoNO_UNITNone/nullSHOP_SOFT_CONSTRAINTS13.0.0.aNoDeprecated: All gates should be modelled by using the river or tunnel objects (does not require additional license). Flag determining whether max_q_penalty_cost should be included in the optimization model.
gatemin_q_penalty_cost_flagtimeseriesInputNoNO_UNITNone/nullSHOP_SOFT_CONSTRAINTS13.0.0.aNoDeprecated: All gates should be modelled by using the river or tunnel objects (does not require additional license). Flag determining whether min_q_penalty_cost should be included in the optimization model.
gatemin_q_penaltytimeseriesOutputNoNOKNone/nullSHOP_OPEN13.0.0.aNoDeprecated: All gates should be modelled by using the river or tunnel objects (does not require additional license). Resulting penalty when the gate minimum discharge is violated.
gatemax_q_penaltytimeseriesOutputNoNOKNone/nullSHOP_OPEN13.0.0.aNoDeprecated: All gates should be modelled by using the river or tunnel objects (does not require additional license). Resulting penalty when the gate maximum discharge is violated.
gatedischargetimeseriesOutputNoM3/SNone/nullSHOP_OPEN13.0.0.aNoDeprecated: All gates should be modelled by using the river or tunnel objects (does not require additional license). Resulting gate discharge.
gatesim_dischargetimeseriesOutputNoM3/SNone/nullSHOP_OPEN13.2.0.aNoDeprecated: All gates should be modelled by using the river or tunnel objects (does not require additional license). Simulated gate discharge.
gatespill_penaltytimeseriesOutputNoNOKNone/nullSHOP_OPEN17.9.0NoDeprecated: All gates should be modelled by using the river or tunnel objects (does not require additional license). Resulting cost for spilling water for spill gates.
thermalfuel_costtimeseriesInputNoNOK/MWHNone/nullSHOP_OPEN14.3.2.0NoCost proportional to the amount of fuel used by the thermal unit.
thermalquadratic_fuel_costtimeseriesInputNoNOK/MWHNone/nullSHOP_OPEN14.3.2.0NoCost proportional to the square of the amount of fuel used by the thermal unit.
thermaln_segmentsintInputNoNO_UNIT0SHOP_OPEN14.3.2.0NoNumber of segments on the production curve of the unit.
thermalmin_prodtimeseriesInputNoMWNone/nullSHOP_OPEN14.3.2.0NoMinimum production level of the unit.
thermalmax_prodtimeseriesInputNoMWNone/nullSHOP_OPEN14.3.2.0NoMaximum production level of the unit.
thermalstartcosttimeseriesInputNoNOKNone/nullSHOP_OPEN14.3.2.0NoCost for starting up the unit.
thermalstopcosttimeseriesInputNoNOKNone/nullSHOP_OPEN14.3.2.0NoCost for shutting down the unit.
thermalproductiontimeseriesOutputNoMWNone/nullSHOP_OPEN14.3.2.0NoProduction from the unit.
junctionjunc_slackintInputNoNO_UNIT0SHOP_OPEN13.0.0.aNoDeprecated: All junctions should be modelled by using the tunnel object (does not require additional license). Flag determining whether slack variables should be added to the mass balance of the junction.
junctionaltitudedoubleInputNoMETER0.0SHOP_OPEN13.0.0.aNoDeprecated: All junctions should be modelled by using the tunnel object (does not require additional license). Physical height of the connection point between tunnel_1 and tunnel_2 coming into this junction.
junctiontunnel_flow_1timeseriesOutputNoM3/SNone/nullSHOP_OPEN13.0.0.aNoDeprecated: All junctions should be modelled by using the tunnel object (does not require additional license). Resulting flow in tunnel_1.
junctiontunnel_flow_2timeseriesOutputNoM3/SNone/nullSHOP_OPEN13.0.0.aNoDeprecated: All junctions should be modelled by using the tunnel object (does not require additional license). Resulting flow in tunnel_2.
junctionsim_tunnel_flow_1timeseriesOutputNoM3/SNone/nullSHOP_OPEN13.5.4.cNoDeprecated: All junctions should be modelled by using the tunnel object (does not require additional license). The simulated flow in tunnel_1 of the junction.
junctionsim_tunnel_flow_2timeseriesOutputNoM3/SNone/nullSHOP_OPEN13.5.4.cNoDeprecated: All junctions should be modelled by using the tunnel object (does not require additional license). The simulated flow in tunnel_2 of the junction.
junctionloss_factor_1doubleInputNoS2/M50.0SHOP_OPEN13.0.0.aNoDeprecated: All junctions should be modelled by using the tunnel object (does not require additional license). Friction loss factor for tunnel_1 into this junction multiplied with the square of the flow to get head loss.
junctionloss_factor_2doubleInputNoS2/M50.0SHOP_OPEN13.0.0.aNoDeprecated: All junctions should be modelled by using the tunnel object (does not require additional license). Friction loss factor for tunnel_2 into this junction multiplied with the square of the flow to get head loss.
junctionmin_pressuretimeseriesInputNoMETERNone/nullSHOP_PRESSURE_LINK13.0.0.aNoDeprecated: All junctions should be modelled by using the tunnel object (does not require additional license). Minimum pressure requirement at the connection point of tunnel_1 and tunnel_2.
junctionpressure_heighttimeseriesOutputNoMETERNone/nullSHOP_OPEN13.0.0.aNoDeprecated: All junctions should be modelled by using the tunnel object (does not require additional license). Resulting pressure height from the optimization calculations.
junctionsim_pressure_heighttimeseriesOutputNoMETERNone/nullSHOP_OPEN13.5.4.cNoDeprecated: All junctions should be modelled by using the tunnel object (does not require additional license). Resulting pressure height from the simulation.
junctionincr_costtimeseriesOutputNoNOKNone/nullSHOP_OPEN13.0.0.aNoDeprecated: All junctions should be modelled by using the tunnel object (does not require additional license). Resulting marginal value of water in this junction referred to ocean level accounting for headloss between the tunnel connection point and the plant below.
junctionlocal_incr_costtimeseriesOutputNoNOKNone/nullSHOP_OPEN13.0.0.aNoDeprecated: All junctions should be modelled by using the tunnel object (does not require additional license). Resulting marginal value of water in this junction referred to the next reservoir below accounting for headloss between the tunnel connection point and the plant below.
junction_gateadd_slackintInputNoNO_UNIT0SHOP_OPEN13.0.0.aNoDeprecated: All junction_gates should be modelled by using the tunnel object (does not require additional license). Flag determining whether slack variables should be added to the mass balance of the junction gate.
junction_gateheight_1doubleInputNoMETER0.0SHOP_OPEN13.0.0.aNoDeprecated: All junction_gates should be modelled by using the tunnel object (does not require additional license). Physical height of the connection point between tunnel_1 and tunnel_2 coming into this junction.
junction_gateloss_factor_1doubleInputNoS2/M50.0SHOP_OPEN13.0.0.aNoDeprecated: All junction_gates should be modelled by using the tunnel object (does not require additional license). Friction loss factor for tunnel_1 into this junction multiplied with the square of the flow to get head loss.
junction_gateloss_factor_2doubleInputNoS2/M50.0SHOP_OPEN13.0.0.aNoDeprecated: All junction_gates should be modelled by using the tunnel object (does not require additional license). Friction loss factor for tunnel_2 into this junction multiplied with the square of the flow to get head loss.
junction_gatescheduletimeseriesInputNoNO_UNITNone/nullSHOP_OPEN13.0.0.aNoDeprecated: All junction_gates should be modelled by using the tunnel object (does not require additional license). Schedule determining the opening status of this junction gate. -2 means that both tunnel_1 and tunnel_2 are open 0 means that the output from the junction_gate is closed 1 means that only tunnel_1 is connected and 2 means that only tunnel_2 is connected. If two junction_gates are connected in series. The lower junction gate can only have schedule values of 0 or 1 or 2.
junction_gatepressure_heighttimeseriesOutputNoMETERNone/nullSHOP_OPEN13.0.0.aNoDeprecated: All junction_gates should be modelled by using the tunnel object (does not require additional license). Resulting pressure height from the optimization calculations.
junction_gatetunnel_flow_1timeseriesOutputNoM3/SNone/nullSHOP_OPEN13.0.0.aNoDeprecated: All junction_gates should be modelled by using the tunnel object (does not require additional license). Resulting flow in tunnel_1.
junction_gatetunnel_flow_2timeseriesOutputNoM3/SNone/nullSHOP_OPEN13.0.0.aNoDeprecated: All junction_gates should be modelled by using the tunnel object (does not require additional license). Resulting flow in tunnel_2.
creek_intakenet_headdoubleInputNoMETER0.0SHOP_CREEK_INTAKE13.0.0.aNoDeprecated: All creek_intakes should be modelled by using the tunnel object (does not require additional license). Physical height of the creek intake opening.
creek_intakemax_inflowdoubleInputNoM3/S0.0SHOP_CREEK_INTAKE13.0.0.aNoDeprecated: All creek_intakes should be modelled by using the tunnel object (does not require additional license).Static maximum capacity for inflow to this creek intake.
creek_intakemax_inflow_dynamictimeseriesInputNoM3/SNone/nullSHOP_CREEK_INTAKE13.0.0.aNoDeprecated: All creek_intakes should be modelled by using the tunnel object (does not require additional license).Time-dependent maxiumu capacity for inflow to this creek intake.
creek_intakeinflowtimeseriesInputNoM3/SNone/nullSHOP_CREEK_INTAKE13.0.0.aYesDeprecated: All creek_intakes should be modelled by using the tunnel object (does not require additional license).Inflow to the creek intake.
creek_intakesim_inflowtimeseriesOutputNoM3/SNone/nullSHOP_CREEK_INTAKE13.2.0.aNoDeprecated: All creek_intakes should be modelled by using the tunnel object (does not require additional license).Resulting inflow to this creek intake after simulation based on observed reservoir level and plant production.
creek_intakesim_pressure_heighttimeseriesOutputNoMETERNone/nullSHOP_CREEK_INTAKE13.5.4.cNoDeprecated: All creek_intakes should be modelled by using the tunnel object (does not require additional license).Resulting pressure height of the creek intake after simulation based on observed reservoir level and plant production.
creek_intakeinflow_percentagetimeseriesInputNoM3/SNone/nullSHOP_CREEK_INTAKE13.0.0.aNoDeprecated: All creek_intakes should be modelled by using the tunnel object (does not require additional license).Predefined factor to generate inflow to this creek intake based on a percentage of the inflow to the reservoir above.
creek_intakeoverflow_costtimeseriesInputNoNOK/MM3None/nullSHOP_CREEK_INTAKE13.0.0.aYesDeprecated: All creek_intakes should be modelled by using the tunnel object (does not require additional license).Cost for spillage from this creek intake if a spill gate is connected to it.
creek_intakenon_physical_overflow_flagtimeseriesOutputNoNO_UNITNone/nullSHOP_CREEK_INTAKE13.0.0.aNoDeprecated: All creek_intakes should be modelled by using the tunnel object (does not require additional license).Resulting flag series telling if there was non-physical overflow from this creek intake i.e. spilling water with inflow below the maximum capacity.
contractinitial_tradedoubleInputNoMWSHOP_CONTRACT14.5.0.0YesThe amount of power traded on the contract right before the optimization horizon begins, only used to implement ramping constraints for the first time step. If this value is not specified (default value 1e40), no ramping constraints are built for the first time step.
contracttrade_curvexytInputYesx: MW and y: NOK/MWHNone/nullSHOP_CONTRACT14.5.0.0NoThe trade_curve defines the size and price of the sale (negative volume) and buy (positive volume) steps of the financial contract. The X values of each XY table represents a step curve of volumes that can be traded, while the Y values defines the price for each volume step. Each XY table is valid from the specified start time until the start time of a later XY table is reached.
contractmin_tradetimeseriesInputNoMWNone/nullSHOP_CONTRACT14.5.0.0YesThe minimum amount of power that must be traded on this contract, can be a negative number.
contractmax_tradetimeseriesInputNoMWNone/nullSHOP_CONTRACT14.5.0.0YesThe maximum amount of power that must be traded on this contract, can be a negative number.
contractramping_uptimeseriesInputNoMW_HOURNone/nullSHOP_CONTRACT14.5.0.0NoThe limit for ramping up the power traded in the contract between time steps. The ramping up constraints are hard limits if ramping_up_penalty_cost is not specified on the contract.
contractramping_downtimeseriesInputNoMW_HOURNone/nullSHOP_CONTRACT14.5.0.0NoThe limit for ramping down the power traded in the contract between time steps. The ramping down constraints are hard limits if ramping_down_penalty_cost is not specified on the contract.
contractramping_up_penalty_costtimeseriesInputNoNOK/MWNone/nullSHOP_CONTRACT14.5.0.0YesThe cost of breaking the ramping up constraints.
contractramping_down_penalty_costtimeseriesInputNoNOK/MWNone/nullSHOP_CONTRACT14.5.0.0YesThe cost of breaking the ramping down constraints.
contracttradetimeseriesOutputNoMWNone/nullSHOP_CONTRACT14.5.0.0NoThe total amount of power traded on the contract.
contractramping_up_penaltytimeseriesOutputNoNOKNone/nullSHOP_CONTRACT14.5.0.0NoThe penalty for breaking the upward ramping constraints on the contract.
contractramping_down_penaltytimeseriesOutputNoNOKNone/nullSHOP_CONTRACT14.5.0.0NoThe penalty for breaking the downward ramping constraints on the contract.
marketprod_areaintInputNoNO_UNIT1SHOP_OPEN13.0.0.aNoDeprecated: use a busbar object per price area and connect the appropriate units and markets to the busbars. Definition of which production area this market belongs to. All the plants with corresponding prod_area will sell their production to markets in this price area.
marketmarket_typestringInputNoSTRINGENERGYSHOP_RESERVE_GROUP13.0.0.aNoString defining the product that is sold in this market. Allowed values are ENERGY, FCR_N_UP, FCR_N_DOWN, FCR_D_UP, FCR_D_DOWN (from version 14.2.0.0), FRR_UP, FRR_DOWN, RR_UP, and RR_DOWN. If this value is not given default market type is ENERGY.
marketloadtimeseriesInputNoMWNone/nullSHOP_OPEN13.0.0.aYesDeprecated: use a busbar object to add load to a set of connected units and markets. Fixed demand that must be delivered to this market. This comes in addition to any power sold to the market.
marketmax_buytimeseriesInputNoMWNone/nullSHOP_OPEN13.0.0.aYesThe maximum power that can be bought from the market.
marketmax_saletimeseriesInputNoMWNone/nullSHOP_OPEN13.0.0.aYesThe maximum power that can be sold to the market.
marketload_pricetimeseriesInputNoNOK/MWHNone/nullSHOP_OPEN14.6.0.0YesPrice for load obligation to this market. If load_price is not given, sale_price is used to calculate the load value.
marketbuy_pricetimeseriesInputNoNOK/MWHNone/nullSHOP_OPEN13.0.0.aYesPrice for buying power from this market.
marketsale_pricetimeseriesInputNoNOK/MWHNone/nullSHOP_OPEN13.0.0.aYesPrice for selling power to this market.
marketbuy_deltatimeseriesInputNoNOK/MWHNone/nullSHOP_OPEN13.0.0.aNoA (small) amount that will be added to the buy price in this market.
marketsale_deltatimeseriesInputNoNOK/MWHNone/nullSHOP_OPEN13.0.0.aNoA (small) amount that will be subtracted from the sale price in this market.
marketbid_flagtimeseriesInputNoNO_UNITNone/nullSHOP_SCENARIO_FUNCTIONALITY13.0.0.aNoFlag determining the time steps that should be included in the bid matrix.
marketcommon_scenariotimeseriesInputNoNO_UNITNone/nullSHOP_SCENARIO_FUNCTIONALITY13.0.0.aNoDefinition of non-anticipativity constraints for each market. The amount traded in the market must be the same for all scenarios and time steps where common_scenario is equal.
marketbuytimeseriesOutputNoMWNone/nullSHOP_OPEN13.0.0.aNoResulting power bought from this market.
marketsaletimeseriesOutputNoMWNone/nullSHOP_OPEN13.0.0.aNoResulting power sold to this market.
marketsim_saletimeseriesOutputNoMWNone/nullSHOP_OPEN13.2.0.aNoSimulated power sold to this market.
marketsim_buytimeseriesOutputNoMWNone/nullSHOP_OPEN15.4.0.0NoSimulated power bought from this market.
marketreserve_obligation_penaltytimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aNoDeprecated: the reserve obligation penalty for reserve markets is found under the connected reserve_group object (rr_up_violation etc.). Resulting penalty when the reserve obligation is violated.
marketload_penaltytimeseriesOutputNoMWNone/nullSHOP_OPEN13.0.0.aNoDeprecated: use a busbar object to add load to a set of connected units and markets. Resulting penalty when the load obligation is violated.
global_settingsload_penalty_flagintInputNoNO_UNIT1SHOP_OPEN14.0.0.1NoTurn on (1, default) or off (0) the creation of load penalty variables to add to the load balance constraint. Can also be set with the command ‘penalty flag’.
global_settingsrsv_penalty_flagintInputNoNO_UNIT1SHOP_OPEN14.0.0.1NoTurn on (1, default) or off (0) the addition of reservoir storage penalty variables. Can also be set with the command ‘penalty flag’.
global_settingsvolume_ramp_penalty_flagintInputNoNO_UNIT1SHOP_OPEN14.0.0.1NoTurn on (1, default) or off (0) the addition of penalty variables for volume ramping on reservoir. Can also be set with the command ‘penalty flag’.
global_settingslevel_ramp_penalty_flagintInputNoNO_UNIT1SHOP_OPEN14.0.0.6NoTurn on (1, default) or off (0) the addition of penalty variables for level ramping on reservoir. Can also be set with the command ‘penalty flag’.
global_settingsproduction_ramp_penalty_flagintInputNoNO_UNIT1SHOP_OPEN14.0.0.1NoTurn on (1, default) or off (0) the addition of penalty variables for power ramping on plant production. Can also be set with the command ‘penalty flag’.
global_settingsplant_min_q_penalty_flagintInputNoNO_UNIT-1SHOP_SOFT_CONSTRAINTS14.0.0.1NoTurn on (1) or off (0) the addition of penalty variables to the min discharge restrictions on all plants. Default value -1 uses the min_q_penalty_flag specified on each plant to decide if the penalty variables should be added. Can also be set with the command ‘penalty flag’.
global_settingsplant_min_p_penalty_flagintInputNoNO_UNIT-1SHOP_SOFT_CONSTRAINTS14.0.0.1NoTurn on (1) or off (0) the addition of penalty variables to the min power restrictions on all plants. Default value -1 uses the min_p_penalty_flag specified on each plant to decide if the penalty variables should be added. Can also be set with the command ‘penalty flag’.
global_settingsplant_max_q_penalty_flagintInputNoNO_UNIT-1SHOP_SOFT_CONSTRAINTS14.0.0.1NoTurn on (1) or off (0) the addition of penalty variables to the max discharge restrictions on all plants. Default value -1 uses the max_q_penalty_flag specified on each plant to decide if the penalty variables should be added. Can also be set with the command ‘penalty flag’.
global_settingsplant_max_p_penalty_flagintInputNoNO_UNIT-1SHOP_SOFT_CONSTRAINTS14.0.0.1NoTurn on (1) or off (0) the addition of penalty variables to the max power restrictions on all plants. Default value -1 uses the max_p_penalty_flag specified on each plant to decide if the penalty variables should be added. Can also be set with the command ‘penalty flag’.
global_settingsgate_min_q_penalty_flagintInputNoNO_UNIT-1SHOP_SOFT_CONSTRAINTS14.0.0.1NoTurn on (1) or off (0) the addition of penalty variables to the min discharge restrictions on all gates. Default value -1 uses the min_q_penalty_flag specified on each gate to decide if the penalty variables should be added. Can also be set with the command ‘penalty flag’.
global_settingsgate_max_q_penalty_flagintInputNoNO_UNIT-1SHOP_SOFT_CONSTRAINTS14.0.0.1NoTurn on (1) or off (0) the addition of penalty variables to the max discharge restrictions on all gates. Default value -1 uses the max_q_penalty_flag specified on each gate to decide if the penalty variables should be added. Can also be set with the command ‘penalty flag’.
global_settingsgate_ramp_penalty_flagintInputNoNO_UNIT1SHOP_OPEN14.0.0.1NoTurn on (1, default) or off (0) the addition of penalty variables to the gate ramping restrictions. Can also be set with the command ‘penalty flag’.
global_settingsplant_schedule_penalty_flagintInputNoNO_UNIT1SHOP_SOFT_CONSTRAINTS14.0.0.1NoTurn on (1, default) or off (0) the addition of penalty variables to allow breaking the plant production or discharge schedule. Can also be set with the command ‘penalty flag’.
global_settingsgen_discharge_schedule_penalty_flagintInputNoNO_UNIT1SHOP_OPEN14.0.0.1NoTurn on (1, default) or off (0) the addition of penalty variables to allow breaking the generator discharge schedule.
global_settingspump_schedule_penalty_flagintInputNoNO_UNIT1SHOP_OPEN14.0.0.1NoTurn on (1, default) or off (0) the addition of penalty variables to allow breaking the pump consumption or upflow schedule.
global_settingspower_limit_penalty_flagintInputNoNO_UNIT1SHOP_OPEN14.0.0.1NoTurn on (1, default) or off (0) the addition of penalty variables to allow breaking the sum power limits for a group of plants. Can also be set with the command ‘penalty flag’.
global_settingspower_limit_penalty_costdoubleInputNoNOK/MWH50000SHOP_OPEN14.0.0.1NoThe penalty cost for breaking the constraints limiting the sum power output for a group of plants. Default value is 50000 NOK/MWh. Can also be set with the command ‘penalty cost’.
global_settingsload_penalty_costdoubleInputNoNOK/MWH5000SHOP_OPEN14.0.0.1NoThe penalty cost for not fulfilling the load obligation. Default value is 5000 NOK/MWh. Can also be set with the command ‘penalty cost’.
global_settingsrsv_penalty_costdoubleInputNoNOK/MM310000000SHOP_OPEN14.0.0.1NoThe penalty cost for breaking the reservoir water balance constraints. Default value is 10,000,000 NOK/Mm3. Can also be set with the command ‘penalty cost’.
global_settingsrsv_hard_limit_penalty_costdoubleInputNoNOK/MM39000000SHOP_OPEN14.4.0.3NoThe penalty cost for breaking the hard min/max volume or level limit constraints on all reservoirs. Default value is 9,000,000 NOK/Mm3. Can also be set with the command ‘set rsv_hard_limit_penalty_cost’.
global_settingsvolume_ramp_penalty_costdoubleInputNoNOK/MM3100SHOP_OPEN14.0.0.1NoThe penalty cost for breaking the reservoir volume ramping constraints. Default value is 100 NOK/MM3. Can also be set with the command ‘penalty cost’.
global_settingslevel_ramp_penalty_costdoubleInputNoNOK/METER100SHOP_OPEN14.0.0.1NoThe penalty cost for breaking the reservoir level ramping constraints. Default value is 100 NOK/METER.
global_settingsproduction_ramp_penalty_costdoubleInputNoNOK/MWH100SHOP_OPEN14.0.0.1NoThe penalty cost for breaking the plant power production ramping constraints. Default value is 100 NOK/MWh. Can also be set with the command ‘penalty cost’.
global_settingsplant_discharge_ramp_penalty_costdoubleInputNoNOK/M3/S100SHOP_OPEN15.2.0.0NoThe penalty cost for breaking the plant discharge ramping constraints. Default value is 100 NOK/m3s. Can also be set with the command ‘penalty cost’.
global_settingsplant_soft_p_penaltydoubleInputNoNOK/MWH100SHOP_SOFT_CONSTRAINTS14.0.0.1NoThe penalty cost for breaking max and min power production constraints on plant level if max_p_penalty_cost and min_p_penalty_cost are not set for the plant. Default value is 100 NOK/MWh. Can also be set with the command ‘penalty cost’.
global_settingsplant_soft_q_penaltydoubleInputNoNOK/MM3100000SHOP_SOFT_CONSTRAINTS14.0.0.1NoThe penalty cost for breaking max and min discharge constraints on plant level if max_q_penalty_cost and min_q_penalty_cost are not set for the plant. Default value is 100000 NOK/Mm3. Can also be set with the command ‘penalty cost’.
global_settingsplant_sched_penalty_cost_updoubleInputNoNOK1000000SHOP_OPEN14.0.0.1NoThe penalty cost for breaking the plant production or discharge schedules in upward direction. Default value is 1000000 NOK/MWh or 1000000 NOK/Mm3.
global_settingsplant_sched_penalty_cost_downdoubleInputNoNOK1000000SHOP_OPEN14.0.0.1NoThe penalty cost for breaking the plant production or discharge schedules in downward direction. Default value is 1000000 NOK/MWh or 1000000 NOK/Mm3.
global_settingsgen_discharge_sched_penalty_cost_updoubleInputNoNOK/MM31000000SHOP_OPEN14.0.0.1NoThe penalty cost for breaking the generator discharge schedule in upward direction. Default value is 1000000 NOK/Mm3.
global_settingsgen_discharge_sched_penalty_cost_downdoubleInputNoNOK/MM31000000SHOP_OPEN14.0.0.1NoThe penalty cost for breaking the generator discharge schedules in downward direction. Default value is 1000000 NOK/Mm3.
global_settingspump_sched_penalty_cost_updoubleInputNoNOK1000000SHOP_OPEN14.0.0.1NoThe penalty cost for breaking the pump production or discharge schedules in upward direction. Default value is 1000000 NOK/MWh or 1000000 NOK/Mm3.
global_settingspump_sched_penalty_cost_downdoubleInputNoNOK1000000SHOP_OPEN14.0.0.1NoThe penalty cost for breaking the pump production or discharge schedules in downward direction. Default value is 1000000 NOK/MWh or 1000000 NOK/Mm3.
global_settingsgate_ramp_penalty_costdoubleInputNoNOK/M3/S360SHOP_OPEN14.0.0.1NoThe penalty cost for breaking the gate discharge ramping constraints. Default value is 360 NOK/(m3/s). Can also be set with the command ‘penalty cost’.
global_settingsdischarge_group_penalty_costdoubleInputNoNOK/MM31000000SHOP_OPEN14.0.0.1NoThe penalty cost for breaking the discharge group constraints. Default value is 1000000 NOK/Mm3.
global_settingsreserve_schedule_penalty_costdoubleInputNoNOK/MWH10000SHOP_RESERVE_GROUP14.0.0.1NoThe penalty cost for breaking the unit reserve schedule constraints. Default value is 10000 NOK/MWH. Can also be set with the command ‘set reserve_schedule_penalty_cost’.
global_settingsreserve_group_penalty_costdoubleInputNoNOK/MWH10000SHOP_RESERVE_GROUP14.0.0.1NoThe penalty cost for delivering less than the reserve obligations of any reserve type in any reserve group. Default value is 10000 NOK/MWH. Can also be set with the command ‘set reserve_penalty_cost’.
global_settingsbypass_costdoubleInputNoNOK/MM30.01SHOP_OPEN14.0.0.1NoThe cost of discharging water in bypass gates. Default value is 0.01 NOK/Mm3.
global_settingsgate_costdoubleInputNoNOK/MM30.0SHOP_OPEN14.0.0.1NoThe cost of discharging water in regular gates. Default value is 0 NOK/Mm3.
global_settingsoverflow_costdoubleInputNoNOK/MM350000SHOP_OPEN14.0.0.1NoThe cost of discharging water in spill gates. Default value is 50000 NOK/Mm3. Can also be set with the command ‘penalty cost’.
global_settingsoverflow_cost_time_factordoubleInputNoNOK/MM3H-0.000001SHOP_OPEN14.0.0.1NoA small negative cost element added to the spillage cost to avoid all flooding to occur at the end of the optimization period. Default value is -0.000001 NOK/Mm3/h. Can also be set with the command ‘penalty cost’.
global_settingsgen_reserve_ramping_costdoubleInputNoNOK/MW0.0SHOP_RESERVE_CLUSTERING_FUNCTIONALITY14.0.0.1YesThe default cost for ramping on all reserves types delivered on generators if generator specific or reserve type specific costs are not present. See the reserve type specific attributes fcr_n_ramping_cost, fcr_d_ramping_cost, frr_ramping_cost, and rr_ramping_cost and the command ‘set reserve_ramping_cost’.
global_settingspump_reserve_ramping_costdoubleInputNoNOK/MW0.0SHOP_RESERVE_CLUSTERING_FUNCTIONALITY14.0.0.1YesThe default cost for ramping on all reserves types delivered on pumps if pump specific or reserve type specific costs are not present. See the reserve type specific attributes fcr_n_ramping_cost, fcr_d_ramping_cost, frr_ramping_cost, and rr_ramping_cost and the command ‘set reserve_ramping_cost’.
global_settingsreserve_contribution_costdoubleInputNoNOK0.0SHOP_RESERVE_CLUSTERING_FUNCTIONALITY14.0.0.1NoThe cost for a unit participating in the reserve delivery per time step. Default value is 0 NOK. Can also be set with the command ‘set reserve_contribution_cost’.
global_settingsgate_ramp_costdoubleInputNoNOK/M3/S0.0SHOP_OPEN14.0.0.1NoThe cost of ramping on gate discharge. Default value is 0 NOK/(m3/s).
global_settingsreserve_group_slack_costdoubleInputNoNOK/MWH0.000001SHOP_RESERVE_GROUP14.0.0.1NoThe cost for delivering more than the reserve obligations of any reserve type in any reserve group. Default value is 0.000001 NOK/MWH. Can also be set with the command ‘set reserve_slack_cost’.
global_settingsfcr_n_ramping_costdoubleInputNoNOK/MWSHOP_RESERVE_CLUSTERING_FUNCTIONALITY15.0.0.0YesThe cost for ramping on the FCR-N reserves delivered by the generators and pumps if unit specific costs are not provided. Default value of 1e40 signifies that the ramping cost is not specified, and that the default gen_reserve_ramping_cost should be used instead. Can also be set with the command ‘set reserve_ramping_cost’.
global_settingsfcr_d_ramping_costdoubleInputNoNOK/MWSHOP_RESERVE_CLUSTERING_FUNCTIONALITY15.0.0.0YesThe cost for ramping on the FCR-D reserves delivered by the generators and pumps if unit specific costs are not provided. Default value of 1e40 signifies that the ramping cost is not specified, and that the default gen_reserve_ramping_cost should be used instead. Can also be set with the command ‘set reserve_ramping_cost’.
global_settingsfrr_ramping_costdoubleInputNoNOK/MWSHOP_RESERVE_CLUSTERING_FUNCTIONALITY15.0.0.0YesThe cost for ramping on the FRR reserves delivered by the generators and pumps if unit specific costs are not provided. Default value of 1e40 signifies that the ramping cost is not specified, and that the default gen_reserve_ramping_cost should be used instead. Can also be set with the command ‘set reserve_ramping_cost’.
global_settingsrr_ramping_costdoubleInputNoNOK/MWSHOP_RESERVE_CLUSTERING_FUNCTIONALITY15.0.0.0YesThe cost for ramping on the RR reserves delivered by the generators and pumps if unit specific costs are not provided. Default value of 1e40 signifies that the ramping cost is not specified, and that the default gen_reserve_ramping_cost should be used instead. Can also be set with the command ‘set reserve_ramping_cost’.
global_settingsfcr_n_up_activation_factordoubleInputNoNO_UNIT0.0SHOP_ADVANCED_RESERVE_ACTIVATION15.3.0.0YesThe fraction (between 0 and 1) of the reserved FCR-N up capacity that is assumed to be activated for all units in the system, the plant specific attribute with the same name will override this value.
global_settingsfcr_n_down_activation_factordoubleInputNoNO_UNIT0.0SHOP_ADVANCED_RESERVE_ACTIVATION15.3.0.0YesThe fraction (between 0 and 1) of the reserved FCR-N down capacity that is assumed to be activated for all units in the system, the plant specific attribute with the same name will override this value.
global_settingsfcr_d_up_activation_factordoubleInputNoNO_UNIT0.0SHOP_ADVANCED_RESERVE_ACTIVATION15.3.0.0YesThe fraction (between 0 and 1) of the reserved FCR-D up capacity that is assumed to be activated for all units in the system, the plant specific attribute with the same name will override this value.
global_settingsfcr_d_down_activation_factordoubleInputNoNO_UNIT0.0SHOP_ADVANCED_RESERVE_ACTIVATION15.3.0.0YesThe fraction (between 0 and 1) of the reserved FCR-D down capacity that is assumed to be activated for all units in the system, the plant specific attribute with the same name will override this value.
global_settingsfrr_up_activation_factordoubleInputNoNO_UNIT0.0SHOP_ADVANCED_RESERVE_ACTIVATION15.3.0.0YesThe fraction (between 0 and 1) of the reserved FRR up capacity that is assumed to be activated for all units in the system, the plant specific attribute with the same name will override this value.
global_settingsfrr_down_activation_factordoubleInputNoNO_UNIT0.0SHOP_ADVANCED_RESERVE_ACTIVATION15.3.0.0YesThe fraction (between 0 and 1) of the reserved FRR down capacity that is assumed to be activated for all units in the system, the plant specific attribute with the same name will override this value.
global_settingsrr_up_activation_factordoubleInputNoNO_UNIT0.0SHOP_ADVANCED_RESERVE_ACTIVATION15.3.0.0YesThe fraction (between 0 and 1) of the reserved RR up capacity that is assumed to be activated for all units in the system, the plant specific attribute with the same name will override this value.
global_settingsrr_down_activation_factordoubleInputNoNO_UNIT0.0SHOP_ADVANCED_RESERVE_ACTIVATION15.3.0.0YesThe fraction (between 0 and 1) of the reserved RR down capacity that is assumed to be activated for all units in the system, the plant specific attribute with the same name will override this value.
global_settingsfcr_n_up_activation_timedoubleInputNoNO_UNIT0.0SHOP_ADVANCED_RESERVE_ACTIVATION15.3.0.0NoThe expected activation duration for the reserved FCR-N up capacity that is assumed for all units in the system, the plant specific attribute with the same name will override this value.
global_settingsfcr_n_down_activation_timedoubleInputNoHOUR0.0SHOP_ADVANCED_RESERVE_ACTIVATION15.3.0.0NoThe expected activation duration for the reserved FCR-N down capacity that is assumed for all units in the system, the plant specific attribute with the same name will override this value.
global_settingsfcr_d_up_activation_timedoubleInputNoHOUR0.0SHOP_ADVANCED_RESERVE_ACTIVATION15.3.0.0NoThe expected activation duration for the reserved FCR-D up capacity that is assumed for all units in the system, the plant specific attribute with the same name will override this value.
global_settingsfcr_d_down_activation_timedoubleInputNoHOUR0.0SHOP_ADVANCED_RESERVE_ACTIVATION15.3.0.0NoThe expected activation duration for the reserved FCR-D down capacity that is assumed for all units in the system, the plant specific attribute with the same name will override this value.
global_settingsfrr_up_activation_timedoubleInputNoHOUR0.0SHOP_ADVANCED_RESERVE_ACTIVATION15.3.0.0NoThe expected activation duration for the reserved FRR up capacity that is assumed for all units in the system, the plant specific attribute with the same name will override this value.
global_settingsfrr_down_activation_timedoubleInputNoHOUR0.0SHOP_ADVANCED_RESERVE_ACTIVATION15.3.0.0NoThe expected activation duration for the reserved FRR down capacity that is assumed for all units in the system, the plant specific attribute with the same name will override this value.
global_settingsrr_up_activation_timedoubleInputNoHOUR0.0SHOP_ADVANCED_RESERVE_ACTIVATION15.3.0.0NoThe expected activation duration for the reserved RR up capacity that is assumed for all units in the system, the plant specific attribute with the same name will override this value.
global_settingsrr_down_activation_timedoubleInputNoHOUR0.0SHOP_ADVANCED_RESERVE_ACTIVATION15.3.0.0NoThe expected activation duration for the reserved RR down capacity that is assumed for all units in the system, the plant specific attribute with the same name will override this value.
global_settingsfcr_n_up_activation_penalty_costdoubleInputNoNOK/MM310000.0SHOP_ADVANCED_RESERVE_ACTIVATION15.3.0.0NoThe penalty cost for violating the reservoir volume constraints due to potential activation of FCR-N up reserves. Can also be set with the command ‘set reserve_activation_penalty_cost’.
global_settingsfcr_n_down_activation_penalty_costdoubleInputNoNOK/MM310000.0SHOP_ADVANCED_RESERVE_ACTIVATION15.3.0.0NoThe penalty cost for violating the reservoir volume constraints due to potential activation of FCR-N down reserves. Can also be set with the command ‘set reserve_activation_penalty_cost’.
global_settingsfcr_d_up_activation_penalty_costdoubleInputNoNOK/MM310000.0SHOP_ADVANCED_RESERVE_ACTIVATION15.3.0.0NoThe penalty cost for violating the reservoir volume constraints due to potential activation of FCR-D up reserves. Can also be set with the command ‘set reserve_activation_penalty_cost’.
global_settingsfcr_d_down_activation_penalty_costdoubleInputNoNOK/MM310000.0SHOP_ADVANCED_RESERVE_ACTIVATION15.3.0.0NoThe penalty cost for violating the reservoir volume constraints due to potential activation of FCR-D down reserves. Can also be set with the command ‘set reserve_activation_penalty_cost’.
global_settingsfrr_up_activation_penalty_costdoubleInputNoNOK/MM310000.0SHOP_ADVANCED_RESERVE_ACTIVATION15.3.0.0NoThe penalty cost for violating the reservoir volume constraints due to potential activation of FRR up reserves. Can also be set with the command ‘set reserve_activation_penalty_cost’.
global_settingsfrr_down_activation_penalty_costdoubleInputNoNOK/MM310000.0SHOP_ADVANCED_RESERVE_ACTIVATION15.3.0.0NoThe penalty cost for violating the reservoir volume constraints due to potential activation of FRR down reserves. Can also be set with the command ‘set reserve_activation_penalty_cost’.
global_settingsrr_up_activation_penalty_costdoubleInputNoNOK/MM310000.0SHOP_ADVANCED_RESERVE_ACTIVATION15.3.0.0NoThe penalty cost for violating the reservoir volume constraints due to potential activation of RR up reserves. Can also be set with the command ‘set reserve_activation_penalty_cost’.
global_settingsrr_down_activation_penalty_costdoubleInputNoNOK/MM310000.0SHOP_ADVANCED_RESERVE_ACTIVATION15.3.0.0NoThe penalty cost for violating the reservoir volume constraints due to potential activation of RR down reserves. Can also be set with the command ‘set reserve_activation_penalty_cost’.
global_settingsreserve_tactical_activation_cost_scalingdoubleInputNoNO_UNIT0.0SHOP_ADVANCED_RESERVE_ACTIVATION15.3.0.0NoThe penalty cost for violating the tactical reservoir volumes is decided by the reserve activation penalty cost scaled by this factor. Can also be set with the command ‘set reserve_tactical_activation_cost_scaling’.
global_settingsrsv_period_limit_penalty_costdoubleInputNoNOK/METER100000SHOP_OPEN17.1.0NoThe penalty cost for breaking the reservoir period level limit constraints, such as the dynamic_level_limit. Default value is 100 000 NOK/METER.
global_settingsplant_soft_consumption_penalty_costdoubleInputNoNOK/MWH100SHOP_OPEN17.8.0NoThe penalty cost for breaking max and min consumption constraints on plant level if no penalty costs are set for the plant. Default value is 100 NOK/MWh. Can also be set with the command ‘penalty cost’.
global_settingsplant_soft_upflow_penalty_costdoubleInputNoNOK/MWH100SHOP_OPEN17.8.0NoThe penalty cost for breaking max and min upflow constraints on plant level if no penalty costs are set for the plant. Default value is 100 NOK/MWh. Can also be set with the command ‘penalty cost’.
global_settingsplant_min_consumption_penalty_flagintInputNoNO_UNIT-1SHOP_OPEN17.8.0NoTurn on (1) or off (0) the addition of penalty variables to the min consumption restrictions on all plants. Default value -1 uses the min_consumption_penalty_flag specified on each plant to decide if the penalty variables should be added. Can also be set with the command ‘penalty flag’.
global_settingsplant_max_consumption_penalty_flagintInputNoNO_UNIT-1SHOP_OPEN17.8.0NoTurn on (1) or off (0) the addition of penalty variables to the max consumption restrictions on all plants. Default value -1 uses the max_consumption_penalty_flag specified on each plant to decide if the penalty variables should be added. Can also be set with the command ‘penalty flag’.
global_settingsplant_min_upflow_penalty_flagintInputNoNO_UNIT-1SHOP_OPEN17.8.0NoTurn on (1) or off (0) the addition of penalty variables to the min upflow restrictions on all plants. Default value -1 uses the min_upflow_penalty_flag specified on each plant to decide if the penalty variables should be added. Can also be set with the command ‘penalty flag’.
global_settingsplant_max_upflow_penalty_flagintInputNoNO_UNIT-1SHOP_OPEN17.8.0NoTurn on (1) or off (0) the addition of penalty variables to the max upflow restrictions on all plants. Default value -1 uses the min_upflow_penalty_flag specified on each plant to decide if the penalty variables should be added. Can also be set with the command ‘penalty flag’.
global_settingsinclude_rr_schedules_in_bp_curvesintInputNoNO_UNIT0SHOP_BEST_PROFIT17.18.0NoTurn on (1) or off (0) inclusion of RR reserve schedules in best profit calculations. Default setting is off.
global_settingsuse_heuristic_basisintInputNoNO_UNIT0SHOP_OPEN14.0.0.1NoIf this parameter is set to 1 a heuristic start basis is given to CPLEX, while a value of 0 (default) does not provide CPLEX with a start basis guess. Can also be set with the command ‘set optbasis’.
global_settingsnodelogintInputNoNO_UNIT100SHOP_OPEN14.0.0.1NoSet the MIP node logging interval (100 is default) used by CPLEX when updating the CPLEX log file. Can also be set with the command ‘set mip_nodelog’.
global_settingsmax_num_threadsintInputNoNO_UNIT-1SHOP_OPEN14.0.0.1NoSet the max number of threads CPLEX can use when solving a MIP problem or using the barrier solver. Default of -1 lets CPLEX use all available threads. Can also be set with the command ‘set max_num_threads’.
global_settingsparallelmodeintInputNoNO_UNIT1SHOP_OPEN14.0.0.1NoChoose the parallel mode CPLEX uses when solving a problem in parallel: 1 (default) gives deterministic result behaviour while -1 lets CPLEX fully utilize the parallel processing. A value of 0 lts CPLEX choose based on the problem. Can also be set with the command ‘set parallel_mode’.
global_settingstimelimitdoubleInputNoSECOND900.0SHOP_OPEN14.0.0.1NoMaximal number of seconds that can be used to solve a SHOP iteration in CPLEX. Default value is 900 s. Can also be set with the command ‘set timelimit’.
global_settingsmipgap_reldoubleInputNoNO_UNIT-1.0SHOP_OPEN14.0.0.1NoThe maximal relative objective function gap between final integer solution and best bound in CPLEX. Default value is -1 which uses default CPLEX relative MIP gap. Can also be set with the command ‘set mipgap’.
global_settingsmipgap_absdoubleInputNoNOK-1.0SHOP_OPEN14.0.0.1NoThe maximal objective function gap between final integer solution and best bound in CPLEX. Default value is -1 which uses default CPLEX absolute MIP gap. Can also be set with the command ‘set mipgap’.
global_settingsintepsdoubleInputNoNO_UNIT0.00001SHOP_OPEN14.0.0.1NoNumerical tolerance for when CPLEX will consider a decimal number to be integer. Default value is 0.00001. Can also be set with the command ‘set inteps’.
global_settingsinput_basis_namestringInputNoSTRINGEmptySHOP_OPEN14.0.0.1NoName of the file containing a saved input basis for the optimization problem is saved. If no name is given, no input basis will be loaded. Can also be set with the command ‘read optbasis’.
global_settingsoutput_basis_namestringInputNoSTRINGEmptySHOP_OPEN14.0.0.1NoName of the file where the optimal basis from the optimization problem in the next iteration is saved. If no name is given, no basis will be saved. Can also be set with the command ‘save optbasis’.
global_settingssolver_algorithmstringInputNoSTRINGDUALSHOP_OPEN14.0.0.1NoName of the solution algorithm CPLEX will use to solve linear problems, can be either ‘PRIMAL’, ‘DUAL’ (default), ‘BARRIER’, ‘NETPRIMAL’, ‘NETDUAL’, or ‘CONCURRENT’. Can also be set with the command ‘set method’.
global_settingscplex_int_paramsxyInputNox: NO_UNIT and y: NO_UNITNone/nullSHOP_OPEN16.4.0NoSpecify any integer parameter that can be set in CPLEX by specifying the identifiers as x values and the int parameters as y values. See the CPLEX documentation for a complete list of parameters to set. For instance, the ‘MIP emphasis switch’ parameter has an id of 2058 and may take the values from 0 to 5.
global_settingscplex_double_paramsxyInputNox: NO_UNIT and y: NO_UNITNone/nullSHOP_OPEN16.4.0NoSpecify any floating point parameter that can be set in CPLEX by specifying the identifiers as x values and the double parameters as y values. See the CPLEX documentation for a complete list of parameters to set. For instance, the ‘Benders optimality cut tolerance’ parameter has an id of 1510 and may be any number from 1e-9 to 1e-1.
global_settingsgurobi_int_paramssyInputNos: STRING and y: NO_UNITNone/nullSHOP_SOLVER_GUROBI17.14.0NoSpecify any integer parameter that can be set in Gurobi by specifying the parameter names as the strings and the parameter values as the y values. See the Gurobi documentation for a complete list of parameters to set. For instance, ‘MIPFocus’ is a valid parameter name that may take integer values from 0 to 3.
global_settingsgurobi_double_paramssyInputNos: STRING and y: NO_UNITNone/nullSHOP_SOLVER_GUROBI17.14.0NoSpecify any floating point parameter that can be set in Gurobi by specifying the parameter names as the strings and the parameter values as the y values. See the Gurobi documentation for a complete list of parameters to set. For instance, ‘Cutoff’ is a valid parameter name that may take any double value.
global_settingsmin_lp_infointInputNoNO_UNIT0SHOP_OPEN17.13.0NoSet this to 1 to avoid copying over the variable and constraint names to CPLEX (default behaviour), which could save time and memory for large SHOP models. Can also be set with the command ‘set lp_info’.
global_settingsn_seg_upintInputNoNO_UNIT3SHOP_OPEN14.0.0.1NoNumber of segments to be used above best efficient point in incremental mode. Can also be set with the command ‘set nseg’.
global_settingsn_seg_downintInputNoNO_UNIT3SHOP_OPEN14.0.0.1NoNumber of segments to be used below best efficient point in incremental mode. Can also be set with the command ‘set nseg’.
global_settingsn_mip_seg_upintInputNoNO_UNIT3SHOP_OPEN14.0.0.1NoNumber of segments to be used above best efficient point in full mode. Can also be set with the command ‘set nseg’.
global_settingsn_mip_seg_downintInputNoNO_UNIT3SHOP_OPEN14.0.0.1NoNumber of segments to be used below best efficient point in full mode. Can also be set with the command ‘set nseg’.
global_settingsdyn_pq_seg_flagintInputNoNO_UNIT0SHOP_OPEN14.0.0.1NoFlag determining whether dynamically define the segments in the building of the original PQ curve for all the units in incremental mode if no flag series on the plant is provided. Can also be set with the command ‘set dyn_seg’.
global_settingsdyn_mip_pq_seg_flagintInputNoNO_UNIT0SHOP_OPEN14.0.0.1NoFlag determining whether dynamically define the number of points of the original PQ curve for all the units in full mode if no flag series on the plant or generator is provided. Can also be set with the command ‘set dyn_seg’.
global_settingsbypass_segmentsintInputNoNO_UNIT1SHOP_OPEN14.0.0.1NoChange the number of variables used to describe the flow in bypass gates. Default number of segments is 1.
global_settingsgate_segmentsintInputNoNO_UNIT3SHOP_OPEN14.0.0.1NoChange the number of variables used to describe the flow in regular gates. Default number of segments is 3.
global_settingsoverflow_segmentsintInputNoNO_UNIT3SHOP_OPEN14.0.0.1NoChange the number of variables used to describe the flow in spill gates. Default number of segments is 3.
global_settingsgravitydoubleInputNoNO_UNIT9.81SHOP_OPEN14.0.0.1NoThe value of the acceleration due to gravity. Default value is 9.81 m/s2. Can also be set with the command ‘set gravity’.
global_settingsgen_reserve_min_free_cap_factordoubleInputNoNO_UNIT0.02SHOP_OPEN14.0.0.1NoThe fraction of the maximal generator production that must be left open while the generator is delivering FCR. Default value is 0.02. Can also be set with the command ‘set reserve_min_capacity’.
global_settingsfcr_n_banddoubleInputNoNO_UNIT0.1SHOP_OPEN14.0.0.1NoThe size of the frequency range in either direction where FCR-N is activated. Default value is 0.1 Hz (49.9 to 50.1 Hz). Can also be set with the command ‘set fcr_n_band’.
global_settingsfcr_d_banddoubleInputNoNO_UNIT0.4SHOP_OPEN14.0.0.1NoThe size of the frequency range in upward direction where FCR-D is activated. Default value is 0.4 Hz (49.5 to 49.9 Hz). Can also be set with the command ‘set fcr_d_band’.
global_settingsuniversal_mipintInputNoNO_UNIT-1SHOP_OPEN14.0.0.1NoToggle the use of binary variables for generator and pump unit commitment on (1) or off (0). Default value of -1 uses mip_flag on each plant to decide if binary variables should be used. Can also be set by the command ‘set universal_mip’.
global_settingsuniversal_overflow_mipintInputNoNO_UNIT-1SHOP_OPEN14.0.0.9NoToggle the use of binary variables to for reservoir to prevent non-physical spill. Default value of -1 uses overflow_mip_flag on each reservoir to decide if binary variables should be used. Can also be set by the command ‘set universal_overflow_mip’.
global_settingsuniversal_river_mipintInputNoNO_UNIT-1SHOP_OPEN15.3.3.1NoToggle the use of binary variables to for river to prevent flow when water level is below weir. Default value of -1 uses river_mip_flag on each river to decide if binary variables should be used. Can also be set by the command ‘set universal_river_mip’.
global_settingslinear_startupintInputNoNO_UNIT-1SHOP_OPEN14.0.0.1NoToggle the building of linear startup and shutdown costs for generators and pumps on (1) or off (0) when MIP is not active. Default value of -1 uses linear_startup_flag on each plant to decide if startup and shutdown costs should be used. Can also be set by the command ‘set linear_startup’.
global_settingsdyn_flex_mip_stepsintInputNoNO_UNIT-1SHOP_DYN_FLEX14.0.0.1NoSet the number of time steps used for dynamic flexible MIP. Default value of -1 turns off the dynamic flexible MIP functionality. Can also be set with the command ‘set dyn_flex_mip’.
global_settingsmerge_blocksintInputNoNO_UNIT0SHOP_BLOCK_MERGE14.0.0.1NoTurn on (1) or off (0, default) the mering of similar and adjacent time steps for gate discharge and plant production results. A value of 2 will only keep merged blocks from the previous iteration and stop further merging. Can also be set with the command ‘set merge’.
global_settingspower_head_optimizationintInputNoNO_UNIT1SHOP_OPEN14.0.0.1NoTurn on (1, default) or off (0) power head optimization functionality. Can also be set with the command ‘set power_head_optimization’.
global_settingsdroop_discretization_limitdoubleInputNoNO_UNIT0.0SHOP_DISCRETE_DROOP14.0.1.0YesSet the limit for fixing the droop value of all units that have a resulting droop below the specified limit. The droop is fixed to the closest legal discrete value below the given limit, which is the closest integer below unless the unit has a defined discrete_droop_values attribute. Default value is 0.0. Can also be set with the command ‘set discrete_droop_limit’.
global_settingsdroop_cost_exponentdoubleInputNoNO_UNIT1.0SHOP_RESERVE_GROUP14.2.0.3NoSet this value to any positive number higher than 1.0 to build a convex and increasing cost curve for the droop value instead of using a linear cost. The number represents the degree of the convex polynomial used to build the cost curve, which means that a value of 2.0 results in a quadratic cost curve. Can also be set with the command ‘set droop_cost_exponent’.
global_settingsdroop_ref_valuedoubleInputNoNO_UNIT6.0SHOP_RESERVE_GROUP14.2.0.3NoUsed to scale the exponential droop cost when the droop_cost_exponent is higher than 1. The exponential cost will be the same as the standard linear cost for the reference value. Can also be set with the command ‘set droop_ref_value’.
global_settingsdisable_rsv_penaltiesintInputNoNO_UNIT0SHOP_OPEN16.4.0NoDisable the use of reservoir penalty variables by setting this parameter to 1. This means that SHOP is unable to create or destroy water by using penalties, but the optimization model may be infeasible. Therefore, this feature is mostly useful for debugging models with lots of reservoir penalties. See the corresponding ‘disable_penalties’ on the reservoir object for individual reservoir specification.
global_settingsbinary_reserve_limitsintInputNoNO_UNIT-1SHOP_OPEN16.4.1NoIf this attribute is set to 1, binary variables will be used to enforce the minimum reserve limit imposed by frr_down_min etc. on unit and plant level. If it is set to zero the binary variables are relaxed, and fixed to 0 or 1 in incremental iterations based on the reserve delivery in the previous iteration. The default option of -1 will use binary variables in full iterations if the mip_flag on the plant is active, and otherwise relax and fix them to either 0 or 1 depending on the reserve delivery in the previous iteration.
global_settingsuniversal_strict_pq_uploadingintInputNoNO_UNIT-1SHOP_OPEN16.5.0NoIf this attribute is set to 1, binary variables will be used to enforce the correct uploading of each segment in the PQ curves of all generators and time steps. Setting the attribute to zero will disable all use of binary variables in the PQ curve segmentation, while the default setting of -1 will let the plant attributes strict_pq_uploading_flag and strict_pq_uploading_upon_detection determine the behaviour. Can also be set with the command ‘set universal_strict_pq_uploading’.
global_settingsuse_armadillo_solverintInputNoNO_UNIT1SHOP_OPEN17.1.0NoToggle the use of the new internal linear algebra solver for tunnel networks based on the Armadillo C++ library (1, default) versus the old solver (0).
global_settingscreate_cutsintInputNoNO_UNIT0SHOP_SCENARIO_FUNCTIONALITY14.0.0.1NoTurn on (1) or off (0, default) the createion of cuts for the start time of the SHOP run.
global_settingsprint_sim_inflowintInputNoNO_UNIT0SHOP_SIMULATION14.0.0.1NoTurn on (1) or off (0, default) the printing of simulated inflow to the simulation result text files. Can also be set with the command ‘start shopsim’.
global_settingspump_head_optimizationintInputNoNO_UNIT0SHOP_OPEN14.0.0.1NoTurn on (1) or off (0, default) the inclusion of pump variables in the power head optimization. Can also be set with the command ‘set power_head_optimization’.
global_settingssave_pq_curvesintInputNoNO_UNIT0SHOP_OPEN14.0.0.1NoTurn on (1) or off (0, default) the saving of the constructed PQ curves for each unit. Can also be set with the command ‘save pq_curves’.
global_settingsbuild_original_pq_curves_by_discharge_limitsintInputNoNO_UNIT0SHOP_OPEN16.0.0NoTurn on (1) or off (0, default) the building of the original PQ curves by only considering physical discharge-related limits. Can also be set with the command ‘set build_original_pq_curves_by_discharge_limits’.
global_settingsplant_unbalance_recommitintInputNoNO_UNIT0SHOP_OPEN14.0.0.1NoTurn on (1) or off (0, default) the heuristic that attempts to recommit units in a better way for hours without MIP and the resulting plant discharge is smaller than the optimal discharge from solver. Can also be set with the command ‘set plant_unbalance_recommit’.
global_settingsprefer_start_volintInputNoNO_UNIT1SHOP_OPEN14.0.0.1NoTurn on (1, default) or off (0) the preference of start_vol over start_level for reservoirs where both are specified. Initial water level will be preferred if this attribute is set to zero. Can also be set with the command ‘set initial_reservoir’.
global_settingsbp_print_dischargeintInputNoNO_UNIT0SHOP_BEST_PROFIT14.0.0.1NoSet this attribute to 1 (default 0) to also print the generator discharge to the BP files. Can also be set with the command ‘print bp_curves’.
global_settingsprod_from_ref_prodintInputNoNO_UNIT0SHOP_BEST_PROFIT14.0.0.1NoSet this attribute to 1 (default 0) to create a production schedule for all generators based on the ref_production attribute before calculating the BP curves. Can also be set with the command ‘set prod_from_ref_prod’.
global_settingsbp_min_pointsintInputNoNO_UNIT50SHOP_BEST_PROFIT14.0.0.1No... Can also be set with the command ‘set min_bp_points’.
global_settingsbp_modeintInputNoNO_UNIT0SHOP_BEST_PROFIT14.0.0.1NoDecides how the BP algorithm selects points from the MC curves to create the final BP curves: use regulation profit as jump criteria (0, default), use operational profit as jump criteria (1), or follow the unit comination uploading of the MC curves directly (2). Can also be set with the command ‘create bp_curves’.
global_settingsstop_cost_from_start_costintInputNoNO_UNIT0SHOP_OPEN14.0.0.1NoTurn on (1) or off (0, default) the usage of the input generator start cost as stop cost. Can also be set with the command ‘set stop_cost_from_start_cost’.
global_settingsownership_scalingintInputNoNO_UNIT0SHOP_OPEN14.0.0.1NoTurn on (1) or off (0, default) the rescaling of the production results for plants and generators that have an ownership less than 100. The scaled results are only found in the text result files. Can also be set with the command ‘set ownership_scaling’.
global_settingstime_delay_unitstringInputNoSTRINGTIME_STEP_LENGTHSHOP_OPEN14.0.0.1NoDeprecated: All time delay should be modelled by using the river object (does not require additional license), which is independent of this attribute. Specifies the time unit of the time delay for plants and gates in the system. Must be either ‘MINUTE’, ‘HOUR’ or ‘TIME_STEP_LENGTH’ (default). Can also be set with the command ‘set time_delay_unit’.
global_settingsbypass_lossintInputNoNO_UNIT0SHOP_OPEN14.0.0.1NoTurn on (1) or off (0, default) the addition of the flow in bypass gates when calculating tailrace loss for plants if tailrace_loss_from_bypass_flag is not used. Can also be set with the command ‘set bypass_loss’.
global_settingsgen_turn_off_limitdoubleInputNoNO_UNIT0.5SHOP_OPEN14.0.0.1NoA decimal number between 0 and 1 that signifies if the generator operates below the fraction (the decimal number) of its minimum operating limit in full mode without MIP, the generator will be turned off. Default value is 0.5. Can also be set with the command ‘set gen_turn_off_limit’.
global_settingspump_turn_off_limitdoubleInputNoNO_UNIT0.5SHOP_OPEN14.0.0.1NoA decimal number between 0 and 1 that signifies if the pump operates below the fraction (the decimal number) of its minimum operating limit in full mode without MIP, the pump will be turned off. Default value is 0.5. Can also be set with the command ‘set pump_turn_off_limit’.
global_settingsfcr_n_equality_flagintInputNoNO_UNIT0SHOP_RESERVE_GROUP14.0.0.1NoTurn on (1) or off (0, default) the building of constraints to force the fcr_n delivery for all units to by symmetric. Can also be set with the command ‘set fcr_n_equality_flag’.
global_settingsdelay_valuation_modeintInputNoNO_UNIT0SHOP_OPEN14.0.0.1NoThe value 0 (default) uses the first value in the water value description to set the value of water in transition at the end of the optimization period. Setting the value to 1 will use the middle point of the water value description instead. Can also be set with the command ‘set delay_valuation_mode’.
global_settingsuniversal_affinity_flagintInputNoNO_UNIT-1SHOP_OPEN14.0.0.1NoTurn on (1) or off (0) the use of affinity equations for translating turbine efficiency curves of generators. Default value of -1 uses affinity_eq_flag on each generator to decide if affinity equations should be used. Can also be set by the command ‘set universal_affinity’.
global_settingsramp_codeintInputNoNO_UNIT0SHOP_OPEN14.0.0.1NoToggle the building of ramping constraints on (1), off (-1), or when violated in previous iteration (0, default). Can also be set with the command ‘set ramping’.
global_settingsprint_original_pq_curvesintInputNoNO_UNIT0SHOP_OPEN14.0.0.1NoTurn on (1) or off (0, default) the writing of the original PQ curves constructed by SHOP before convexification to file. Can also be set with the command ‘print pq_curves’.
global_settingsprint_convex_pq_curvesintInputNoNO_UNIT0SHOP_OPEN14.0.0.1NoTurn on (1) or off (0, default) the writing of the convexified PQ curves constructed by SHOP to file. Can also be set with the command ‘print pq_curves’.
global_settingsprint_final_pq_curvesintInputNoNO_UNIT0SHOP_OPEN14.0.0.1NoTurn on (1) or off (0, default) the writing of the final PQ curves used in the optimization by SHOP to file. Can also be set with the command ‘print pq_curves’.
global_settingsshop_log_namestringInputNoSTRINGshop.logSHOP_OPEN14.0.0.1NoName of the log file written to by SHOP, default is ‘shop.log’. Can also be set with the command ‘log file’.
global_settingsshop_yaml_log_namestringInputNoSTRINGshop_yaml.yamlSHOP_OPEN14.0.0.1NoName of the yaml log file written to by SHOP, default is ‘shop_yaml.yaml’.
global_settingssolver_log_namestringInputNoSTRINGcplex.logSHOP_OPEN14.0.0.1NoName of the log file written to by the solver, default is ‘cplex.log’. Can also be set with the command ‘log file’.
global_settingsminimal_infeasible_problem_filestringInputNoSTRINGminimal_infeasible_problem.lpSHOP_OPEN15.5.1.0NoName of the log file written to by the solver when the problem is infeasible, default is ‘minimal_infeasible_problem.lp’. Can also be set with the command ‘log file infeasible.lp /lpmin’.
global_settingsmodel_file_namestringInputNoSTRINGEmptySHOP_OPEN14.0.0.1NoName of the file where the model seen by the optimization solver will be written to in the next iteration. If no name is given, the model will not be printed to file. Can also be set with the command ‘print model’.
global_settingspq_curves_namestringInputNoSTRINGEmptySHOP_OPEN14.0.0.1NoName of the file the PQ curves will be written to if activated by setting the print_<>_pq_curves attributes. A default file name based on the iteration will be used if this attribute is not set. Can also be set with the command ‘print pq_curves’.
global_settingsprint_lossintInputNoNO_UNIT0SHOP_OPEN14.0.0.1NoTurn on (1) or off (0, default) the writing of junction tunnel loss to the result files. Can also be set with the caommand ‘save tunnel_loss’.
global_settingsshop_xmllogintInputNoNO_UNIT0SHOP_OPEN14.0.0.1NoWrite the log to xml format if this value is set to 1 instead of the default value 0. Can also be set with the command ‘set xmllog’.
global_settingsprint_optimized_startup_costsintInputNoNO_UNIT0SHOP_OPEN14.0.0.1NoSet value to 1 to only print out the startup and shutdown costs that have been seen by the optimization solver to the log file. Default value of 0 prints out the post calculated startup and shutdown costs. Can also be set with the command ‘set startup_cost_printout’.
global_settingsget_duals_from_mipintInputNoNO_UNIT0SHOP_OPEN14.0.0.1NoSet value to 1 to fix binary variables after solving a MIP iteration and solving the resulting linear problem again to get dual values. Default value of 0 does not re-solve MIP problems to get dual values. Can also be set with the command ‘set duals_from_mip’.
global_settingsbid_aggregation_levelintInputNoNO_UNIT-1SHOP_SCENARIO_FUNCTIONALITY14.0.0.1NoSet the bid aggregation level of the SHARM bidding functionality to add all plants to the same bid group (0) or to create individual bid groups for each plant (1). If set to -1 (default), the plants are placed in bid groups according to the bid_group attribute on the plant. Can also be set with the command ‘set bid_aggregation_level’.
global_settingssimple_pq_recoveryintInputNoNO_UNIT0SHOP_OPEN14.0.0.1NoTurn on (1) or off (0, default) simplified building of PQ curves with a single segment for problematic generators suffering from non-physical uploading of the PQ segments. Can also be turned on with the command ‘set simple_pq_recovery’.
global_settingsrr_up_schedule_slack_flagintInputNoNO_UNIT0SHOP_OPEN14.2.0.1NoTurn on (1) or off (0, default) slack variable for RR_UP schedule on generators. Penalty cost for slack is set equal to reserve_slack_cost.
global_settingsbinary_pump_schedule_slack_flagintInputNoNO_UNIT1SHOP_OPEN17.15.0NoTurn on (1, default) or off (0) slack variable to allow binary pumps to deliver more reserve capacity than specified in their reserve schedules. The penalty cost for slack is set equal to reserve_slack_cost.
global_settingsbp_ref_mc_from_marketintOutputNoNO_UNIT0SHOP_BEST_PROFIT14.2.0.4NoTurn on (1) or off (0, default) functionality taking marginal cost from market description for current operating point on the best profit curve.
global_settingsbp_bid_matrix_pointsintInputNoNO_UNIT200SHOP_OPEN14.2.2.0NoThe maximum number of price columns allowed in the best_profit_bid_matrix on the plant object.
global_settingsramp_scale_factordoubleInputNoNO_UNIT1.0SHOP_OPEN14.3.0.2YesUsed to scale all input ramping values for production and discharge on plants, gates, and reservoirs. Can also be set with the command ‘set ramp_scale_factor’.
global_settingsriver_flow_penalty_costdoubleInputNoNOK/H/M3/S1000.0SHOP_OPEN14.3.1.0NoThe default penalty cost for breaking the min_flow and max_flow constraints defined on river objects.
global_settingsriver_flow_schedule_penalty_costdoubleInputNoNOK/H/M3/S10000.0SHOP_OPEN14.4.0.0NoThe default penalty cost for breaking the flow_schedule constraints defined on river objects.
global_settingsrecommitintInputNoNO_UNIT1SHOP_OPEN14.4.0.0NoTurn on (1, default) or off (0) the general heuristic that attempts to recommit units in a better way for hours without MIP.
global_settingsdroop_costdoubleInputNoNOK55.0SHOP_OPEN15.5.4.2NoThe global cost added to the inverse droop variables related to FCR reserve delivery, which makes SHOP prefer high droop settings (default is 55). The unit-specific droop_cost attributes will override this value if specified. The droop cost could skew optimization against reserve market prices.
global_settingsrr_down_stop_mipintInputNoNO_UNIT0SHOP_RESERVE_GROUP15.6.0.0NoSetting this attribute to 1 turns on the use of binary variables in full iterations to ensure all generators delivering RR-DOWN reserves have valid stop deliveries. This forces RR-DOWN to either be allocated as a spinning reserve down to p_rr_min (defaults to p_min) or down to a full stop, and no other spinning reserves can be allocated on the unit if RR-DOWN is delivered down to stop. RR-DOWN allocation in forbidden production regions (between 0 and p_rr_min) is also prohibited. The generator attribute ‘rr_down_stop_mip_flag’ can be used to override this attribute per generator.
global_settingsrr_up_stop_mipintInputNoNO_UNIT0SHOP_RESERVE_GROUP15.6.1.0NoSetting this attribute to 1 turns on the use of binary variables in full iterations to ensure all pumps delivering RR-UP reserves have valid stop deliveries. This forces RR-UP to either be allocated as a spinning reserve up to p_rr_min (defaults to p_min) or up to a full stop, and no other spinning reserves can be allocated on the unit if RR-UP is delivered to stop. RR-UP allocation in forbidden consumption regions (between 0 and p_rr_min) is also prohibited. The pump attribute ‘rr_up_stop_mip_flag’ can be used to override this attribute per pump.
global_settingsplant_max_prod_reserve_strategystringInputNoSTRINGOFFSHOP_RESERVE_GROUP16.2.0NoDetermines what type of max limit constraints will be added to limit the production including upward reserve capacity on plant level: ‘OFF’ (default) - no max constraint is added, ‘ALL’ - max_prod_all on the plant will be used as upper limit for plant production including upward reserves, ‘AVAILABLE’ - max_prod_available on the plant will be used as upper limit, ‘SPINNING’ - max_prod_spinning on the plant will be used as upper limit. This setting is overridden by the plant attribute ‘max_prod_reserve_strategy’, and can also be set with the command ‘set plant_max_prod_reserve_strategy’.
global_settingsplant_min_prod_reserve_strategystringInputNoSTRINGOFFSHOP_RESERVE_GROUP16.2.0NoDetermines what type of min limit constraints will be added to limit the production including downward reserve capacity on plant level: ‘OFF’ (default) - no min constraint for plant production including downward reserves, ‘SPINNING’ - the min_prod_spinning attribute on the plant will be used as lower limit. This setting is overridden by the plant attribute ‘min_prod_reserve_strategy’, and can also be set with the command ‘set plant_min_prod_reserve_strategy’.
global_settingsfrr_mipintInputNoNO_UNIT0SHOP_RESERVE_GROUP17.13.0NoSetting this attribute to 1 will turn on the use of binary variables in full iterations to ensure that delivered FRR reserves are outside forbidden zones.
global_settingsscale_bp_curves_by_best_point_mcintInputNoNO_UNIT0SHOP_BEST_PROFIT17.16.0NoSetting this attribute to 1 will scale all MC, AC, and the BP curves generated by the best profit functionality by the marginal cost of the plant at the best point operation in each time step. This makes the y-values of the curves dimensionless and easy to scale.
global_settingsshop_versionstringOutputNoSTRING18.5.0 Cplex 20.1.0 Gurobi 13.0.1 OSI/CBC 2.10 HiGHS 1.15.1 2026-11-06SHOP_OPEN15.5.0.0NoVersion string.
global_settingsriver_big_m_factordoubleInputNoNO_UNIT1.0SHOP_OPEN15.5.0.0NoScale factor to reduce the river big-M value relative to result in previous iteration to reduce computation time.
reserve_groupfcr_n_up_obligationtimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesThe obligation of FCR_N_UP that should be fulfilled by the reserve group.
reserve_groupfcr_n_down_obligationtimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesThe obligation of FCR_N_DOWN that should be fulfilled by the reserve group.
reserve_groupfcr_d_up_obligationtimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesThe obligation of FCR_D_UP that should be fulfilled by the reserve group.
reserve_groupfcr_d_down_obligationtimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP14.2.0.0YesThe obligation of FCR_D_DOWN that should be fulfilled by the reserve group.
reserve_groupfrr_up_obligationtimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesThe obligation of FRR_UP that should be fulfilled by the reserve group.
reserve_groupfrr_down_obligationtimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesThe obligation of FRR_DOWN that should be fulfilled by the reserve group.
reserve_grouprr_up_obligationtimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesThe obligation of RR_UP that should be fulfilled by the reserve group.
reserve_grouprr_down_obligationtimeseriesInputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aYesThe obligation of RR_DOWN that should be fulfilled by the reserve group.
reserve_groupfcr_n_penalty_costtimeseriesInputNoNOK/MWHNone/nullSHOP_RESERVE_GROUP13.0.0.aNoGiven penalty cost for deviating below the FCR_N_UP or FCR_N_DOWN obligation for the reserve group.
reserve_groupfcr_d_penalty_costtimeseriesInputNoNOK/MWHNone/nullSHOP_RESERVE_GROUP13.0.0.aNoGiven penalty cost for deviating below the FCR_D_UP obligation for the reserve group.
reserve_groupfrr_penalty_costtimeseriesInputNoNOK/MWHNone/nullSHOP_RESERVE_GROUP13.0.0.aNoGiven penalty cost for deviating below the FRR_UP or FRR_DOWN obligation for the reserve group.
reserve_grouprr_penalty_costtimeseriesInputNoNOK/MWHNone/nullSHOP_RESERVE_GROUP13.0.0.aNoGiven penalty cost for deviating below the RR_UP or RR_DOWN obligation for the reserve group.
reserve_groupfcr_n_up_slacktimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aNoResulting slack when deviating above the FCR_N_UP obligation.
reserve_groupfcr_n_down_slacktimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aNoResulting slack when deviating above the FCR_N_DOWN obligation.
reserve_groupfcr_d_up_slacktimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aNoResulting slack when deviating above the FCR_D_UP obligation.
reserve_groupfcr_d_down_slacktimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP14.2.0.0NoResulting slack when deviating above the FCR_D_DOWN obligation.
reserve_groupfrr_up_slacktimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aNoResulting slack when deviating above the FRR_UP obligation.
reserve_groupfrr_down_slacktimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aNoResulting slack when deviating above the FRR_DOWN obligation.
reserve_grouprr_up_slacktimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aNoResulting slack when deviating above the RR_UP obligation.
reserve_grouprr_down_slacktimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aNoResulting slack when deviating above the RR_DOWN obligation.
reserve_groupfcr_n_up_violationtimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aNoResulting penalty when deviating below the FCR_N_UP obligation.
reserve_groupfcr_n_down_violationtimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aNoResulting penalty when deviating below the FCR_N_DOWN obligation.
reserve_groupfcr_d_up_violationtimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aNoResulting penalty when deviating below the FCR_D_UP obligation.
reserve_groupfcr_d_down_violationtimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP14.2.0.0NoResulting penalty when deviating below the FCR_D_DOWN obligation.
reserve_groupfrr_up_violationtimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aNoResulting penalty when deviating below the FRR_UP obligation.
reserve_groupfrr_down_violationtimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aNoResulting penalty when deviating below the FRR_DOWN obligation.
reserve_grouprr_up_violationtimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aNoResulting penalty when deviating below the RR_UP obligation.
reserve_grouprr_down_violationtimeseriesOutputNoMWNone/nullSHOP_RESERVE_GROUP13.0.0.aNoResulting penalty when deviating belown the RR_DOWN obligation.
commit_groupdeactivate_exclusion_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN14.0.0.1NoA flag that can be used to deactivate the commitment exclusion constraints if the flag value is set to 1.
discharge_groupinitial_deviation_mm3doubleInputNoMM30.0SHOP_DISCHARGE_GROUP_FUNCTIONALITY13.0.0.aNoThe initial volume deviation for the discharge group before the optimization period. The positive value refers to the upward deviation from weighted discharge while the negative value refers to the downward deviation from weighted discharge.
discharge_groupmax_accumulated_deviation_mm3_uptimeseriesInputNoMM3None/nullSHOP_DISCHARGE_GROUP_FUNCTIONALITY13.0.0.aYesMaximum accumulated upward volume deviation (Mm3) for the discharge group.
discharge_groupmax_accumulated_deviation_mm3_downtimeseriesInputNoMM3None/nullSHOP_DISCHARGE_GROUP_FUNCTIONALITY13.0.0.aYesMaximum accumulated downward volume deviation (Mm3) for the discharge group.
discharge_groupweighted_discharge_m3stimeseriesInputNoM3/SNone/nullSHOP_DISCHARGE_GROUP_FUNCTIONALITY13.0.0.aNoWeighted discharge target for the discharge group.
discharge_grouppenalty_cost_up_per_mm3timeseriesInputNoNOK/MM3None/nullSHOP_DISCHARGE_GROUP_FUNCTIONALITY13.0.0.aNoGiven penalty cost for discharging more than the allowed max accumulated deviation for the discharge group.
discharge_grouppenalty_cost_down_per_mm3timeseriesInputNoNOK/MM3None/nullSHOP_DISCHARGE_GROUP_FUNCTIONALITY13.0.0.aNoGiven penalty cost for discharging less than the allowed max accumulated deviation for the discharge group.
discharge_groupmin_discharge_m3stimeseriesInputNoM3/SNone/nullSHOP_DISCHARGE_GROUP_FUNCTIONALITY14.0.2.1YesMinimal sum discharge allowed in the discharge group.
discharge_groupmax_discharge_m3stimeseriesInputNoM3/SNone/nullSHOP_DISCHARGE_GROUP_FUNCTIONALITY14.0.2.1YesMaximal sum discharge allowed in the discharge group.
discharge_groupmin_discharge_penalty_costtimeseriesInputNoNOK/H/M3/SNone/nullSHOP_DISCHARGE_GROUP_FUNCTIONALITY14.0.2.1NoPenalty cost for violating the minimum discharge constraint of the discharge group.
discharge_groupmax_discharge_penalty_costtimeseriesInputNoNOK/H/M3/SNone/nullSHOP_DISCHARGE_GROUP_FUNCTIONALITY14.0.2.1NoPenalty cost for violating the maximum discharge constraint of the discharge group.
discharge_groupramping_up_m3stimeseriesInputNoM3SEC_HOURNone/nullSHOP_DISCHARGE_GROUP_FUNCTIONALITY14.0.2.1YesMaximal discharge ramping of the total discharge allowed in the upward direction.
discharge_groupramping_down_m3stimeseriesInputNoM3SEC_HOURNone/nullSHOP_DISCHARGE_GROUP_FUNCTIONALITY14.0.2.1YesMaximal discharge ramping of the total discharge allowed in the downward direction.
discharge_groupramping_up_penalty_costtimeseriesInputNoNOK/H/M3/SNone/nullSHOP_DISCHARGE_GROUP_FUNCTIONALITY14.0.2.1NoPenalty cost for violating the upward discharge ramping constraint in the discharge group.
discharge_groupramping_down_penalty_costtimeseriesInputNoNOK/H/M3/SNone/nullSHOP_DISCHARGE_GROUP_FUNCTIONALITY14.0.2.1NoPenalty cost for violating the downward discharge ramping constraint in the discharge group.
discharge_groupmin_average_dischargexytInputNox: MINUTE and y: M3/SNone/nullSHOP_AVERAGE_Q15.4.0.0NoMinimum average discharge of group. T gives time the constraint is active from, X the duration of the constraint in minutes, and Y the discharge limit.
discharge_groupmax_average_dischargexytInputNox: MINUTE and y: M3/SNone/nullSHOP_AVERAGE_Q15.4.0.0NoMaximum average discharge of group. T gives time the constraint is active from, X the duration of the constraint in minutes, and Y the discharge limit.
discharge_groupmin_average_discharge_penalty_costdoubleInputNoNOK/H/M3/S0.0SHOP_AVERAGE_Q15.4.0.0YesPenalty cost for violating the minimum average discharge constraint of the discharge group.
discharge_groupmax_average_discharge_penalty_costdoubleInputNoNOK/H/M3/S0.0SHOP_AVERAGE_Q15.4.0.0YesPenalty cost for violating the maximum average discharge constraint of the discharge group.
discharge_grouphistorical_dischargetimeseriesInputNoM3/SNone/nullSHOP_OPEN16.9.0NoThe discharge group discharge for times before the optimization start. If not given, connected plant historical_discharge and river past_upstream_flow will be used.
discharge_groupuse_upstream_river_flowintInputNoNO_UNIT0SHOP_DISCHARGE_GROUP_FUNCTIONALITY17.17.0NoFlag deciding if up- (1) or down- (0) -stream river flow should be used in the constraints. Default behaviour is using downstream flow.
discharge_groupactual_discharge_m3stimeseriesOutputNoM3/SNone/nullSHOP_DISCHARGE_GROUP_FUNCTIONALITY13.0.0.aNoResulting discharge for the discharge group.
discharge_groupaccumulated_deviation_mm3timeseriesOutputNoMM3None/nullSHOP_DISCHARGE_GROUP_FUNCTIONALITY13.0.0.aNoResulting accumulated volume deviation for the discharge group.
discharge_groupupper_penalty_mm3timeseriesOutputNoMM3None/nullSHOP_DISCHARGE_GROUP_FUNCTIONALITY13.0.0.aNoResulting penalty when the maximum accumulated upward volume deviation for the discharge group is violated.
discharge_grouplower_penalty_mm3timeseriesOutputNoMM3None/nullSHOP_DISCHARGE_GROUP_FUNCTIONALITY13.0.0.aNoResulting penalty when the maximum accumulated downward volume deviation for the discharge group is violated.
discharge_groupupper_slack_mm3timeseriesOutputNoMM3None/nullSHOP_DISCHARGE_GROUP_FUNCTIONALITY13.0.0.aNoResulting slack when the maximum accumulated upward volume deviation for the discharge group is not reached.
discharge_grouplower_slack_mm3timeseriesOutputNoMM3None/nullSHOP_DISCHARGE_GROUP_FUNCTIONALITY13.0.0.aNoResulting slack when the maximum accumulated downward volume deviation for the discharge group is not reached.
discharge_groupmin_discharge_penaltytimeseriesOutputNoNOKNone/nullSHOP_DISCHARGE_GROUP_FUNCTIONALITY14.0.2.1NoResulting penalty when the minimum discharge constraint in the discharge group is violated.
discharge_groupmax_discharge_penaltytimeseriesOutputNoNOKNone/nullSHOP_DISCHARGE_GROUP_FUNCTIONALITY14.0.2.1NoResulting penalty when the maximum discharge constraint in the discharge group is violated.
discharge_groupramping_up_penaltytimeseriesOutputNoNOKNone/nullSHOP_DISCHARGE_GROUP_FUNCTIONALITY14.0.2.1NoResulting penalty when the upward discharge ramping constraint in the discharge group is violated.
discharge_groupramping_down_penaltytimeseriesOutputNoNOKNone/nullSHOP_DISCHARGE_GROUP_FUNCTIONALITY14.0.2.1NoResulting penalty when the downward discharge ramping constraint in the discharge group is violated.
production_groupenergy_targetdoubleInputNoMWH0.0SHOP_OPEN14.0.0.1NoSum energy production target for time steps with energy_target_period_flag set to 1.
production_groupenergy_penalty_cost_updoubleInputNoNOK/MWH0.0SHOP_OPEN14.0.0.1NoPenalty cost for producing more energy than the target amount.
production_groupenergy_penalty_cost_downdoubleInputNoNOK/MWH0.0SHOP_OPEN14.0.0.1NoPenalty cost for producing less energy than the target amount.
production_groupenergy_target_period_flagtimeseriesInputNoMWHNone/nullSHOP_OPEN14.0.0.1NoFlag defining which time steps are part of the target energy production constraint.
production_groupmax_p_limittimeseriesInputNoMWNone/nullSHOP_OPEN14.0.0.1YesThe maximal power production limit for the sum of plants in the group.
production_groupmax_p_limit_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN18.5.0NoFlag determining the time steps when the maximal power production limit for the production group should be included in the optimization model.
production_groupmin_p_limittimeseriesInputNoMWNone/nullSHOP_OPEN14.0.0.1YesThe minimal power production limit for the sum of plants in the group.
production_groupmin_p_limit_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN18.5.0NoFlag determining the time steps when the minimal power production limit for the production group should be included in the optimization model.
production_groupmax_p_penalty_costtimeseriesInputNoNOK/MWHNone/nullSHOP_OPEN14.0.0.1NoThe penalty cost for breaking the maximum power production limit constraint. The default penalty cost is specified by the power_limit_penalty_cost on the global_settings object.
production_groupmin_p_penalty_costtimeseriesInputNoNOK/MWHNone/nullSHOP_OPEN14.0.0.1NoThe penalty cost for breaking the minimum power production limit constraint. The default penalty cost is specified by the power_limit_penalty_cost on the global_settings object.
production_groupsum_productiontimeseriesOutputNoMWNone/nullSHOP_OPEN14.0.0.1NoThe sum power production of all the plants connected to the group.
production_groupmin_p_penaltytimeseriesOutputNoNOKNone/nullSHOP_OPEN14.0.0.1NoThe incurred penalty for breaking the minimum power production constraint.
production_groupmax_p_penaltytimeseriesOutputNoNOKNone/nullSHOP_OPEN14.0.0.1NoThe incurred penalty for breaking the maximum power production constraint.
production_groupenergy_penalty_uptimeseriesOutputNoNOKNone/nullSHOP_OPEN14.0.0.1NoThe total penalty incurred when breaking the target energy constraint by generating more energy than the target.
production_groupenergy_penalty_downtimeseriesOutputNoNOKNone/nullSHOP_OPEN14.0.0.1NoThe total penalty incurred when breaking the target energy constraint by generating less energy than the target.
volume_constraintmin_voltimeseriesInputNoMM3None/nullSHOP_OPEN13.0.0.aNoMinimum volume for the sum of all reservoirs connected to this constraint.
volume_constraintmax_voltimeseriesInputNoMM3None/nullSHOP_OPEN13.0.0.aNoMaximum volume for the sum of all reservoirs connected to this constraint.
volume_constraintmin_vol_penaltytimeseriesInputNoNOK/MM3None/nullSHOP_OPEN13.0.0.aNoGiven penalty cost for having a sum volume below the min_vol.
volume_constraintmax_vol_penaltytimeseriesInputNoNOK/MM3None/nullSHOP_OPEN13.0.0.aNoGiven penalty cost for having a sum volume above the max_vol.
scenarioscenario_idintInputNoNO_UNIT0SHOP_SCENARIO_FUNCTIONALITY13.0.0.aNoScenario ID. Should be numbered consecutively starting from 1.
scenarioprobabilitytimeseriesInputNoNO_UNITNone/nullSHOP_SCENARIO_FUNCTIONALITY13.0.0.aNoProbability between 0 and 1 for realization of this scenario. The sum of probabilities for all scenarios must be equal to 1. Only the probability for the last time step is used and it will be applied to all time steps to ensure consistency.
scenariocommon_scenariotimeseriesInputNoNO_UNITNone/nullSHOP_SCENARIO_FUNCTIONALITY13.0.0.aNoDefinition of non-anticipativity constraints for the full model. All decision variables must be the same for all scenarios and time steps where common_scenario is equal. All input time-series with stochastic data must accordingly have the same value for all scenarios and time steps where common_scenario is equal.
scenariocommon_historytimeseriesInputNoNO_UNITNone/nullSHOP_SCENARIO_FUNCTIONALITY13.0.0.aNoDefinition of which scenario that should be used as the source for a branch in the current scenario. Branching from a different scenario than itself allows modelling of continuous short-term uncertainty by re-using existing scenarios.
objectivesolver_statusstringOutputNoSTRINGNot setSHOP_OPEN13.0.0.aNoDescription of the latest status from the solver.
objectivetimes_of_wrong_pq_uploadingintOutputNoNO_UNIT0SHOP_OPEN14.0.0.9NoHow many times the unit PQ segments are wrongly uploaded, i.e. the latter segments are fulfilled first.
objectivegrand_totaldoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoObjective function equal to the sum of total and sum_penalties.
objectivesim_grand_totaldoubleOutputNoNOK0.0SHOP_OPEN13.2.0.aNoSimulated objective function equal to the sum of sim_total and sim_sum_penalties.
objectivetotaldoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoObjective function equal to the sum of rsv_end_value, vow_in_transit, market_sale_buy, load_value, reserve_sale_buy, reserve_oblig_value, contract_value, startup_costs, sum_feeding_fee, and sum_discharge_fee.
objectivesim_totaldoubleOutputNoNOK0.0SHOP_OPEN18.0.0NoSimulated objective function equal to the sum of sim_rsv_end_value, sim_market_sale_buy, sim_rsv_spill_vol_end_value, and sim_start_stop_costs.
objectivesum_penaltiesdoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoPenalty cost equal to the sum of minor_penalties and major_penalties.
objectivesim_sum_penaltiesdoubleOutputNoNOK0.0SHOP_OPEN18.0.0NoSimulated penalty cost equal to the sum of sim_minor_penalties and sim_major_penalties.
objectiveminor_penaltiesdoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoPenalty cost equal to the sum of rsv_tactical_penalty, rsv_peak_volume_penalty, rsv_flood_volume_penalty, river_flow_penalty, river_peak_flow_penalty, river_gate_adjustment_penalty, gate_q_constr_penalty, gate_peak_flow_penalty, gate_discharge_cost, bypass_cost, gate_spill_cost, gate_slack_cost, gate_ramping_cost, creek_spill_cost, junction_slack_cost, plant_p_constr_penalty, plant_q_constr_penalty, plant_schedule_penalty, gen_schedule_penalty, pump_schedule_penalty, reserve_violation_penalty, reserve_slack_cost, reserve_schedule_penalty, wind_curtailment_cost, solar_curtailment_cost, plant_reserve_discharge_penalty, plant_sum_reserve_penalty, reserve_activation_penalty, reserve_tactical_activation_penalty, and plant_reserve_strategy_penalty.
objectivesim_minor_penaltiesdoubleOutputNoNOK0.0SHOP_OPEN18.0.0NoSimulated penalty cost equal to sim_river_flow_penalty.
objectivemajor_penaltiesdoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoPenalty cost equal to the sum of rsv_penalty, rsv_end_penalty, rsv_hard_limit_penalty, rsv_over_limit_penalty, river_min_flow_penalty, river_max_flow_penalty, river_flow_schedule_penalty, load_penalty, group_time_period_penalty, group_time_step_penalty, discharge_group_penalty, production_group_energy_penalty, production_group_power_penalty, and sum_ramping_penalty.
objectivesim_major_penaltiesdoubleOutputNoNOK0.0SHOP_OPEN18.0.0NoSimulated penalty cost equal to the sum of sim_river_min_flow_penalty, sim_river_max_flow_penalty, sim_rsv_hard_min_limit_penalty, sim_rsv_hard_max_limit_penalty and sim_rsv_penalty.
objectivesum_ramping_penaltydoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoResulting total penalty when ramping constraints are violated. Note that this is sum is already included in the major_penalties attribute.
objectiversv_end_valuedoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoValue of water remaining in the reservoirs at the end of the optimization period. If cut description is used, the delayed water on its way to reservoirs is included, while for other end value description this water is valuated in vow_in_transit.
objectivesim_rsv_end_valuedoubleOutputNoNOK0.0SHOP_OPEN13.2.0.aNoSimulated value of water remaining in the reservoirs at the end of the simulation period.
objectiversv_end_value_relativedoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoChange in value of water in the reservoirs between the start and the end of the optimization period.
objectivesim_rsv_end_value_relativedoubleOutputNoNOK0.0SHOP_OPEN18.0.0NoSimulated change in value of water in the reservoirs between the start and the end of the simulation period.
objectivevow_in_transitdoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoValue of delayed water on its way to reservoirs at the end of the optimization period. If cut description is used the delayed water is valuated as part of the rsv_end_value instead.
objectiversv_spill_vol_end_valuedoubleOutputNoNOK0.0SHOP_OPEN14.0.2.0NoEnd reservoir value lost due to volume over HRL in flood situations. Only appliccapble when running with constant water values. The extra water is evaluated according to the water value of the reservoir downstream of the spill gate.
objectivesim_rsv_spill_vol_end_valuedoubleOutputNoNOK0.0SHOP_OPEN18.0.0NoSimulated end reservoir value lost due to volume over HRL in flood situations. Only appliccapble when running with constant water values. The extra water is evaluated according to the water value of the reservoir downstream of the spill gate.
objectivemarket_sale_buydoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoThe sum of the value of power bought from the market minus the value of power sold to the market for all time steps.
objectivesim_market_sale_buydoubleOutputNoNOK0.0SHOP_OPEN13.2.0.aNoThe sum of the simulated value of power bought from the market minus the value of power sold to the market for all time steps.
objectiveload_valuedoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoThe load obligation value by multiplying the load with the load price. If the load price is not given on any market connected to the load, the average of the smallest sale price and highest buy price over all connected market in each time step is used as the load price.
objectivereserve_sale_buydoubleOutputNoNOK0.0SHOP_RESERVE_GROUP13.0.0.aNoReserve trade value.
objectivereserve_oblig_valuedoubleOutputNoNOK0.0SHOP_RESERVE_GROUP13.0.0.aNoTHe reserve obligation value by multiplying the reserve obligation with the reserve obligation price. If the reserve obligation price is not given, the reserve sale price is used.
objectivecontract_valuedoubleOutputNoNOK0.0SHOP_CONTRACT13.0.0.aNoContract value.
objectivestart_stop_costsdoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoThe sum of the startup and shutdown costs for all units and time steps. By default this includes costs whenever the commitment status of the unit changes regardless of whether MIP is active or not.
objectivesim_start_stop_costsdoubleOutputNoNOK0.0SHOP_OPEN13.2.0.aNoThe sum of simulated startup and shutdown costs for all units and time steps. By default this includes costs whenever the commitment status of the unit changes regardless of whether MIP is active or not.
objectivesum_feeding_feedoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoThe sum of feed-in fee paid for all plants and time steps.
objectivesum_discharge_feedoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoThe sum of discharge fee paid for all plants and gates and time steps.
objectivethermal_costdoubleOutputNoNOK0.0SHOP_OPEN14.3.1.0NoThe sum of fuel cost for all thermal units and time steps.
objectiveproduction_costdoubleOutputNoNOK0.0SHOP_OPEN15.1.1.0NoThe sum of production cost for all units that has production_cost due to turbine partial damage.
objectivereserve_allocation_costdoubleOutputNoNOK0.0SHOP_OPEN14.3.4.0NoThe total cost for allocating reserves on all units in the system. The allocation cost can be specified on each unit for each reserve type, see for instance the ‘fcr_n_up_cost’ on the generator and pump objects.
objectiveincurred_droop_costdoubleOutputNoNOK0.0SHOP_OPEN15.5.4.2NoThe total incurred cost for the optimized droop settings on all units in the system delivering FCR reserves.
objectivetunnel_gate_adjustment_costdoubleOutputNoNOK0.0SHOP_OPEN16.8.0NoThe total incurred cost for adjusting the tunnel gate positions between time steps, applied to tunnels with optimized gates and specified gate_adjustment_cost timeseries.
objectivetunnel_gate_iteration_deviation_costdoubleOutputNoNOK0.0SHOP_OPEN16.8.0NoThe total incurred cost for deviating from the optimized gate positions found in the previous iteration. Applied to tunnels with optimized gates and specified gate_iteration_deviation_cost timeseries.
objectivereserve_ramping_costdoubleOutputNoNOK0.0SHOP_OPEN17.2.0NoThe total incurred cost for changing the reserve allocation between time steps for all units in the system.
objectiveriver_flow_start_stop_costdoubleOutputNoNOK0.0SHOP_OPEN17.14.0NoThe sum of river flow start and stop costs for all rivers and time steps.
objectiveriver_flow_change_costdoubleOutputNoNOK0.0SHOP_OPEN18.4.0NoThe sum of river flow change costs for all rivers and time steps.
objectiveneedle_comb_change_costdoubleOutputNoNOK0.0SHOP_OPEN18.2.0NoThe sum of generator needle combination change costs for all generators and time steps. Note that regular startup and shutdown costs are not double-counted here.
objectivenonphysical_spill_volumedoubleOutputNoMM30.0SHOP_OPEN14.0.0.9NoThe sum of 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 reservoir.
objectivephysical_spill_volumedoubleOutputNoMM30.0SHOP_OPEN14.0.0.9NoThe sum of spill volume for the part of the spill that represents physical spill, i.e. the spill occurs when the water exceeds max_vol of the reservoir.
objectiversv_tactical_penaltydoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoResulting total penalty cost when the tactical maximum or minimum volume limits for the reservoirs are violated.
objectiveplant_p_constr_penaltydoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoResulting total penalty cost when the time-dependent maximum or minimum production limits for the plants are violated.
objectiveplant_q_constr_penaltydoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoResulting total penalty cost when the time-dependent maximum or minimum discharge limits for the plants are violated.
objectiveplant_schedule_penaltydoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoResulting total penalty cost when the plant schedules are violated.
objectiveplant_rsv_q_limit_penaltydoubleOutputNoNOK0.0SHOP_OPEN14.3.5.1NoResulting total penalty cost when the head dependent maximum discharge limits for the plants are violated. These limits are set by the max_q_limit_rsv_up and max_q_limit_rsv_down attributes on the plant object.
objectivegen_schedule_penaltydoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoResulting total penalty cost when the generator schedules are violated.
objectivepump_schedule_penaltydoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoResulting total penalty cost when the pump schedules are violated.
objectivegate_q_constr_penaltydoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoResulting total penalty cost when the time-dependent maximum or minimum discharge limits for the gates are violated.
objectivegate_discharge_costdoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoThe sum of discharge costs for all gates and time steps.
objectivebypass_costdoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoThe sum of bypass discharge costs for all bypass gates and time steps.
objectivegate_spill_costdoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoThe sum of spill costs for all spill gates and time steps.
objectivephysical_spill_costdoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoThe sum of gate spill costs for the part of the spill that represents physical spill, i.e. the spill occurs when the water exceeds max_vol of the reservoir.
objectivenonphysical_spill_costdoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoThe sum of gate spill costs 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 reservoir.
objectivegate_slack_costdoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoThe sum of costs for the use of slack variables for all deltameter gates and time steps.
objectivegate_ramping_costdoubleOutputNoNOK0.0SHOP_OPEN15.1.1.0NoThe sum of cost for all gates ramping up or down and time steps.
objectivecreek_spill_costdoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoThe sum of spill costs for all creek spill gates and time steps.
objectivecreek_physical_spill_costdoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoThe sum of creek spill costs for the part of the spill that represents physical spill.
objectivecreek_nonphysical_spill_costdoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoThe sum of creek spill costs for the part of the spill that represents non-physical spill.
objectivejunction_slack_costdoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoThe sum of cost for the use of slack variables for all junctions and time steps.
objectivereserve_violation_penaltydoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoResulting total penalty cost when the reserve deliveries deviate below the reserve obligations.
objectivereserve_slack_costdoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoResulting total slack cost when the reserve deliveries deviate above the reserve obligations.
objectivereserve_schedule_penaltydoubleOutputNoNOK0.0SHOP_OPEN13.5.5.dNoResulting total penalty cost when the reserve schedules are violated.
objectiversv_peak_volume_penaltydoubleOutputNoNOK0.0SHOP_OPEN14.0.1.1NoResulting total penalty cost for peak reservoir volumes penalized by the peak_volume_cost_curve on each reservoir.
objectivegate_peak_flow_penaltydoubleOutputNoNOK0.0SHOP_OPEN14.0.1.1NoResulting total penalty cost for peak gate flows penalized by the peak_flow_cost_curve on each gate.
objectiversv_flood_volume_penaltydoubleOutputNoNOK0.0SHOP_OPEN14.2.2.0NoResulting total penalty cost for the reservoir volumes penalized by the flood_volume_cost_curve.
objectiveriver_peak_flow_penaltydoubleOutputNoNOK0.0SHOP_OPEN14.3.3.0NoResulting total penalty cost for peak river flows penalized by the peak_flow_cost_curve on each river.
objectiveriver_flow_penaltydoubleOutputNoNOK0.0SHOP_OPEN14.3.3.0NoResulting total penalty cost for river flows penalized by the flow_cost_curve on each river.
objectivesim_river_flow_penaltydoubleOutputNoNOK0.0SHOP_OPEN18.0.0NoSimulated resulting total penalty cost for river flows penalized by the flow_cost_curve on each river.
objectiveriver_gate_adjustment_penaltydoubleOutputNoNOK0.0SHOP_OPEN14.4.0.0NoResulting total penalty for adjusting the river gates according to the gate_adjustment_cost of each river.
objectiveplant_reserve_discharge_penaltydoubleOutputNoNOK0.0SHOP_OPEN15.3.0.0NoResulting total penalty for violating the max and min discharge constraints on plants due to potential reserve activation.
objectivesolar_curtailment_costdoubleOutputNoNOK0.0SHOP_OPEN15.3.0.0NoResulting total cost of curtailing solar power.
objectivewind_curtailment_costdoubleOutputNoNOK0.0SHOP_OPEN15.3.0.0NoResulting total cost of curtailing wind power.
objectiveplant_sum_reserve_penaltydoubleOutputNoNOK0.0SHOP_OPEN15.3.0.0NoResulting total penalty for violating the max upward and downward total reserve constraints on plants.
objectivereserve_activation_penaltydoubleOutputNoNOK0.0SHOP_OPEN15.3.0.0NoResulting total penalty for violating the reservoir volume constraints on reservoirs due to potential reserve activation.
objectivereserve_tactical_activation_penaltydoubleOutputNoNOK0.0SHOP_OPEN15.3.0.0NoResulting total penalty for violating the tactical reservoir volume constraints on reservoirs due to potential reserve activation.
objectiveplant_reserve_strategy_penaltydoubleOutputNoNOK0.0SHOP_OPEN16.2.0NoResulting total penalty for violating the plant min and max reserve constraints that are based on the plant_max/min_reserve_strategy input.
objectiveplant_consumption_penaltydoubleOutputNoNOK0.0SHOP_OPEN17.8.0NoResulting total penalty cost when the time-dependent maximum or minimum consumption limits for the plants are violated.
objectiveplant_upflow_penaltydoubleOutputNoNOK0.0SHOP_OPEN17.8.0NoResulting total penalty cost when the time-dependent maximum or minimum upflow limits for the plants are violated.
objectiversv_penaltydoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoResulting total penalty cost when the maximum or minimum volume limits for all reservoirs during the optimization period are violated.
objectivesim_rsv_penaltydoubleOutputNoNOK0.0SHOP_OPEN13.2.0.aNoSimulated total penalty cost when the maximum or minimum volume limits for all reservoirs during the optimization period are violated.
objectiversv_hard_limit_penaltydoubleOutputNoNOK0.0SHOP_OPEN14.0.2.0NoResulting total penalty cost for breaking the hard min/max constraints on the reservoir volume or level.
objectivesim_rsv_hard_limit_min_penaltydoubleOutputNoNOK0.0SHOP_OPEN18.0.0NoSimulated resulting total penalty cost for breaking the hard min constraints on the reservoir volume or level.
objectivesim_rsv_hard_limit_max_penaltydoubleOutputNoNOK0.0SHOP_OPEN18.0.0NoSimulated resulting total penalty cost for breaking the hard max constraints on the reservoir volume or level.
objectiversv_over_limit_penaltydoubleOutputNoNOK0.0SHOP_OPEN14.0.0.8NoResulting total penalty cost when the volume of reservoirs with an attached flood gate goes over the physical maximum volume limits.
objectiversv_end_penaltydoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoResulting total penalty cost when the maximum or minimum volume limits for all reservoirs at the end of the optimization period are violated.
objectiveload_penaltydoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoResulting total penalty cost when load obligations are violated.
objectivegroup_time_period_penaltydoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoResulting total penalty cost when period sum constraints on the old ascii multi-object format are violated. Sum over all constraints.
objectivegroup_time_step_penaltydoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoResulting total penalty cost when time-dependent constraints on the old ascii multi-object format are violated. Sum over all constraints and time steps.
objectiveplant_ramping_penaltydoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoResulting total penalty cost when plnat production ramping constraints are violated. Sum over all plants and time steps.
objectiversv_ramping_penaltydoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoResulting total penalty cost when reservoir storage ramping constraints are violated. Sum over all reservoirs and time steps.
objectivegate_ramping_penaltydoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoResulting total penalty cost when discharge ramping constraints on gates are violated. Sum over all gates and time steps.
objectivecontract_ramping_penaltydoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoResulting total penalty cost when contract ramping constraints are violated. Sum over all contracts and time steps.
objectivegroup_ramping_penaltydoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoResulting total penalty cost when time-dependent group ramping constraints on the old ascii format are violated. Sum over all constraints and time steps.
objectivedischarge_group_penaltydoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoResulting total penalty cost when the allowed deviations for discharge groups are violated. Sum for both upward and downward violation over all discharge groups and time steps.
objectivedischarge_group_ramping_penaltydoubleOutputNoNOK0.0SHOP_OPEN14.0.2.1NoResulting total penalty cost when the discharge ramping constraints for discharge groups are violated. Sum for both upward and downward violation over all discharge groups and time steps.
objectivedischarge_group_average_discharge_penaltydoubleOutputNoNOK0.0SHOP_OPEN15.4.0.0NoResulting total penalty cost when the average discharge constraints for discharge groups are violated. Sum for both upward and downward violation over all discharge groups and time steps.
objectiveproduction_group_energy_penaltydoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoResulting total penalty cost when the energy target production constraints on production groups are violated. Sum for both upward and downward violation over all production groups.
objectiveproduction_group_power_penaltydoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoResulting total penalty cost when the maximum or minimum power limit constraints on production groups are violated. Sum for both upward and downward violation over all production groups and time steps.
objectiveriver_min_flow_penaltydoubleOutputNoNOK0.0SHOP_OPEN14.3.1.0NoResulting total penalty for breaking the min_flow river constraints.
objectivesim_river_min_flow_penaltydoubleOutputNoNOK0.0SHOP_OPEN18.0.0NoSimulated resulting total penalty for breaking the min_flow river constraints.
objectiveriver_max_flow_penaltydoubleOutputNoNOK0.0SHOP_OPEN14.3.1.0NoResulting total penalty for breaking the max_flow river constraints.
objectivesim_river_max_flow_penaltydoubleOutputNoNOK0.0SHOP_OPEN18.0.0NoSimulated resulting total penalty for breaking the max_flow river constraints.
objectiveriver_ramping_penaltydoubleOutputNoNOK0.0SHOP_OPEN14.3.3.0NoResulting total penalty cost when the discharge ramping constraints for rivers are violated. Sum for both upward and downward violation over all rivers and time steps.
objectiveriver_gate_ramping_penaltydoubleOutputNoNOK0.0SHOP_OPEN15.1.1.0NoResulting total penalty cost when the gate ramping constraints for rivers are violated. Sum for both upward and downward violation over all rivers and time steps.
objectiveriver_flow_schedule_penaltydoubleOutputNoNOK0.0SHOP_OPEN14.4.0.0NoResulting total penalty for breaking the flow_schedule river constraints.
objectivelevel_rolling_ramping_penaltydoubleOutputNoNOK0.0SHOP_OPEN15.2.0.0NoResulting total penalty cost when the level rolling ramping constraints for reservoirs are violated. Sum for both upward and downward violation over all reservoirs and time steps.
objectivelevel_period_ramping_penaltydoubleOutputNoNOK0.0SHOP_OPEN15.2.0.0NoResulting total penalty cost when the level period ramping constraints for reservoirs are violated. Sum for both upward and downward violation over all reservoirs and time steps.
objectivedischarge_rolling_ramping_penaltydoubleOutputNoNOK0.0SHOP_OPEN15.2.0.0NoResulting total penalty cost when the discharge rolling ramping constraints for plants are violated. Sum for both upward and downward violation over all plants and time steps.
objectivedischarge_period_ramping_penaltydoubleOutputNoNOK0.0SHOP_OPEN15.2.0.0NoResulting total penalty cost when the discharge period ramping constraints for plants are violated. Sum for both upward and downward violation over all plants and time steps.
objectiversv_nonseq_ramping_penaltydoubleOutputNoNOK0.0SHOP_NONSEQ_AMPLITUDE_RSV_RAMP15.3.5.0NoResulting total penalty cost when the non-sequential reservoir ramping constraints are violated. Sum for both upward and downward violation over all reservoirs and time steps.
objectiversv_amplitude_ramping_penaltydoubleOutputNoNOK0.0SHOP_NONSEQ_AMPLITUDE_RSV_RAMP15.3.5.0NoResulting total penalty cost when the amplitude reservoir ramping constraints are violated. Sum for both upward and downward violation over all reservoirs and time steps.
objectiversv_dynamic_level_limit_penaltydoubleOutputNoNOK0.0SHOP_OPEN17.1.0NoResulting total penalty cost when the reservoir dynamic level limit constraints for are violated. Sum for both upward and downward violation over all reservoirs and time steps.
objectivecommon_decision_penaltydoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoPenalty cost for violating common decision period constraints in decomposed multi-scenario optimization problems.
objectivebidding_penaltydoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoPenalty cost for violating constraints for increasing bid volume when price increases in decomposed multi-scenario optimization problems.
objectivesafe_mode_universal_penaltydoubleOutputNoNOK0.0SHOP_OPEN13.0.0.aNoPenalty cost for all violated constraints when universal penalty is switched on to investigate infeasibility.
bid_groupprice_dimensionintOutputNoNO_UNIT0SHOP_SCENARIO_FUNCTIONALITY13.0.0.aNoNumber of prices in the resulting bid matrix.
bid_grouptime_dimensionintOutputNoNO_UNIT0SHOP_SCENARIO_FUNCTIONALITY13.0.0.aNoNumber of time steps in the resulting bid matrix.
bid_groupbid_start_intervalintOutputNoNO_UNIT-1SHOP_SCENARIO_FUNCTIONALITY13.0.0.aNoIndex of the first time step in the bid matrix.
bid_groupbid_end_intervalintOutputNoNO_UNIT0SHOP_SCENARIO_FUNCTIONALITY13.0.0.aNoIndex of the last time step in the bid matrix.
bid_groupreduction_costdoubleOutputNoNO_UNIT0.0SHOP_SCENARIO_FUNCTIONALITY13.0.0.aNoThe cost of reducing the full bid matrix to the desired number of points.
bid_groupbid_curvesxytOutputNox: NOK/MWH and y: MWHNone/nullSHOP_SCENARIO_FUNCTIONALITY13.0.0.aNoResulting bid matrix.
bid_groupbid_penaltytimeseriesOutputNoMWHNone/nullSHOP_SCENARIO_FUNCTIONALITY13.0.0.aNoThe sum of penalty over all scenarios and time steps for violating the requirement of bid volume increasing when price increases in the bid matrix.
bid_groupbest_profit_bid_matrixxytOutputNox: NOK/MWH and y: MWHNone/nullSHOP_SCENARIO_FUNCTIONALITY15.3.2.0NoResulting bid matrix when bids are created from the command print bp_bid_matrix.
cut_grouprhsxy_arrayInputYesx: NO_UNIT and y: NOKNone/nullSHOP_OPEN13.0.0.aNoThe right hand side constant for each cut in the cut_group. Represent the future expected income of the system and is usually a positive number. In the case of price dependent cuts, the price level should be the reference value for each XY in the xy_array.
cut_groupend_valuetimeseriesOutputNoNOKNone/nullSHOP_OPEN14.0.0.1NoFuture expected income of the system that is part of the cut_group.
cut_groupbinding_cut_uptimeseriesOutputNoNO_UNITNone/nullSHOP_OPEN14.0.0.1NoThe zero-indexed binding cut constraint in the closest price level above the average price in SHOP is saved as the final value in the timeseries. The value is set to -1 if no cuts have a price above the average price in SHOP. In case of price independent cuts, the value is the binding cut in the cut group.
cut_groupbinding_cut_downtimeseriesOutputNoNO_UNITNone/nullSHOP_OPEN14.0.0.1NoThe zero-indexed binding cut constraint in the closest price level below the average price in SHOP is saved as the final value in the timeseries. In case of price independent cuts or if there are no cuts with a price below the average price in SHOP, the value is set to -1.
inflow_seriescut_coeffsxy_arrayInputYesx: MM3 and y: NOK/MM3None/nullSHOP_EXTENDED_CUT_FUNCTIONALITY14.0.0.3NoThe cut coefficients of the inflow series used in prodrisk. The x values specify the reference weekly inflow of the cut, the y values are the actual cut coefficients, and the reference value is the price for when the cut was created.
inflow_seriesconnected_inflowtimeseriesOutputNoM3/SNone/nullSHOP_EXTENDED_CUT_FUNCTIONALITY17.9.0NoThe total inflow of all reservoirs connected to the inflow series.
systemcut_output_rhsxy_arrayOutputNox: NOK and y: NOKNone/nullSHOP_SCENARIO_FUNCTIONALITY13.0.0.aNoExpected 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.
systemsum_completed_iterationsintOutputNoNO_UNIT0SHOP_OPEN17.13.0NoThe total number of full and incremental iterations that have been completed.
systemsolver_computation_timedouble_arrayOutputNoSECONDNone/nullSHOP_OPEN17.15.0NoComputation time used in the external solver (CPLEX/Gurobi/OSI) for completed iterations.
systemsolver_interface_input_pathstringInputNoSTRINGEmptySHOP_OPEN17.16.0NoManually specify where SHOP will look for the solver interface binary, see the documentation under ‘Environment variables’ to see where SHOP will search by default.
systemmodel_building_timedouble_arrayOutputNoSECONDNone/nullSHOP_OPEN17.17.0NoComputation time used for model building for each iteration.
systemresult_processing_timedouble_arrayOutputNoSECONDNone/nullSHOP_OPEN17.17.0NoComputation time used for result processing for each iteration.
systemtotal_iteration_timedouble_arrayOutputNoSECONDNone/nullSHOP_OPEN17.17.0NoTotal computation time for each iteration.
systemtime_per_commandsyOutputNos: STRING and y: SECONDNone/nullSHOP_OPEN17.17.0NoTotal computation time per command. The string value is the raw command string, and the y value is the computation time in seconds.
systemphysical_spilldoubleOutputNoMM30.0SHOP_OPEN18.3.0NoThe 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.
systemnonphysical_spilldoubleOutputNoMM30.0SHOP_OPEN18.3.0NoThe 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.
unit_combinationn_unitsintOutputNoNO_UNIT0SHOP_BEST_PROFIT17.3.0NoThe number of generators that are part of this unit combination.
unit_combinationunit_is_in_combint_arrayOutputNoNO_UNITNone/nullSHOP_BEST_PROFIT17.9.0NoSpecifies which generators are part of the unit_combination. The vector has the same length as the number of generators in the plant, and a value of 1 means that the unit is included in the combination.
unit_combinationunit_names_in_combstring_arrayOutputNoSTRINGNone/nullSHOP_BEST_PROFIT18.3.0NoLists the names of the generators that are part of the unit_combination.
unit_combinationdischargexytOutputNox: MW and y: M3/SNone/nullSHOP_BEST_PROFIT13.0.0.aNoDischarge for a combination of generators corresponding to a certain production level of the unit combination. The result is generated by the best_profit module.
unit_combinationmarginal_costxytOutputNox: MW and y: NOK/MWNone/nullSHOP_BEST_PROFIT13.0.0.aNoMarginal production cost for a combination of generators corresponding to a certain production level of the unit combination. The result is generated by the best_profit module.
unit_combinationaverage_costxytOutputNox: MW and y: NOK/MWNone/nullSHOP_BEST_PROFIT13.0.0.aNoAverage production cost for a combination of generators corresponding to a certain production level of the unit combination. The result is generated by the best_profit module.
tunnelstart_heightdoubleInputYesMETER0.0SHOP_OPEN13.5.1.aNoThe lowest part of the opening of the tunnel at the point defined as the starting point of the tunnel.
tunnelend_heightdoubleInputYesMETER0.0SHOP_OPEN13.5.1.aNoThe lowest part of the opening of the tunnel at the point defined as the ending point of the tunnel.
tunneldiameterdoubleInputNoMETER0.0SHOP_OPEN13.5.1.aNoThe diameter of the tunnel. This is reserved for use in the simulation.
tunnellengthdoubleInputNoMETER0.0SHOP_OPEN13.5.1.aNoThe length of the tunnel. This is reserved for use in the simulation.
tunnelloss_factordoubleInputYesS2/M50.0SHOP_OPEN13.5.1.aNoFriction loss factor for the tunnel. The head loss in the tunnel is found by multiplying the loss_factor with the square of the flow. The loss_factor is also divided with the gate_opening_curve y-value if the gate is not fully open.
tunnelweir_widthdoubleInputNoMETER0.0SHOP_OPEN14.1.0.5NoWidth of weir at tunnel entrance. Tunnel flow is limited by the amount of water that may flow over the weir, depending on the level of the reservoir above.
tunneltime_delayintInputNoNO_UNIT0SHOP_OPEN13.5.1.aNoThe delay between the water leaving the tunnel and until it ends up in the downstream reservoir. This can only be used on tunnels with end_height above the HRL of the downstream reservoir.
tunnelgate_opening_curvexyInputNox: NO_UNIT and y: NO_UNITNone/nullSHOP_TUNNEL13.5.1.aNoRelationship between gate positions and related scaling of the pressure loss in the gate. The X-values represent an arbitrary position given by increasing numbers. The Y-values represent the corresponding opening factor for each position. The tunnel loss_factor is divided with the y-value if the gate is not fully open. An y-value of 0 represents a fully closed gate and will not be used for any division.
tunnelgate_loss_factor_curvexyInputNox: NO_UNIT and y: S2/M5None/nullSHOP_TUNNEL16.9.0NoThe effective head loss coefficient of the gate in the tunnel for different gate positions. The x-values in this curve are mapped to gate openings through the x-values on the gate_opening_curve. The total loss factor will be the sum of the regular loss_factor on the tunnel and the gate loss factor interpolated for the relevant gate opening. If this curve is not defined, the total loss factor of the tunnel and gate will be the loss_factor divided by the fractional gate opening.
tunnelgate_adjustment_costtimeseriesInputNoNOKNone/nullSHOP_TUNNEL13.5.1.aNoA cost for changing the gate position between each time step. The given cost is multiplied with the change in gate opening between each time step and the product is added to the objective function.
tunnelgate_iteration_deviation_costtimeseriesInputNoNOKNone/nullSHOP_TUNNEL16.8.0NoAdds a cost for changing the gate position from the gate opening optimized in the previous iteration. The cost is not based on any real world costs of the gate, but is a way of avoiding flipping between different gate opening solutions from iteration to iteration.
tunnelgate_opening_scheduletimeseriesInputNoNO_UNITNone/nullSHOP_TUNNEL13.5.1.aYesSchedule for gate opening corresponding to the x-values of the gate_opening_curve.
tunnelinitial_openingdoubleInputNoNO_UNIT-1SHOP_TUNNEL13.5.1.aNoInitial position of the gate used as basis for calculating adjustment costs in the first time step.
tunnelcontinuous_gateintInputNoNO_UNIT0SHOP_TUNNEL13.5.1.aNoFlag determining whether the gate can be set to any position between listed positions in the gate_opening_curve. A value of 0 means that it can only be set at the given positions while a value of 1 means that it can be set to any position between the first and last listed position.
tunnelend_pressuretimeseriesOutputNoMETERNone/nullSHOP_OPEN13.5.1.aNoResulting pressure from the optimization at the end of the tunnel.
tunnelstart_pressuretimeseriesOutputNoMETERNone/nullSHOP_OPEN17.9.0NoResulting pressure from the optimization at the start of the tunnel.
tunnelsim_end_pressuretimeseriesOutputNoMETERNone/nullSHOP_OPEN13.5.1.aNoResulting pressure from the simulated flow at the end of the tunnel.
tunnelflowtimeseriesOutputNoM3/SNone/nullSHOP_OPEN13.5.1.aNoResulting flow in the tunnel from the optimization.
tunnelphysical_flowtimeseriesOutputNoM3/SNone/nullSHOP_OPEN14.4.1.0NoPost-calculated physical flow in the tunnel after all optimization decisions are fixed.
tunnelsim_flowtimeseriesOutputNoM3/SNone/nullSHOP_OPEN13.5.1.aNoSimulated flow in the tunnel.
tunnelgate_openingtimeseriesOutputNoNO_UNITNone/nullSHOP_TUNNEL13.5.1.aNoResulting position of the tunnel gate after optimization.
tunnelnetwork_nointOutputNoNO_UNIT0SHOP_OPEN13.5.1.aNoNetwork identification number set by the model to indicate which tunnel network this tunnel is part of.
tunnelmin_flowtimeseriesInputNoM3/SNone/nullSHOP_OPEN13.5.1.aYesMinimum allowed flow in this tunnel.
tunnelmax_flowtimeseriesInputNoM3/SNone/nullSHOP_OPEN13.5.1.aYesMaximum allowed flow in this tunnel.
tunnelmin_flow_penalty_costtimeseriesInputNoNOK/H/M3/SNone/nullSHOP_OPEN13.5.4.aNoGiven penalty cost for violating minimum flow in this tunnel.
tunnelmax_flow_penalty_costtimeseriesInputNoNOK/H/M3/SNone/nullSHOP_OPEN13.5.4.aNoGiven penalty cost for violating maximum flow in this tunnel.
tunnelmin_start_pressuretimeseriesInputNoMETERNone/nullSHOP_TUNNEL14.2.3.0YesMinimum allowed pressure at the start of this tunnel.
interlock_constraintmin_opentimeseriesInputNoNO_UNITNone/nullSHOP_TUNNEL13.5.1.aNoMinimum limit for how many objects connected to this constraint that can be open simultaneously.
interlock_constraintmax_opentimeseriesInputNoNO_UNITNone/nullSHOP_TUNNEL13.5.1.aNoMaximum limit for how many objects connected to this constraint that can be open simultaneously.
interlock_constraintforward_switch_timedoubleInputNoNO_UNIT0.0SHOP_TUNNEL13.5.4.dNoMinimum number of hours that plant below must be stopped after closing tunnels connected to this constraint.
interlock_constraintbackward_switch_timedoubleInputNoNO_UNIT0.0SHOP_TUNNEL13.5.4.dNoMinimum number of hours that plant below must be stopped after closing tunnels connected from this constraint.
lp_modelsim_modeintInputNoNO_UNIT0SHOP_OPEN14.1.0.0NoLP-model data.
lp_modelvar_type_namesstring_arrayOutputNoSTRINGNone/nullSHOP_OPEN14.1.0.0NoLP-model data.
lp_modelvar_type_abbrevstring_arrayOutputNoSTRINGNone/nullSHOP_OPEN14.1.0.0NoLP-model data.
lp_modelvar_type_index_type_begint_arrayOutputNoNO_UNITNone/nullSHOP_OPEN14.1.0.0NoLP-model data.
lp_modelvar_type_index_type_cntint_arrayOutputNoNO_UNITNone/nullSHOP_OPEN14.1.0.0NoLP-model data.
lp_modelvar_type_index_type_valint_arrayOutputNoNO_UNITNone/nullSHOP_OPEN14.1.0.0NoLP-model data.
lp_modelrow_type_namesstring_arrayOutputNoSTRINGNone/nullSHOP_OPEN14.1.0.0NoLP-model data.
lp_modelrow_type_index_type_begint_arrayOutputNoNO_UNITNone/nullSHOP_OPEN14.1.0.0NoLP-model data.
lp_modelrow_type_index_type_cntint_arrayOutputNoNO_UNITNone/nullSHOP_OPEN14.1.0.0NoLP-model data.
lp_modelrow_type_index_type_valint_arrayOutputNoNO_UNITNone/nullSHOP_OPEN14.1.0.0NoLP-model data.
lp_modelindex_type_namesstring_arrayOutputNoSTRINGNone/nullSHOP_OPEN14.1.0.0NoLP-model data.
lp_modelindex_type_desc_begint_arrayOutputNoNO_UNITNone/nullSHOP_OPEN14.1.0.0NoLP-model data.
lp_modelindex_type_desc_cntint_arrayOutputNoNO_UNITNone/nullSHOP_OPEN14.1.0.0NoLP-model data.
lp_modelindex_type_desc_indexint_arrayOutputNoNO_UNITNone/nullSHOP_OPEN15.2.0.0NoLP-model data.
lp_modelindex_type_desc_valstring_arrayOutputNoSTRINGNone/nullSHOP_OPEN14.1.0.0NoLP-model data.
lp_modelAAdouble_arrayOutputNoNO_UNITNone/nullSHOP_OPEN14.1.0.0NoLP-model data.
lp_modelIrowint_arrayOutputNoNO_UNITNone/nullSHOP_OPEN14.1.0.0NoLP-model data.
lp_modelJcolint_arrayOutputNoNO_UNITNone/nullSHOP_OPEN14.1.0.0NoLP-model data.
lp_modelrhsdouble_arrayOutputNoNO_UNITNone/nullSHOP_OPEN14.1.0.0NoLP-model data.
lp_modelsenseint_arrayOutputNoNO_UNITNone/nullSHOP_OPEN14.1.0.0NoLP-model data.
lp_modelubdouble_arrayOutputNoNO_UNITNone/nullSHOP_OPEN14.1.0.0NoLP-model data.
lp_modellbdouble_arrayOutputNoNO_UNITNone/nullSHOP_OPEN14.1.0.0NoLP-model data.
lp_modelccdouble_arrayOutputNoNO_UNITNone/nullSHOP_OPEN14.1.0.0NoLP-model data.
lp_modelbinint_arrayOutputNoNO_UNITNone/nullSHOP_OPEN14.1.0.0NoLP-model data.
lp_modelxdouble_arrayOutputNoNO_UNITNone/nullSHOP_OPEN14.1.0.0NoLP-model data.
lp_modeldualdouble_arrayOutputNoNO_UNITNone/nullSHOP_OPEN14.1.0.0NoLP-model data.
lp_modelvar_typeint_arrayOutputNoNO_UNITNone/nullSHOP_OPEN14.1.0.0NoLP-model data.
lp_modelvar_index_begint_arrayOutputNoNO_UNITNone/nullSHOP_OPEN14.1.0.0NoLP-model data.
lp_modelvar_index_cntint_arrayOutputNoNO_UNITNone/nullSHOP_OPEN14.1.0.0NoLP-model data.
lp_modelvar_index_valint_arrayOutputNoNO_UNITNone/nullSHOP_OPEN14.1.0.0NoLP-model data.
lp_modelrow_typeint_arrayOutputNoNO_UNITNone/nullSHOP_OPEN14.1.0.0NoLP-model data.
lp_modelrow_index_begint_arrayOutputNoNO_UNITNone/nullSHOP_OPEN14.1.0.0NoLP-model data.
lp_modelrow_index_cntint_arrayOutputNoNO_UNITNone/nullSHOP_OPEN14.1.0.0NoLP-model data.
lp_modelrow_index_valint_arrayOutputNoNO_UNITNone/nullSHOP_OPEN14.1.0.0NoLP-model data.
lp_modeladd_row_typeintInputNoNO_UNIT0SHOP_LP_MODEL14.1.0.0NoLP-model data.
lp_modeladd_row_indexint_arrayInputNoNO_UNITNone/nullSHOP_LP_MODEL14.1.0.0NoLP-model data.
lp_modeladd_row_variablesint_arrayInputNoNO_UNITNone/nullSHOP_LP_MODEL14.1.0.0NoLP-model data.
lp_modeladd_row_coeffdouble_arrayInputNoNO_UNITNone/nullSHOP_LP_MODEL14.1.0.0NoLP-model data.
lp_modeladd_row_rhsdoubleInputNoNO_UNIT0.0SHOP_LP_MODEL14.1.0.0NoLP-model data.
lp_modeladd_row_senseintInputNoNO_UNIT0SHOP_LP_MODEL14.1.0.0NoLP-model data.
lp_modeladd_row_lastintOutputNoNO_UNIT0SHOP_LP_MODEL14.1.0.0NoLP-model data.
lp_modeladd_var_typeintInputNoNO_UNIT0SHOP_LP_MODEL14.1.0.0NoLP-model data.
lp_modeladd_var_indexint_arrayInputNoNO_UNITNone/nullSHOP_LP_MODEL14.1.0.0NoLP-model data.
lp_modeladd_var_ubdoubleInputNoNO_UNIT0.0SHOP_LP_MODEL14.1.0.0NoLP-model data.
lp_modeladd_var_lbdoubleInputNoNO_UNIT0.0SHOP_LP_MODEL14.1.0.0NoLP-model data.
lp_modeladd_var_ccdoubleInputNoNO_UNIT0.0SHOP_LP_MODEL14.1.0.0NoLP-model data.
lp_modeladd_var_binintInputNoNO_UNIT0SHOP_LP_MODEL14.1.0.0NoLP-model data.
lp_modeladd_var_lastintOutputNoNO_UNIT0SHOP_LP_MODEL14.1.0.0NoLP-model data.
riverlengthdoubleInputNoMETER0.0SHOP_OPEN14.3.1.0NoLength of the river segment.
riverupstream_elevationdoubleInputYesMETER0.0SHOP_OPEN14.3.1.0NoThe elevation of the river floor upstream.
riverdownstream_elevationdoubleInputNoMETER0.0SHOP_OPEN14.3.1.0NoThe elevation of the river floor downstream.
rivertime_delay_constdoubleInputNoHOUR0.0SHOP_OPEN14.3.1.0NoThe time delay of the water flowing down the river.
riverdelayed_water_energy_valuedoubleInputNoNOK/MWH0.0SHOP_RIVER14.3.1.0NoSpecifies a constant local energy value used to evaluate the water in transit at the end of the optimization horizon. The value is converted to EUR/Mm3 and then added to the global water value of the downstream reservoir.
riverdelayed_water_valuedoubleInputNoNOK/MM3-1.0SHOP_OPEN15.6.0.0NoSpecifies a constant global water value used to evaluate the water in transit at the end of the optimization horizon. The water value of the downstream reservoir will be used if this attribute is not specified.
riverinitial_gate_openingdoubleInputNoNO_UNIT-1.0SHOP_RIVER14.4.0.0NoSpecifies the initial opening position of the gate in the river before optimization, which is used when applying gate_adjustment_cost and gate_ramping constraints for the first time step. These constraints will not be applied for t=0 if the initial gate opening is not specified (-1).
riverlinear_ref_flowdoubleInputNoM3/S0.0SHOP_RIVER15.0.0.2NoSpecifies the flow rate where the level-flow rate should be linearized from. Can be used in combination with submerged weir where the flow is based on watted area. Will only be used if activated by corresponding flag.
riverimplicit_factordoubleInputNoNO_UNIT0.5SHOP_RIVER15.3.0.0NoWeighting between reservoir level in the beginning and end of time step for numerical integration. 0 - explicit Euler, 0.5 trapezoidal method, 1 - implicity Euler. Increase value for improved numerical stability, while 0.5 will typically give highest precision.
rivermain_riverintInputNoNO_UNIT0SHOP_OPEN14.4.0.0NoSpecifies that this river should be considered the main waterway downstream a reservoir, and is only needed if a reservoir has no directly connected downstream power plant and has multiple output rivers. The first connected river is assumed to be the main river if this value has not been set on any of the output rivers.
riversubmerged_weirintInputNoNO_UNIT0SHOP_RIVER15.0.0.0NoSpecifies if the weir should allow two way flow and reduce flow rate when downstream level is above weir height.
riverlinear_submerged_weir_flowintInputNoNO_UNIT0SHOP_RIVER15.0.0.2NoActivated weir flow linearized through the point given by linear_ref_flow and zero. Typically used for two-way flow functions with small reservoirs where convergence can be challenging.
riverwidth_depth_curvexyInputNox: METER and y: METERNone/nullSHOP_RIVER14.3.1.0NoThe curve describing the shape of the river cross section.
riverflow_cost_curvexyInputNox: M3/S and y: NOK/H/M3/SNone/nullSHOP_FLOOD_SUPPORT14.3.3.0NoDescribes a piece-wise constant cost curve for the flow in each time step for the river. This convex curve is preferred over the standard flow_cost timeseries attribute if both are defined for the river object.
riverpeak_flow_cost_curvexyInputNox: M3/S and y: NOK/M3/SNone/nullSHOP_FLOOD_SUPPORT14.3.3.0NoDescribes the piece-wise constant cost curve for the highest achieved flow rate in the river over the optimization horizon.
rivertime_delay_curvexy_arrayInputNox: HOUR and y: NO_UNITNone/nullSHOP_OPEN14.4.1.4NoFunction for modelling wave-shaped time delay. The X-values represent the time since discharge into the top of the river, and the Y-values represents the fraction of the upstream water arriving at the bottom of the river at that time. Separate curves can be given in for different reference flows, in this case the time delay will be interpolated between the curves based on the flow in the past SHOP iteration.
riverpast_upstream_flowtimeseriesInputNoM3/SNone/nullSHOP_RIVER14.4.0.0NoRepresents the upstream flow in the river before the start of the optimization period, which is considered for rivers with time delay. Any values given for times inside the optimization horizon are ignored. The datatype of this attribute changed from xy to timeseries in version 15.3.1.0.
riverup_level_flow_curvexy_arrayInputNox: METER and y: M3/SNone/nullSHOP_OPEN14.3.3.0NoFunction determining the relationship between water level in the reservoir directly above the river and the flow in the river. The XY flow functions can be given in for multiple gate settings where the gate opening position is the reference value of the XY table.
rivergate_opening_curvexyInputNox: NO_UNIT and y: METERNone/nullSHOP_RIVER14.3.3.0NoFunction determining the relationship between the user-defined position of the gate (X-value) and the corresponding height in meters above the river bottom (Y-value).
riverdelta_level_ref_up_flow_curvexy_arrayInputNox: METER and y: M3/SNone/nullSHOP_OPEN14.3.3.0NoSet of functions defining the relationship between the water level difference between the reservoirs directly above and below the river (X-value) and the river flow (Y-value). Each function is referenced to a water level in the upper reservoir. The flow is extrapolated outside the defined X-value range, and interpolated between functions when the actual upper reservoir level lies between their reference levels.
riverdelta_level_ref_down_flow_curvexy_arrayInputNox: METER and y: M3/SNone/nullSHOP_RIVER14.3.3.0NoSet of functions defining the relationship between the water level difference between the reservoirs directly above and below the river (X-value) and the river flow (Y-value). Each function is referenced to a water level in the lower reservoir. The flow is extrapolated outside the defined X-value range, and interpolated between functions when the actual lower reservoir level lies between their reference levels.
riverinflowtimeseriesInputNoM3/SNone/nullSHOP_RIVER14.3.1.0NoThe upstream natural inflow to the river.
rivermin_flowtimeseriesInputNoM3/SNone/nullSHOP_OPEN14.3.1.0YesDefines a minimum flow constraint for the river. This is a soft constraint whose penalty cost is specified by either min_flow_penalty_cost or river_flow_penalty_cost (on global_settings).
rivermax_flowtimeseriesInputNoM3/SNone/nullSHOP_OPEN14.3.1.0YesDefines a maximum flow constraint for the river. This is a soft constraint whose penalty cost is specified by either max_flow_penalty_cost or river_flow_penalty_cost (on global_settings).
rivermin_flow_penalty_costtimeseriesInputNoNOK/H/M3/SNone/nullSHOP_OPEN14.3.1.0NoThe penalty cost for breaking the min_flow constraint. Overrides the default river_flow_penalty_cost defined on global_settings.
rivermax_flow_penalty_costtimeseriesInputNoNOK/H/M3/SNone/nullSHOP_OPEN14.3.1.0NoThe penalty cost for breaking the max_flow constraint. Overrides the default river_flow_penalty_cost defined on global_settings.
rivermax_flow_constdoubleInputNoM3/SSHOP_OPEN17.5.0YesDefines a constant maximum flow constraint for the river. This is a soft constraint whose penalty cost is specified by either max_flow_penalty_cost or river_flow_penalty_cost (on global_settings). The default value (NaN) means that max_flow_const is inactive. The timeseries attribute max_flow will be preferred if both are set.
riverramping_uptimeseriesInputNoM3SEC_HOURNone/nullSHOP_OPEN14.3.3.0YesDefines a maximum upward flow ramping constraint for the river.
riverramping_downtimeseriesInputNoM3SEC_HOURNone/nullSHOP_OPEN14.3.3.0YesDefines a maximum downward flow ramping constraint for the river.
riverramping_up_penalty_costtimeseriesInputNoNOK/M3/SNone/nullSHOP_OPEN14.3.3.0NoThe penalty cost for breaking the ramping_up constraint. Overrides the default gate_ramp_penalty_cost defined on global_settings.
riverramping_down_penalty_costtimeseriesInputNoNOK/M3/SNone/nullSHOP_OPEN14.3.3.0NoThe penalty cost for breaking the ramping_down constraint. Overrides the default gate_ramp_penalty_cost defined on global_settings.
rivercost_curve_scalingtimeseriesInputNoNO_UNITNone/nullSHOP_FLOOD_SUPPORT14.3.3.0NoThe values in this time series will be multiplied with the flow_cost_curve values. This makes it possible to vary the convex flow_cost_curve over the optimization horizon.
riverflow_scheduletimeseriesInputNoM3/SNone/nullSHOP_OPEN14.3.3.0YesSchedule for flow through the river. If the river has time delay, it is referenced to the start of the river.
riverflow_schedule_penalty_costtimeseriesInputNoNOK/H/M3/SNone/nullSHOP_OPEN14.4.0.0NoPenalty cost for breaking the flow_schedule for the river. The default penalty cost for all rivers can be set with the river_flow_schedule_penalty_cost attribute on global_settings.
rivergate_opening_scheduletimeseriesInputNoNO_UNITNone/nullSHOP_OPEN14.3.3.0YesSchedule for opening of the gate in the river. The value given here is interpreted as the X-value of the gate_opening_curve.
riverflow_block_merge_tolerancetimeseriesInputNoM3/SNone/nullSHOP_OPEN14.3.3.0YesMaximum difference in flow between two timesteps that results in a merged result for these timesteps in the next iteration. This requires merging to be activated in the command file by set merge /on.
rivergate_rampingtimeseriesInputNoMETER/HOURNone/nullSHOP_RIVER14.4.0.0YesMaximal allowed change in the gate height per hour in both upward and downward direction.
rivergate_ramping_penalty_costtimeseriesInputNoNOK/METER_HOURNone/nullSHOP_RIVER14.4.0.0NoThe penalty cost for breaking the gate ramping constraints in either upward or downward direction.
rivergate_adjustment_costtimeseriesInputNoNOK/METERNone/nullSHOP_RIVER14.4.0.0NoThe cost for changeing the gate height between two time steps in either upward or downward direction.
riverflow_costtimeseriesInputNoNOK/H/M3/SNone/nullSHOP_OPEN14.4.0.0NoA linear cost for the flow of water in the river. If a convex flow_cost_curve is defined on the river, it will be preferred over the flow_cost.
riverflow_cost_constdoubleInputNoNOK/H/M3/S0.0SHOP_OPEN17.5.0NoA linear cost for the flow of water in the river that is constant in time. The convex flow_cost_curve and the timeseries attribute flow_cost will be preferred over the flow_cost_const if multiple costs are defined at the same time.
rivermip_flagtimeseriesInputNoNO_UNITNone/nullSHOP_RIVER14.4.0.0NoA flag series used to turn on (1) and off (0) the use of binary variables to ensure that the river flow is zero when the reservoir level is below the gate or bottom of the river bed. Non-physical flow may occur if the mip_flag is turned off.
riverflow_start_costtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN17.14.0NoCost for river starting to flow. For the cost to be applied, the river attributes min_allowed_flow and absolute_max_flow must be specified.
riverflow_stop_costtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN17.14.0NoCost for river stopping to flow. For the cost to be applied, the river attributes min_allowed_flow and absolute_max_flow must be specified.
riverflow_start_cost_constdoubleInputNoNO_UNIT0.0SHOP_OPEN17.14.0NoConstant cost for river starting to flow. For the cost to be applied, the river attributes min_allowed_flow and absolute_max_flow must be specified. The corresponding timeseries attribute flow_start_cost will be preferred if both are defined.
riverflow_stop_cost_constdoubleInputNoNO_UNIT0.0SHOP_OPEN17.14.0NoConstant cost for river stopping to flow. For the cost to be applied, the river attributes min_allowed_flow and absolute_max_flow must be specified. The corresponding timeseries attribute flow_stop_cost will be preferred if both are defined.
rivermin_allowed_flowdoubleInputNoNO_UNIT0.0SHOP_OPEN17.14.0NoMinimum allowed flow in the river. Needed for adding start- and stop-costs for the river flow.
riverabsolute_max_flowdoubleInputNoNO_UNIT0.0SHOP_OPEN17.14.0NoAbsolute max flow in the river. Needed for adding start- and stop-costs for the river flow.
riverflow_commitment_mip_flagtimeseriesInputNoNO_UNITNone/nullSHOP_OPEN17.14.0NoA flag series used to turn on (1) and off (0) the use of binary variables in the constraints for flow start/stop costs.
riverflow_change_costtimeseriesInputNoNOK/M3/SNone/nullSHOP_OPEN18.4.0YesThe cost for changing the upstream river flow between two time steps (independent of step length), charged on both the upward and downward part of the flow change. A NaN value at a time step means that no cost is applied for the flow change in that time step.
riverflowtimeseriesOutputNoM3/SNone/nullSHOP_OPEN14.3.1.0NoThe flow in the river, referenced at the upstream endpoint.
riverupstream_flowtimeseriesOutputNoM3/SNone/nullSHOP_OPEN14.3.1.0NoThe flow in the river at the upstream endpoint.
riverdownstream_flowtimeseriesOutputNoM3/SNone/nullSHOP_OPEN14.3.1.0NoThe flow in the river at the downstream endpoint.
rivergate_heighttimeseriesOutputNoMETERNone/nullSHOP_RIVER14.3.3.0NoThe post-calculated height of the gate in MASL. The reservoir level and river flow is used to calculate the corresponding gate height after the optimization is done based on the up_level_flow_curve or width_depth_curve.
riversolver_gate_heighttimeseriesOutputNoMETERNone/nullSHOP_RIVER17.10.0NoThe approximate height of the gate that the optimization solver sees when adding gate ramping and gate adjustment constraints. Otherwise, it is identical to the post-calculated gate_height attribute.
rivergate_positiontimeseriesOutputNoNO_UNITNone/nullSHOP_RIVER17.10.0NoThe post-calculated position of the gate corresponding to the x values in the gate_opening_curve. The reservoir level and river flow is used to calculate the corresponding gate position after the optimization is done based on the up_level_flow_curve or width_depth_curve.
rivermin_flow_penaltytimeseriesOutputNoNOKNone/nullSHOP_OPEN14.3.1.0NoThe incurred penalty for breaking the min_flow constraint.
rivermax_flow_penaltytimeseriesOutputNoNOKNone/nullSHOP_OPEN14.3.1.0NoThe incurred penalty for breaking the max_flow constraint.
riverramping_up_penaltytimeseriesOutputNoNOKNone/nullSHOP_OPEN14.3.3.0NoThe incurred penalty for breaking the ramping_up constraint.
riverramping_down_penaltytimeseriesOutputNoNOKNone/nullSHOP_OPEN14.3.3.0NoThe incurred penalty for breaking the ramping_down constraint.
riverflow_change_penaltytimeseriesOutputNoNOKNone/nullSHOP_OPEN18.4.0NoThe incurred cost for changing the upstream river flow between two time steps according to the flow_change_cost attribute.
riverflow_penaltytimeseriesOutputNoNOKNone/nullSHOP_FLOOD_SUPPORT14.3.3.0NoThe penalty incurred based on the flow_cost_curve and the flow rate in the river over the optimization horizon.
riverpeak_flow_penaltytimeseriesOutputNoNOKNone/nullSHOP_FLOOD_SUPPORT14.3.3.0NoThe penalty incurred based on the peak_flow_cost_curve and the highest achieved flow rate in the river over the optimization horizon.
rivergate_ramping_penaltytimeseriesOutputNoNOKNone/nullSHOP_RIVER14.4.0.0NoThe penalty incurred for breaking the gate_ramping constraints according to the gate_ramping_penalty_cost.
rivergate_adjustment_penaltytimeseriesOutputNoNOKNone/nullSHOP_RIVER14.4.0.0NoThe incurred cost for changeing the gate height between time steps according to the gate_adjustment_cost.
riverflow_schedule_penaltytimeseriesOutputNoNOKNone/nullSHOP_OPEN14.4.0.0NoThe incurred cost for breaking the flow_schedule constraints on the river.
riverphysical_flowtimeseriesOutputNoM3/SNone/nullSHOP_OPEN14.4.1.0NoThe physical flow into the top of the river based on the post-calculated reservoir level values. If the river flow is not dependent on the upstream reservoir level, the physical_flow will be identical to the regular flow attribute.
riverinitial_downstream_flowtimeseriesOutputNoM3/SNone/nullSHOP_RIVER14.4.1.4NoThe calculated initial flow that will flow out from the end of the river. This is calulated based on the time delay in the river and the past_upstream_flow and distributed_past_upstream_flow attribute.
riverdistributed_past_upstream_flowxyOutputNox: HOUR and y: M3/SNone/nullSHOP_RIVER14.4.1.4NoThe past upstream flow of upstream river objects that have been distributed down to this river. Represented as an XY table where the x-values are the time steps in negative hours relative to the start of the optimization.
riversim_flowtimeseriesOutputNoM3/SNone/nullSHOP_RIVER15.1.0.0NoThe simulated upstream river flow after a SHOP simulation is performed.
riversim_downstream_flowtimeseriesOutputNoM3/SNone/nullSHOP_RIVER16.8.0NoThe simulated river flow that exits the bottom of the river after a SHOP simulation is performed.
riverdelayed_water_voldoubleOutputNoMM30.0SHOP_OPEN16.8.0NoThe volume of the downstream river flow that arrives after the end of the optimization horizon.
riversim_delayed_water_voldoubleOutputNoMM30.0SHOP_OPEN16.8.0NoThe simulated volume of the downstream river flow that arrives after the end of the simulation horizon.
riverdelayed_water_vol_from_historic_flowdoubleOutputNoMM30.0SHOP_OPEN17.0.0NoThe volume of the past_upstream_flow that arrives after the end of the optimization horizon.
riverlevel_dependent_max_flowxyOutputNox: METER and y: M3/SNone/nullSHOP_RIVER17.10.0NoDescribes the concave envelope of the reservoir-dependent maximal flow in rivers with gates and an up_level_flow_curve or width_depth_curve. Used to add an upper bound for the river flow if the gate is optimizable.
riverlevel_dependent_min_flowxyOutputNox: METER and y: M3/SNone/nullSHOP_RIVER17.10.0NoDescribes the convex envelope of the reservoir-dependent minimal flow in rivers with gates and an up_level_flow_curve or width_depth_curve. Used to add a lower bound for the river flow if the gate is optimizable.
riverphysical_spilldoubleOutputNoMM30.0SHOP_RIVER18.3.0NoThe sum of 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.
rivernonphysical_spilldoubleOutputNoMM30.0SHOP_RIVER18.3.0NoThe sum of 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.
busbarloadtimeseriesInputNoMWNone/nullSHOP_OPEN14.3.4.0NoLoad at the busbar.
busbarptdfsyInputNos: STRING and y: NO_UNITNone/nullSHOP_OPEN14.3.4.0NoPower transfer distribution factors describing change in flow for each ac line relative to change in generation at the busbar.
busbarenergy_pricetimeseriesOutputNoNOK/MWHNone/nullSHOP_OPEN14.3.4.0NoDual value for the energy balance constraint at the busbar.
busbarpower_deficittimeseriesOutputNoMWHNone/nullSHOP_OPEN14.3.4.0NoPower added to the busbar power balance to cover deficit of energy.
busbarpower_excesstimeseriesOutputNoMWHNone/nullSHOP_OPEN14.3.4.0NoPower subtracted from the busbar power balance to remove excess of energy.
ac_linemax_forward_flowtimeseriesInputNoMWNone/nullSHOP_OPEN14.3.4.0NoMaximum transfer capacity in forward direction.
ac_linemax_backward_flowtimeseriesInputNoMWNone/nullSHOP_OPEN14.3.4.0NoMaximum transfer capacity in backward direction.
ac_linen_loss_segmentsintInputNoNO_UNIT0SHOP_OPEN14.3.4.0NoNumber of segments for linearization of quadratic loss.
ac_lineloss_factor_lineardoubleInputNoNO_UNIT0.0SHOP_OPEN14.3.4.0NoLoss factor multiplied with absolute value of the flow in the line.
ac_lineloss_factor_quadraticdoubleInputNoNO_UNIT0.0SHOP_OPEN14.3.4.0NoLoss factor multiplied with the square of the flow in the line. The calculation is linearized with the number of steps defined by n_loss_segments.
ac_lineflowtimeseriesOutputNoMWNone/nullSHOP_OPEN14.3.4.0NoFlow through the line.
ac_lineforward_losstimeseriesOutputNoMWNone/nullSHOP_OPEN14.3.4.0NoTransmission loss for flow in forward direction of the line.
ac_linebackward_losstimeseriesOutputNoMWNone/nullSHOP_OPEN14.3.4.0NoTransmission loss for flow in backward direction of the line.
dc_linemax_forward_flowtimeseriesInputNoMWNone/nullSHOP_OPEN14.3.4.0NoMaximum transfer capacity in forward direction.
dc_linemax_backward_flowtimeseriesInputNoMWNone/nullSHOP_OPEN14.3.4.0NoMaximum transfer capacity in backward direction.
dc_linen_loss_segmentsintInputNoNO_UNIT0SHOP_OPEN14.3.4.0NoNumber of segments for linearization of quadratic loss.
dc_lineloss_constantdoubleInputNoNO_UNIT0.0SHOP_OPEN14.3.4.0NoConstant power loss in DC line terminals, independent of power flow.
dc_lineloss_factor_lineardoubleInputNoNO_UNIT0.0SHOP_OPEN14.3.4.0NoLoss factor multiplied with absolute value of the flow in the line.
dc_lineloss_factor_quadraticdoubleInputNoNO_UNIT0.0SHOP_OPEN14.3.4.0NoLoss factor multiplied with the square of the flow in the line. The calculation is linearized with the number of steps defined by n_loss_segments.
dc_lineflowtimeseriesOutputNoMWNone/nullSHOP_OPEN14.3.4.0NoFlow through the line.
dc_lineforward_losstimeseriesOutputNoMWNone/nullSHOP_OPEN14.3.4.0NoTransmission loss for flow in forward direction of the line.
dc_linebackward_losstimeseriesOutputNoMWNone/nullSHOP_OPEN14.3.4.0NoTransmission loss for flow in backward direction of the line.
gen_reserve_capabilityreserve_type_namestringInputYesSTRINGEmptySHOP_OPEN14.4.0.0NoThe reserve product this reserve capability definition is valid for. Can be either FCR_N_UP/DOWN, FCR_D_UP/DOWN, FRR_UP/DOWN, or RR_UP/DOWN.
gen_reserve_capabilityp_extendedtimeseriesInputNoMWNone/nullSHOP_OPEN14.4.0.0YesDefines an extended production limit for delivering this reserve type. It should be higher than the maximum generator production for upward reserves or below the minimum production for downward reserves.
gen_reserve_capabilityscheduletimeseriesInputNoMWNone/nullSHOP_OPEN14.4.0.0YesA schedule for how much reserve capacity of the specified type that must be delivered on the generator.
pump_reserve_capabilityreserve_type_namestringInputYesSTRINGEmptySHOP_OPEN14.4.0.0NoThe reserve product this reserve capability definition is valid for. Can be either FCR_N_UP/DOWN, FCR_D_UP/DOWN, FRR_UP/DOWN, or RR_UP/DOWN.
pump_reserve_capabilityp_extendedtimeseriesInputNoMWNone/nullSHOP_OPEN14.4.0.0YesDefines an extended production limit for delivering this reserve type. It should be higher than the maximum pump consumption for downward reserves or below the minimum consumption for upward reserves.
pump_reserve_capabilityscheduletimeseriesInputNoMWNone/nullSHOP_OPEN14.4.0.0YesA schedule for how much reserve capacity of the specified type that must be delivered on the pump.
plant_reserve_capabilityreserve_type_namestringInputYesSTRINGEmptySHOP_OPEN14.4.0.0NoThe reserve product this reserve capability definition is valid for. Can be either FCR_N_UP/DOWN, FCR_D_UP/DOWN, FRR_UP/DOWN, or RR_UP/DOWN.
plant_reserve_capabilityp_gen_extendedtimeseriesInputNoMWNone/nullSHOP_OPEN14.4.0.0YesDefines an extended plant production limit for delivering this reserve type on the generators in the plant. Only has an effect if the value is set lower than the sum of p_extended on the generators in the plant.
plant_reserve_capabilityp_pump_extendedtimeseriesInputNoMWNone/nullSHOP_OPEN14.4.0.0YesDefines an extended plant production limit for delivering this reserve type on the pumps in the plant. Only has an effect if the value is set lower than the sum of p_extended on the pumps in the plant.
plant_reserve_capabilityscheduletimeseriesInputNoMWNone/nullSHOP_OPEN14.4.0.0YesA schedule for how much reserve capacity of the specified type that must be delivered for all generators and pumps in the plant.
needle_comb_reserve_capabilityreserve_type_namestringInputYesSTRINGEmptySHOP_OPEN14.4.0.0NoThe reserve product this reserve capability definition is valid for. Can be either FCR_N_UP/DOWN, FCR_D_UP/DOWN, FRR_UP/DOWN, or RR_UP/DOWN.
needle_comb_reserve_capabilityp_extendedtimeseriesInputNoMWNone/nullSHOP_OPEN14.4.0.0YesDefines an extended production limit for delivering this reserve type. It should be higher than the maximum needle_combination production for upward reserves or below the minimum needle_combination production for downward reserves.
batterycharge_efficiencydoubleInputNoNO_UNIT1.0SHOP_OPEN15.2.0.0NoCharge efficiency coefficient.
batterydischarge_efficiencydoubleInputNoNO_UNIT1.0SHOP_OPEN15.2.0.0NoDischarge efficiency coefficient.
batterymax_charge_powerdoubleInputYesMW0.0SHOP_OPEN15.2.0.0NoMaximum charge power.
batterymax_discharge_powerdoubleInputYesMW0.0SHOP_OPEN15.2.0.0NoMaximum discharge power.
batterymax_energydoubleInputYesMWH0.0SHOP_OPEN15.2.0.0NoMaximum energy storage capacity.
batteryinitial_energydoubleInputNoMWH0.0SHOP_OPEN15.2.0.0NoInitial energy storage.
batterydischarge_costdoubleInputNoNOK/MWH0.0SHOP_OPEN15.2.0.0NoBattery discharge cost.
batterycharge_costdoubleInputNoNOK/MWH0.0SHOP_OPEN15.2.0.0NoBattery charge cost.
batterymax_charge_power_constrainttimeseriesInputNoMWNone/nullSHOP_OPEN15.2.0.0YesMaximum charge power constraint.
batterymax_discharge_power_constrainttimeseriesInputNoMWNone/nullSHOP_OPEN15.2.0.0YesMaximum discharge power constraint.
batterymax_energy_constrainttimeseriesInputNoMWHNone/nullSHOP_OPEN15.2.0.0YesMaximum energy storage constraint.
batterymin_energy_constrainttimeseriesInputNoMWHNone/nullSHOP_OPEN15.2.0.0YesMinimum energy storage constraint.
batterycharge_discharge_miptimeseriesInputNoNO_UNITNone/nullSHOP_OPEN15.2.0.0NoMIP variable to prevent simultaneous charging and discharging.
batterycharge_scheduletimeseriesInputNoMWNone/nullSHOP_OPEN15.2.0.0NoBattery charging schedule.
batterydischarge_scheduletimeseriesInputNoMWNone/nullSHOP_OPEN15.2.0.0NoBattery discharging schedule.
batterynet_discharge_scheduletimeseriesInputNoMWNone/nullSHOP_OPEN15.2.0.0NoBattery net-discharging schedule.
batteryfcr_n_up_costtimeseriesInputNoNOK/MWHNone/nullSHOP_OPEN15.5.0.0NoThe cost of allocating fcr_n_up on this battery.
batteryfcr_n_down_costtimeseriesInputNoNOK/MWHNone/nullSHOP_OPEN15.5.0.0NoThe cost of allocating fcr_n_down on this battery.
batteryfcr_d_up_costtimeseriesInputNoNOK/MWHNone/nullSHOP_OPEN15.5.0.0NoThe cost of allocating fcr_d_up on this battery.
batteryfcr_d_down_costtimeseriesInputNoNOK/MWHNone/nullSHOP_OPEN15.5.0.0NoThe cost of allocating fcr_d_down on this battery.
batteryfrr_up_costtimeseriesInputNoNOK/MWHNone/nullSHOP_OPEN15.5.0.0NoThe cost of allocating frr_up on this battery.
batteryfrr_down_costtimeseriesInputNoNOK/MWHNone/nullSHOP_OPEN15.5.0.0NoThe cost of allocating frr_down on this battery.
batteryrr_up_costtimeseriesInputNoNOK/MWHNone/nullSHOP_OPEN15.5.0.0NoThe cost of allocating rr_up on this battery.
batteryrr_down_costtimeseriesInputNoNOK/MWHNone/nullSHOP_OPEN15.5.0.0NoThe cost of allocating rr_down on this battery.
batteryhistorical_dischargetimeseriesInputNoMWNone/nullSHOP_OPEN17.19.0NoBattery discharge before the start of the optimization period.
batteryrolling_max_discharge_limitxytInputNox: MINUTE and y: MWHNone/nullSHOP_OPEN17.19.0YesInput to specify rolling battery discharge constraints that limit the maximum total stored energy discharged within a rolling time window. The x-values represent the length of the rolling time window and the y-values specify the maximum allowed energy discharged. Each (x, y) point in each xy curve represents a rolling ramping constraint.
batterypower_chargetimeseriesOutputNoMWNone/nullSHOP_OPEN15.2.0.0NoPower charged from battery.
batterypower_dischargetimeseriesOutputNoMWNone/nullSHOP_OPEN15.2.0.0NoPower discharged from battery.
batterynet_power_dischargetimeseriesOutputNoMWNone/nullSHOP_OPEN15.2.0.0NoNet power discharged from battery.
batteryenergytimeseriesOutputNoMWHNone/nullSHOP_OPEN15.2.0.0NoEnergy stored in battery.
batteryenergy_valuetimeseriesOutputNoNOK/MWHNone/nullSHOP_OPEN15.2.0.0NoBattery energy dual value.
batteryfcr_n_up_deliverytimeseriesOutputNoMWNone/nullSHOP_OPEN15.5.0.0NoResulting battery fcr_n_up delivery.
batteryfcr_n_down_deliverytimeseriesOutputNoMWNone/nullSHOP_OPEN15.5.0.0NoResulting battery fcr_n_down delivery.
batteryfcr_d_up_deliverytimeseriesOutputNoMWNone/nullSHOP_OPEN15.5.0.0NoResulting battery fcr_d_up delivery.
batteryfcr_d_down_deliverytimeseriesOutputNoMWNone/nullSHOP_OPEN15.5.0.0NoResulting battery fcr_d_down delivery.
batteryfrr_up_deliverytimeseriesOutputNoMWNone/nullSHOP_OPEN15.5.0.0NoResulting battery frr_up delivery.
batteryfrr_down_deliverytimeseriesOutputNoMWNone/nullSHOP_OPEN15.5.0.0NoResulting battery frr_down delivery.
batteryrr_up_deliverytimeseriesOutputNoMWNone/nullSHOP_OPEN15.5.0.0NoResulting battery rr_up delivery.
batteryrr_down_deliverytimeseriesOutputNoMWNone/nullSHOP_OPEN15.5.0.0NoResulting battery rr_down delivery.
windpower_forecasttimeseriesInputYesMWNone/nullSHOP_OPEN15.2.0.0NoWind power production forecast.
windcurtailment_costtimeseriesInputNoNOK/MWHNone/nullSHOP_OPEN15.2.0.0NoWind energy curtailment cost.
windpower_deliveredtimeseriesOutputNoMWNone/nullSHOP_OPEN15.2.0.0NoWind power delivered.
windpower_curtailedtimeseriesOutputNoMWNone/nullSHOP_OPEN15.2.0.0NoWind power curtailed.
solarpower_forecasttimeseriesInputYesMWNone/nullSHOP_OPEN15.2.0.0NoSolar power production forecast.
solarcurtailment_costtimeseriesInputNoNOK/MWHNone/nullSHOP_OPEN15.2.0.0NoSolar energy curtailment cost.
solarpower_deliveredtimeseriesOutputNoMWNone/nullSHOP_OPEN15.2.0.0NoSolar power delivered.
solarpower_curtailedtimeseriesOutputNoMWNone/nullSHOP_OPEN15.2.0.0NoSolar power curtailed.