Replace load_aug

Author: staadecker

docs/Developing Modules.md

@@ -35,27 +35,27 @@ Some modules need to define objects to be shared across multiple modules.
 for adding constraints, expressions, variables, sets or parameters to the model.
 
 Sometimes Sets or Parameters should be initialized from an input csv file.
-If this is the case, add the following arguments to the component definition: 
-`input_file`, `input_optional` (optional), `input_column` (optional).
+If this is the case, add `input_file=` (and optionally `input_column`) to the
+set or parameter definition.
 
-For example the following code snippet defines a set and a parameter
+For example the following code snippet defines a Set and a parameter
 indexed over that set. Both the set and parameter are initialized from
-the input.csv file.
+the `input.csv` file.
 
 ```python
-from switch_model.utilities.pyo import *
+from switch_model.utilities.custom_loading import *
+
 
 def define_components(mod):
     mod.SetA = Set(
         dimen=2,
         input_file="input.csv",
-        input_optional=True, # the default is False
     )
 
     mod.some_indexed_param = Param(
         mod.SetA,
         input_file="input.csv",
-        input_column="param1" # default is the name of the component, in this case 'some_indexed_param'
+        input_column="param1"  # only specify when the name of the column in the csv is not the same as the component name
     )
 ```
 

switch_model/balancing/load_zones.py

@@ -3,9 +3,29 @@
 
 """
 Defines load zone parameters for the Switch model.
+
+INPUT FILE INFORMATION
+    Import load zone data. The following tab-separated files are
+    expected in the input directory. Their index columns need to be on
+    the left, but the data columns can be in any order. Extra columns
+    will be ignored during import, and optional columns can be dropped.
+    Other modules (such as local_td) may look for additional columns in
+    some of these files. If you don't want to specify data for any
+    optional parameter, use a dot . for its value. Optional columns and
+    files are noted with a *.
+
+    load_zones.csv
+        LOAD_ZONE, zone_ccs_distance_km*, zone_dbid*
+
+    loads.csv
+        LOAD_ZONE, TIMEPOINT, zone_demand_mw
+
+    zone_coincident_peak_demand.csv*
+        LOAD_ZONE, PERIOD, zone_expected_coincident_peak_demand
 """
 import os
-from switch_model.utilities.pyo import *
+
+from pyomo.environ import *
 from switch_model.reporting import write_table
 from switch_model.tools.graph import graph
 
@@ -106,10 +126,14 @@ def define_components(mod):
     mod.EXTERNAL_COINCIDENT_PEAK_DEMAND_ZONE_PERIODS = Set(
         dimen=2,
         within=mod.LOAD_ZONES * mod.PERIODS,
+        input_file="zone_coincident_peak_demand.csv",
+        input_optional=True,
         doc="Zone-Period combinations with zone_expected_coincident_peak_demand data.",
     )
     mod.zone_expected_coincident_peak_demand = Param(
-        mod.EXTERNAL_COINCIDENT_PEAK_DEMAND_ZONE_PERIODS, within=NonNegativeReals
+        mod.EXTERNAL_COINCIDENT_PEAK_DEMAND_ZONE_PERIODS,
+        input_file="zone_coincident_peak_demand.csv",
+        within=NonNegativeReals,
     )
     mod.zone_total_demand_in_period_mwh = Param(
         mod.LOAD_ZONES,
@@ -150,39 +174,6 @@ def define_dynamic_components(mod):
     )
 
 
-def load_inputs(mod, switch_data, inputs_dir):
-    """
-    Import load zone data. The following tab-separated files are
-    expected in the input directory. Their index columns need to be on
-    the left, but the data columns can be in any order. Extra columns
-    will be ignored during import, and optional columns can be dropped.
-    Other modules (such as local_td) may look for additional columns in
-    some of these files. If you don't want to specify data for any
-    optional parameter, use a dot . for its value. Optional columns and
-    files are noted with a *.
-
-    load_zones.csv
-        LOAD_ZONE, zone_ccs_distance_km*, zone_dbid*
-
-    loads.csv
-        LOAD_ZONE, TIMEPOINT, zone_demand_mw
-
-    zone_coincident_peak_demand.csv*
-        LOAD_ZONE, PERIOD, zone_expected_coincident_peak_demand
-
-    """
-    # Include select in each load() function so that it will check out
-    # column names, be indifferent to column order, and throw an error
-    # message if some columns are not found.
-    switch_data.load_aug(
-        optional=True,
-        filename=os.path.join(inputs_dir, "zone_coincident_peak_demand.csv"),
-        index=mod.EXTERNAL_COINCIDENT_PEAK_DEMAND_ZONE_PERIODS,
-        select=("LOAD_ZONE", "PERIOD", "zone_expected_coincident_peak_demand"),
-        param=(mod.zone_expected_coincident_peak_demand),
-    )
-
-
 def post_solve(instance, outdir):
     """
     Exports load_balance.csv, load_balance_annual_zonal.csv, and load_balance_annual.csv.

switch_model/balancing/operating_reserves/areas.py

@@ -3,8 +3,15 @@
 
 """
 Defines balancing areas for operational reserves.
