pre-vacation progress upload. Lots of work left

Agents/prosumer_model.py

@@ -55,11 +55,11 @@ def __init__(self, eid, forecasted_data, metrics):
         Parameters
         ----------
         eid : list
-            Something
+            ???
         forcasted_data : list
-            Something
+            ???
         metrics : list
-            Something
+            ???
         """
         self.eid = eid
         self.time = []
@@ -309,7 +309,7 @@ def supply(self, ex_excess:list, metric:str) -> list:
         Parameters
         ----------
         ex_excess : list
-            The list of excess energy(?) in chronological order
+            The list of excess energy in chronological order (???)
         metric : str
             A 2 character string. Options:[MC, MB, MO, MR]
 

Controllers/GPController/gpcontroller_model.py

@@ -2,7 +2,70 @@
 
 
 class gpcontroller_python:
-    def __init__(self, soc_min, soc_max, h2_soc_min, h2_soc_max, fc_eff):
+    def __init__(self, soc_min:int, soc_max:int, h2_soc_min:int, h2_soc_max:int, fc_eff:float):
+        """
+        Constructor for the gpcontroller_python class
+
+        ...
+
+        Parameters
+        ----------
+        soc_min : int 
+            ???
+        soc_max : int 
+            ???
+        h2_soc_min : int
+            ???
+        h2_soc_max : int
+            ???
+        fc_eff : float
+            ???
+
+        Attributes
+        ----------
+        soc_max_b : int
+            = soc_max
+        soc_min_b : int
+            = soc_min
+        soc_max_h2 : int
+            = h2_soc_max
+        soc_min_h2 : int
+            = h2_soc_min
+        fc_eff : float
+            = fc_eff
+
+        net : int
+            = 0 
+        deficit : int 
+            = 0
+        excess : int
+            = 0
+        flow_b : list
+            = []
+        flow_e : int
+            = 0
+        fc_out : int
+            = 0
+        h_out : int
+            = 0 
+
+        generators : pd.DataFrame()
+            Empty Dataframe
+        demands : pd.DataFrame()
+            Empty Dataframe
+        batteries : pd.DataFrame()
+            Empty Dataframe
+        h2_soc : list
+            Empty list
+        p_gen : list
+            Empty list
+        p_dem : list
+            Empty list
+        soc : list
+            Empty list
+        curtailment : Boolean
+            False bool
+        """
         self.soc_max_b = soc_max
         self.soc_min_b = soc_min
         self.soc_max_h2 = h2_soc_max
@@ -27,7 +90,7 @@ def __init__(self, soc_min, soc_max, h2_soc_min, h2_soc_max, fc_eff):
         self.curtailment = False
 
 
-    def gpcontrol(self, generators, demands, batteries, curtail):#, fc_gen):
+    def gpcontrol(self, generators:pd.DataFrame, demands:pd.DataFrame, batteries:pd.DataFrame, curtail:int) -> dict:#, fc_gen):
 
         self.generators = generators
         self.demands = demands

configuration/bids/flex_trade.py

@@ -1,6 +1,24 @@
 from datetime import datetime
 
-def match_trades(supply_offers, demand_requests):
+def match_trades(supply_offers, demand_requests) -> list:
+    """
+    Unknown description.
+    Not used by any of the 5 test cases
+
+    ...
+
+    Parameters
+    ----------
+    supply_offers : list or dictionary (hard to tell)
+        ???
+    demand_requests : list or dictionary (hard to tell)
+        ???
+
+    Returns
+    -------
+    trades : list
+        Description
+    """
     trades = []
 
     # Sort demand requests in descending order based on price
@@ -45,6 +63,7 @@ def match_trades(supply_offers, demand_requests):
     return trades
 
 
+## Hard coded values defined here.
 # Usage
 supply_offers = [('prosumer_0', ['2012-01-01 00:00:00', 17, 4]),
                  ('prosumer_0', ['2012-01-01 00:30:00', 17, 4]),

configuration/bids/make_bids.py

@@ -4,6 +4,24 @@
 
 # Function to generate data
 def generate_data(start_date, end_date, bid_range, num_bids_per_day, mc_range):
+    """
+    Unknown description.
+    Not used by any of the 5 test cases
+
+    ...
+
+    Parameters
+    ----------
+    supply_offers : list or dictionary (hard to tell)
+        ???
+    demand_requests : list or dictionary (hard to tell)
+        ???
+
+    Returns
+    -------
+    trades : list
+        Description
+    """
     current_date = start_date
     data = []
     while current_date <= end_date:
@@ -28,7 +46,26 @@ def generate_data(start_date, end_date, bid_range, num_bids_per_day, mc_range):
 # Generate your data
 supply_bids = generate_data(start_date, end_date, supply_bid_range, supply_num_bids_per_day, mc_range)
 demand_bids = generate_data(start_date, end_date, demand_bid_range, demand_num_bids_per_day, mb_range)
-def write_data_to_file(data, bid_type, file):
+def write_data_to_file(data, bid_type, file) -> None:
+    """
+    Unknown description.
+    Not used by any of the 5 test cases
+
+    ...
+
+    Parameters
+    ----------
+    data : ???
+        ???
+    bid_type : ???
+        ???
+    file : ???
+        ???
+
+    Returns
+    -------
+    None
+    """
     file.write(f"{bid_type} =")
     file.write("[")
     for i, bid in enumerate(data):

configuration/bids/plot_bids.py

@@ -5,6 +5,27 @@
 
 
 def find_accepted_bids(sorted_supply_bids, sorted_demand_bids, num_s_bid, num_d_bid):
+    """
+    Unknown description.
+    Not used by any of the 5 test cases
+
+    ...
+
+    Parameters
+    ----------
+    sorted_supply_bids : ???
+        ???
+    sorted_demand_bids : ???
+        ???
+    num_s_bid : ???
+        ???
+    num_d_bid : ???
+        ???
+
+    Returns
+    -------
+    None
+    """
     accepted_supply_bids = []
     for i in range(num_s_bid+1):
         accepted_supply_bids.append(sorted_supply_bids[i])
@@ -16,6 +37,26 @@ def find_accepted_bids(sorted_supply_bids, sorted_demand_bids, num_s_bid, num_d_
     return accepted_supply_bids, accepted_demand_bids
 
 def clear(date_time, supply_bids, demand_bids):
+    """
+    Unknown description.
+    Not used by any of the 5 test cases
+
+
+    ...
+
+    Parameters
+    ----------
+    date_time : ???
+        ???
+    supply_bids : ???
+        ???
+    demand_bids : ???
+        ???
+
+    Returns
+    -------
+    None
+    """
     supply_bids_for_date_time = [bid for bid in supply_bids if bid[0] == date_time]
     demand_bids_for_date_time = [bid for bid in demand_bids if bid[0] == date_time]
 
@@ -187,7 +228,22 @@ def clear(date_time, supply_bids, demand_bids):
 
 
 
-def plot_bids(date_time):
+def plot_bids(date_time) -> None:
+    """
+    Filter bids for the chosen date and time and creates a plot.
+    Not used by any of the 5 test cases
+
+    ...
+
+    Parameters
+    ----------
+    date_time : ???
+        ???
+
+    Returns
+    -------
+    None
+    """
     # Filter bids for the chosen date and time
 
     market_quantity, market_price, clearing_bid, clearing_quantity =\

simulation creator_DNcontrolCase.py

@@ -10,6 +10,10 @@
 # Incorrect format at position 1172 within the given csv
 # ERROR 2:
 # Could not import module controller
+# !!! Error update
+# When ran with environment given by alex, it runs until it receives the following error:
+# mosaik.exceptions.SimulationError:
+# "Loop ['Controller-0', 'Grid-0'] reached maximal iteration count of 100. Adjust `max_loop_iterations` in the scenario if needed"
 
 
 

simulation creator_multienergyCase.py

@@ -11,6 +11,8 @@
 
 # ERROR:
 # mosaik.exceptions.ScenarioError: Simulator "HeatPump" could not be started: Could not import module: No module named 'Heat_Pump_Model' --> No module named 'Heat_Pump_Model'
+# !!!UPDATE ON ERROR:
+# With the environment yaml alex gave, this actually runs
 
 outputfile='Result/MultienergyCase/results.csv'
 sim_config_file="Cases/MultienergyCase/"