add flows to clearing interface

emarketpy/base_market.py

@@ -143,9 +143,9 @@ def clear(
             market_products (list[MarketProduct]): The products to be traded.
 
         Returns:
-            (Orderbook, Orderbook, list[dict]): The empty accepted orderbook, the empty rejected orderbook and the empty market metadata.
+            (Orderbook, Orderbook, list[dict], dict[tuple, float]): The empty accepted orderbook, the empty rejected orderbook and the empty market metadata and the flows between market zones.
         """
-        return [], [], []
+        return [], [], [], {}
 
 
 class MarketRole(MarketMechanism, Role):

emarketpy/clearing_algorithms/all_or_nothing.py

@@ -113,7 +113,7 @@ def clear(
                 )
             )
         # accepted orders can not be used in future
-        return accepted_orders, rejected_orders, meta
+        return accepted_orders, rejected_orders, meta, {}
 
 
 # does not allow to have partial accepted bids
@@ -194,4 +194,4 @@ def clear(
                     product,
                 )
             )
-        return accepted_orders, rejected_orders, meta
+        return accepted_orders, rejected_orders, meta, {}

emarketpy/clearing_algorithms/auctions.py

@@ -148,7 +148,7 @@ def clear(
                 )
             )
 
-        return accepted_orders, rejected_orders, meta
+        return accepted_orders, rejected_orders, meta, {}
 
 
 class PayAsBidRole(MarketRole):
@@ -275,4 +275,4 @@ def clear(
                     product,
                 )
             )
-        return accepted_orders, rejected_orders, meta
+        return accepted_orders, rejected_orders, meta, {}

emarketpy/clearing_algorithms/complex_clearing.py

@@ -510,7 +510,7 @@ def clear(
 
         self.all_orders = []
 
-        return accepted_orders, rejected_orders, meta
+        return accepted_orders, rejected_orders, meta, {}
 
 
 def calculate_order_surplus(
@@ -701,4 +701,4 @@ def extract_results(
                 }
             )
 
-    return accepted_orders, rejected_orders, meta
+    return accepted_orders, rejected_orders, meta, {}

emarketpy/clearing_algorithms/contracts.py

@@ -264,7 +264,7 @@ def clear(
                 )
 
         # contract clearing (pay_as_bid) takes place
-        return accepted_orders, rejected_orders, meta
+        return accepted_orders, rejected_orders, meta, {}
 
     async def execute_contract(self, contract: Order):
         """

emarketpy/clearing_algorithms/nodal_pricing.py

@@ -173,7 +173,7 @@ def clear(
                 calculate_network_meta(network=nodal_network, product=product, i=i)
             )
 
-        return accepted_orders, rejected_orders, meta
+        return accepted_orders, rejected_orders, meta, {}
 
     def process_dispatch_data(self, network: pypsa.Network, orderbook_df: pd.DataFrame):
         """

emarketpy/clearing_algorithms/redispatch.py

@@ -215,7 +215,7 @@ def clear(
                 calculate_network_meta(network=redispatch_network, product=product, i=i)
             )
 
-        return accepted_orders, rejected_orders, meta
+        return accepted_orders, rejected_orders, meta, {}
 
     def process_dispatch_data(self, network: pypsa.Network, orderbook_df: pd.DataFrame):
         """

emarketpy/clearing_algorithms/simple.py

@@ -192,7 +192,7 @@ def clear(
                 )
             )
 
-        return accepted_orders, rejected_orders, meta
+        return accepted_orders, rejected_orders, meta, {}
 
 
 class PayAsClearRole(QuasiUniformPricingRole):
@@ -509,4 +509,4 @@ def clear(
                     product,
                 )
             )
-        return accepted_orders, rejected_orders, meta
+        return accepted_orders, rejected_orders, meta, {}