Further improvements

Author: staadecker

docs/Developing Modules.md

@@ -43,7 +43,7 @@ indexed over that set. Both the set and parameter are initialized from
 the `input.csv` file.
 
 ```python
-from switch_model.utilities.custom_loading import *
+from pyomo.environ import *
 
 
 def define_components(mod):

switch_model/balancing/demand_response/simple.py

@@ -8,6 +8,11 @@
 demand shifting. This does not include a Shed Service (curtailment of load),
 nor a Shimmy Service (fast dispatch for load following or regulation).
 
+INPUT FILE FORMAT
+    Import demand response-specific data from an input directory.
+
+    dr_data.csv
+        LOAD_ZONE, TIMEPOINT, dr_shift_down_limit, dr_shift_up_limit
 """
 
 import os
@@ -53,11 +58,21 @@ def define_components(mod):
         mod.TIMEPOINTS,
         default=0.0,
         within=NonNegativeReals,
+<<<<<<< HEAD
         validate=lambda m, value, z, t: value <= m.zone_demand_mw[z, t],
     )
     mod.dr_shift_up_limit = Param(
         mod.LOAD_ZONES, mod.TIMEPOINTS, default=float("inf"), within=NonNegativeReals
     )
+=======
+        input_file="dr_data.csv",
+        validate=lambda m, value, z, t: value <= m.zone_demand_mw[z, t])
+    mod.dr_shift_up_limit = Param(
+        mod.LOAD_ZONES, mod.TIMEPOINTS,
+        default= float('inf'),
+        input_file="dr_data.csv",
+        within=NonNegativeReals)
+>>>>>>> 941c8e2e (Further improvements)
     mod.ShiftDemand = Var(
         mod.LOAD_ZONES,
         mod.TIMEPOINTS,
@@ -77,6 +92,7 @@ def define_components(mod):
     try:
         mod.Distributed_Power_Withdrawals.append("ShiftDemand")
     except AttributeError:
+<<<<<<< HEAD
         mod.Zone_Power_Withdrawals.append("ShiftDemand")
 
 
@@ -96,3 +112,6 @@ def load_inputs(mod, switch_data, inputs_dir):
         autoselect=True,
         param=(mod.dr_shift_down_limit, mod.dr_shift_up_limit),
     )
+=======
+        mod.Zone_Power_Withdrawals.append('ShiftDemand')
+>>>>>>> 941c8e2e (Further improvements)

switch_model/balancing/electric_vehicles/simple.py

@@ -11,6 +11,13 @@
 of each timeseries they must be charged at some specific level according
 to users necessity.
 
+INPUT FILE FORMAT
+    Import virtual batteries specific location and power limits
+    from an input directory.
+
+    ev_limits.tab
+        LOAD_ZONES, TIMEPOINT, ev_cumulative_charge_upper_mwh,
+        ev_cumulative_charge_upper_mwh, ev_charge_limit_mw
 """
 
 import os
@@ -66,6 +73,7 @@ def define_components(mod):
     """
 
     mod.ev_charge_limit_mw = Param(
+<<<<<<< HEAD
         mod.LOAD_ZONES, mod.TIMEPOINTS, default=float("inf"), within=NonNegativeReals
     )
 
@@ -76,6 +84,24 @@ def define_components(mod):
     mod.ev_cumulative_charge_lower_mwh = Param(
         mod.LOAD_ZONES, mod.TIMEPOINTS, default=0.0, within=NonNegativeReals
     )
+=======
+        mod.LOAD_ZONES, mod.TIMEPOINTS,
+        default = float('inf'),
+        input_file="ev_limits.csv",
+        within=NonNegativeReals)
+
+    mod.ev_cumulative_charge_upper_mwh = Param(
+        mod.LOAD_ZONES, mod.TIMEPOINTS,
+        default = 0.0,
+        input_file="ev_limits.csv",
+        within=NonNegativeReals)
+
+    mod.ev_cumulative_charge_lower_mwh = Param(
+        mod.LOAD_ZONES, mod.TIMEPOINTS,
+        default = 0.0,
+        input_file="ev_limits.csv",
+        within=NonNegativeReals)
+>>>>>>> 941c8e2e (Further improvements)
 
     mod.EVCharge = Var(
         mod.LOAD_ZONES,
@@ -111,6 +137,7 @@ def define_components(mod):
     if "Distributed_Power_Injections" in dir(mod):
         mod.Distributed_Power_Withdrawals.append("EVCharge")
     else:
+<<<<<<< HEAD
         mod.Zone_Power_Withdrawals.append("EVCharge")
 
 
@@ -136,3 +163,6 @@ def load_inputs(mod, switch_data, inputs_dir):
             mod.ev_charge_limit_mw,
         ),
     )
+=======
+        mod.Zone_Power_Withdrawals.append('EVCharge')
+>>>>>>> 941c8e2e (Further improvements)

switch_model/balancing/unserved_load.py

@@ -6,6 +6,15 @@
 specially useful when running production costing simulations, though not
 strictly required in all cases.
 
+INPUT FILE FORMAT
+    The cost penalty of unserved load in units of $/MWh is the only parameter
+    that can be inputted. The following file is not mandatory, because the
+    parameter defaults to a value of 500 $/MWh. This file contains one header
+    row and one data row.
+
+    optional input files:
+        lost_load_cost.csv
+            unserved_load_penalty
 """
 
 import os
@@ -35,6 +44,7 @@ def define_components(mod):
 
     """
 
+<<<<<<< HEAD
     mod.unserved_load_penalty = Param(within=NonNegativeReals, default=500)
     mod.UnservedLoad = Var(mod.LOAD_ZONES, mod.TIMEPOINTS, within=NonNegativeReals)
     mod.Zone_Power_Injections.append("UnservedLoad")
@@ -66,3 +76,19 @@ def load_inputs(mod, switch_data, inputs_dir):
         auto_select=True,
         param=(mod.unserved_load_penalty,),
     )
+=======
+    mod.unserved_load_penalty = Param(
+        within=NonNegativeReals,
+        input_file="lost_load_cost.csv",
+        default=500)
+    mod.UnservedLoad = Var(
+        mod.LOAD_ZONES, mod.TIMEPOINTS,
+        within=NonNegativeReals)
+    mod.Zone_Power_Injections.append('UnservedLoad')
+
+    mod.UnservedLoadPenalty = Expression(
+        mod.TIMEPOINTS,
+        rule=lambda m, tp: sum(m.UnservedLoad[z, tp] *
+            m.unserved_load_penalty for z in m.LOAD_ZONES))
+    mod.Cost_Components_Per_TP.append('UnservedLoadPenalty')
+>>>>>>> 941c8e2e (Further improvements)

switch_model/generators/extensions/hydro_system.py

@@ -459,6 +459,7 @@ def load_inputs(mod, switch_data, inputs_dir):
     hydro is treated like any other variable renewable resource, and
     expects data in variable_capacity_factors.csv.
 
+    TODO use new input loading format with input_file=
     """
 
     switch_data.load_aug(

switch_model/solve.py

@@ -33,7 +33,7 @@
 )
 from switch_model.upgrade import do_inputs_need_upgrade, upgrade_inputs
 from switch_model.tools.graph.cli_graph import main as graph_main
-from switch_model.utilities.custom_loading import patch_to_allow_loading
+from switch_model.utilities.load_data import patch_to_allow_loading
 from switch_model.utilities.results_info import save_info, add_info, ResultsInfoSection
 
 

switch_model/transmission/local_td.py

@@ -8,6 +8,21 @@
 distribution pathway that incurs distribution losses. Distributed Energy
 Resources (DER) impact the energy balance at the distribution node, avoiding
 losses from the distribution network.
+
+INPUT FILE FORMAT
+    Import local transmission & distribution data. The following files
+    are expected in the input directory. Both files will
+    contain additional columns that are used by the load_zones module
+    and transmission.transport.build module.
+
+    load_zones.csv
+        load_zone, existing_local_td, local_td_annual_cost_per_mw
+
+    trans_params.csv
+        distribution_loss_rate
+
+    If distribution_loss_rate is not specified, or if trans_params.csv doesn't
+    exist, mod.distribution_loss_rate will default to 0.053.
 """
 from __future__ import division
 
@@ -123,8 +138,13 @@ def define_components(mod):
     """
 
     # Local T&D
+<<<<<<< HEAD
     mod.existing_local_td = Param(mod.LOAD_ZONES, within=NonNegativeReals)
     mod.min_data_check("existing_local_td")
+=======
+    mod.existing_local_td = Param(mod.LOAD_ZONES, within=NonNegativeReals, input_file="load_zones.csv")
+    mod.min_data_check('existing_local_td')
+>>>>>>> 941c8e2e (Further improvements)
 
     mod.BuildLocalTD = Var(mod.LOAD_ZONES, mod.PERIODS, within=NonNegativeReals)
     mod.LocalTDCapacity = Expression(
@@ -136,16 +156,23 @@ def define_components(mod):
             for bld_yr in m.CURRENT_AND_PRIOR_PERIODS_FOR_PERIOD[period]
         ),
     )
-    mod.distribution_loss_rate = Param(default=0.053)
+    mod.distribution_loss_rate = Param(default=0.053, input_file="trans_params.csv")
 
     mod.Meet_Local_TD = Constraint(
         mod.EXTERNAL_COINCIDENT_PEAK_DEMAND_ZONE_PERIODS,
         rule=lambda m, z, period: m.LocalTDCapacity[z, period]
         * (1 - m.distribution_loss_rate)
         >= m.zone_expected_coincident_peak_demand[z, period],
     )
+<<<<<<< HEAD
     mod.local_td_annual_cost_per_mw = Param(mod.LOAD_ZONES, within=NonNegativeReals)
     mod.min_data_check("local_td_annual_cost_per_mw")
+=======
+    mod.local_td_annual_cost_per_mw = Param(
+        mod.LOAD_ZONES,
+        within=NonNegativeReals, input_file="load_zones.csv")
+    mod.min_data_check('local_td_annual_cost_per_mw')
+>>>>>>> 941c8e2e (Further improvements)
     mod.LocalTDFixedCosts = Expression(
         mod.PERIODS,
         doc="Summarize annual local T&D costs for the objective function.",
@@ -203,6 +230,7 @@ def define_dynamic_components(mod):
             )
             == sum(
                 getattr(m, component)[z, t]
+<<<<<<< HEAD
                 for component in m.Distributed_Power_Withdrawals
             )
         ),
@@ -240,3 +268,6 @@ def load_inputs(mod, switch_data, inputs_dir):
         optional_params=("distribution_loss_rate",),
         param=(mod.distribution_loss_rate),
     )
+=======
+                for component in m.Distributed_Power_Withdrawals)))
+>>>>>>> 941c8e2e (Further improvements)

switch_model/utilities/__init__.py

@@ -7,19 +7,18 @@
 from __future__ import print_function
 
 import functools
-import os, types, sys, argparse, time, datetime, traceback, subprocess, platform
+import os, types, sys, argparse, time, datetime, traceback, subprocess
 import warnings
 
 import switch_model.__main__ as main
 from pyomo.environ import *
-from pyomo.core.base.set import UnknownSetDimen
 from pyomo.dataportal import DataManagerFactory
 from pyomo.dataportal.plugins.csv_table import CSVTable
 
 from switch_model.utilities.results_info import add_info, ResultsInfoSection
 from switch_model.utilities.scaling import _ScaledVariable, _get_unscaled_expression
 import pyomo.opt
-import switch_model.utilities.custom_loading as pyo
+from switch_model.utilities.load_data import load_registered_inputs, load_data
 
 # Define string_types (same as six.string_types). This is useful for
 # distinguishing between strings and other iterables.
@@ -277,7 +276,7 @@ def load_inputs(model, inputs_dir=None, attach_data_portal=False):
     timer = StepTimer()
     data = DataPortal(model=model)
     data.load_aug = types.MethodType(load_aug, data)
-    pyo.load_registered_inputs(data, inputs_dir)
+    load_registered_inputs(data, inputs_dir)
     for module in model.get_modules():
         if hasattr(module, "load_inputs"):
             module.load_inputs(model, data, inputs_dir)
@@ -596,6 +595,7 @@ def check_mandatory_components(model, *mandatory_model_components):
     return True
 
 
+<<<<<<< HEAD
 class InputError(Exception):
     """Exception raised for errors in the input.
 
@@ -614,11 +614,16 @@ def __str__(self):
 def load_aug(
     switch_data, optional=False, auto_select=False, optional_params=[], **kwds
 ):
+=======
+def load_aug(switch_data, optional=False, auto_select=False,
+             optional_params=[], **kwds):
+>>>>>>> 941c8e2e (Further improvements)
     """
     This is a wrapper for the DataPortal object that accepts additional
     keywords. This currently supports a flag for the file being optional.
     The name load_aug() is not great and may be changed.
     """
+<<<<<<< HEAD
     # TODO:
     # Allow user to specify filename when defining parameters and sets.
     # Also allow user to specify the name(s) of the column(s) in each set.
@@ -760,6 +765,9 @@ def get_column_name(p):
     # All done with cleaning optional bits. Pass the updated arguments
     # into the DataPortal.load() function.
     switch_data.load(**kwds)
+=======
+    load_data(switch_data, optional, auto_select, optional_params, **kwds)
+>>>>>>> 941c8e2e (Further improvements)
 
 
 # Register a custom data manager that wraps the default CSVTable DataManager