+
+INPUT FILE INFORMATION
+
+    Import balancing_area data. The following files are expected in the input
+    directory:
+
+    load_zones.csv
+        LOAD_ZONE, ..., zone_balancing_area
 """
-import os
 from pyomo.environ import *
 
 dependencies = "switch_model.timescales", "switch_model.balancing.load_zones"
@@ -32,7 +39,10 @@ def define_components(mod):
     """
 
     mod.zone_balancing_area = Param(
-        mod.LOAD_ZONES, default="system_wide_balancing_area", within=Any
+        mod.LOAD_ZONES,
+        input_file="load_zones.csv",
+        default="system_wide_balancing_area",
+        within=Any,
     )
     mod.BALANCING_AREAS = Set(
         ordered=False,
@@ -45,22 +55,3 @@ def define_components(mod):
         ),
     )
     mod.BALANCING_AREA_TIMEPOINTS = Set(initialize=mod.BALANCING_AREAS * mod.TIMEPOINTS)
-
-
-def load_inputs(mod, switch_data, inputs_dir):
-    """
-    Import balancing_area data. The following files are expected in the input
-    directory:
-
-    load_zones.csv
-        LOAD_ZONE, ..., zone_balancing_area
-
-    """
-    # Include select in each load() function so that it will check out
-    # column names, be indifferent to column order, and throw an error
-    # message if some columns are not found.
-    switch_data.load_aug(
-        filename=os.path.join(inputs_dir, "load_zones.csv"),
-        auto_select=True,
-        param=(mod.zone_balancing_area),
-    )

switch_model/balancing/planning_reserves.py

@@ -44,6 +44,20 @@
 rules (and the need to improve them)
 https://www.caiso.com/Documents/Jan29_2016_Comments_2017Track1Proposals_ResourceAdequacyProgram_R14-10-010.pdf
 
+
+INPUT FILE FORMAT
+    reserve_capacity_value.csv
+        GEN, TIMEPOINT, gen_capacity_value
+
+    planning_reserve_requirement_zones.csv
+        PLANNING_RESERVE_REQUIREMENTS, prr_cap_reserve_margin, prr_enforcement_timescale
+
+    generation_projects_info.csv
+        ..., gen_can_provide_cap_reserves
+
+    planning_reserve_requirement_zones.csv
+        PRR, ZONE
+
 """
 
 import os
@@ -128,22 +142,29 @@ def define_components(model):
     will not reflect any DER activities.
     """
     model.PLANNING_RESERVE_REQUIREMENTS = Set(
-        doc="Areas and times where planning reserve margins are specified.", dimen=1
+        doc="Areas and times where planning reserve margins are specified.",
+        input_file="planning_reserve_requirements.csv",
+        dimen=1,
     )
     model.PRR_ZONES = Set(
         dimen=2,
+        input_file="planning_reserve_requirement_zones.csv",
         doc=(
             "A set of (prr, z) that describes which zones contribute to each "
             "Planning Reserve Requirement."
         ),
     )
     model.prr_cap_reserve_margin = Param(
-        model.PLANNING_RESERVE_REQUIREMENTS, within=PercentFraction, default=0.15
+        model.PLANNING_RESERVE_REQUIREMENTS,
+        within=PercentFraction,
+        input_file="planning_reserve_requirements.csv",
+        default=0.15,
     )
     model.prr_enforcement_timescale = Param(
         model.PLANNING_RESERVE_REQUIREMENTS,
         default="period_peak_load",
         validate=lambda m, value, prr: value in ("all_timepoints", "peak_load"),
+        input_file="planning_reserve_requirements.csv",
         doc=(
             "Determines whether planning reserve requirements are enforced in "
             "each timepoint, or just timepoints with peak load (zone_demand_mw)."
@@ -199,6 +220,7 @@ def PRR_TIMEPOINTS_init(m):
         model.GENERATION_PROJECTS,
         within=Boolean,
         default=True,
+        input_file="generation_projects_info.csv",
         doc="Indicates whether a generator can provide capacity reserves.",
     )
 
@@ -220,6 +242,7 @@ def gen_capacity_value_default(m, g, t):
         # Previously domain was PercentFraction however we want to allow renewable factors greater than 1
         # or less than 0.
         within=Reals,
+        input_file="reserve_capacity_value.csv",
         default=gen_capacity_value_default,
         validate=lambda m, value, g, t: (
             value == 0.0 if not m.gen_can_provide_cap_reserves[g] else True
@@ -299,42 +322,3 @@ def define_dynamic_components(model):
             "of REQUIREMENTS_FOR_CAPACITY_RESERVES for each of PRR_TIMEPOINTS."
         ),
     )
-
-
-def load_inputs(model, switch_data, inputs_dir):
-    """
-    reserve_capacity_value.csv
-        GEN, TIMEPOINT, gen_capacity_value
-
-    planning_reserve_requirement_zones.csv
-        PLANNING_RESERVE_REQUIREMENTS, prr_cap_reserve_margin, prr_enforcement_timescale
-
-    generation_projects_info.csv
-        ..., gen_can_provide_cap_reserves
-
-    planning_reserve_requirement_zones.csv
-        PRR, ZONE
-
-    """
-    switch_data.load_aug(
-        filename=os.path.join(inputs_dir, "reserve_capacity_value.csv"),
-        optional=True,
-        auto_select=True,
-        param=(model.gen_capacity_value),
-    )
-    switch_data.load_aug(
-        filename=os.path.join(inputs_dir, "planning_reserve_requirements.csv"),
-        auto_select=True,
-        index=model.PLANNING_RESERVE_REQUIREMENTS,
-        param=(model.prr_cap_reserve_margin, model.prr_enforcement_timescale),
-    )
-    switch_data.load_aug(
-        filename=os.path.join(inputs_dir, "generation_projects_info.csv"),
-        auto_select=True,
-        optional_params=["gen_can_provide_cap_reserves"],
-        param=(model.gen_can_provide_cap_reserves),
-    )
-    switch_data.load_aug(
-        filename=os.path.join(inputs_dir, "planning_reserve_requirement_zones.csv"),
-        set=model.PRR_ZONES,
-    )

switch_model/energy_sources/fuel_costs/markets.py

@@ -328,7 +328,6 @@ def zone_fuel_cost_adder_validate(model, val, z, fuel, p):
         mod.ZONE_FUELS,
         mod.PERIODS,
         input_file="zone_fuel_cost_diff.csv",
-        input_optional=True,
         input_column="fuel_cost_adder",
         within=Reals,
         default=0,

switch_model/energy_sources/fuel_costs/simple.py

@@ -7,8 +7,12 @@
 serves as an alternative to the more complex fuel_markets with tiered
 supply curves. This is mutually exclusive with the fuel_markets module.
 
+INPUT FILE INFORMATION
+    The following files are expected in the input directory:
+
+    fuel_cost.csv
+        load_zone, fuel, period, fuel_cost
 """
-import os
 from pyomo.environ import *
 
 dependencies = (
@@ -50,11 +54,14 @@ def define_components(mod):
 
     mod.ZONE_FUEL_PERIODS = Set(
         dimen=3,
+        input_file="fuel_cost.csv",
         validate=lambda m, z, f, p: (
             z in m.LOAD_ZONES and f in m.FUELS and p in m.PERIODS
         ),
     )
-    mod.fuel_cost = Param(mod.ZONE_FUEL_PERIODS, within=NonNegativeReals)
+    mod.fuel_cost = Param(
+        mod.ZONE_FUEL_PERIODS, input_file="fuel_cost.csv", within=NonNegativeReals
+    )
     mod.min_data_check("ZONE_FUEL_PERIODS", "fuel_cost")
 
     mod.GEN_TP_FUELS_UNAVAILABLE = Set(
@@ -85,22 +92,3 @@ def FuelCostsPerTP_rule(m, t):
 
     mod.FuelCostsPerTP = Expression(mod.TIMEPOINTS, rule=FuelCostsPerTP_rule)
     mod.Cost_Components_Per_TP.append("FuelCostsPerTP")
-
-
-def load_inputs(mod, switch_data, inputs_dir):
-    """
-
-    Import simple fuel cost data. The following files are expected in
-    the input directory:
-
-    fuel_cost.csv
-        load_zone, fuel, period, fuel_cost
-
-    """
-
-    switch_data.load_aug(
-        filename=os.path.join(inputs_dir, "fuel_cost.csv"),
-        select=("load_zone", "fuel", "period", "fuel_cost"),
-        index=mod.ZONE_FUEL_PERIODS,
-        param=[mod.fuel_cost],
-    )