New metrics to return Transaction table with quantity in units of kg/GWe

cymetric/metrics.py

@@ -504,4 +504,47 @@ def inventory_quantity_per_gwe(expinv,power):
     inv.Quantity = inv.Quantity/inv.Value
     inv=inv.drop(['Value'],axis=1)
     return inv
+
+# Quantity per GigaWattElectric in TransactionQuantity [kg/GWe]
+_tranactsdeps = ['TransactionQuantity','TimeSeriesPower']
+
+_tranactsschema = [
+    ('SimId', ts.UUID),
+    ('TransactionId', ts.INT),
+    ('ResourceId', ts.INT),
+    ('ObjId', ts.INT),
+    ('Time', ts.INT),
+    ('SenderId', ts.INT),
+    ('ReceiverId', ts.INT),
+    ('Commodity', ts.STRING),
+    ('Units', ts.STRING),
+    ('Quantity', ts.DOUBLE)
+    ]
+
+
+@metric(name='TransactionQuantityPerGWe', depends=_tranactsdeps, schema=_tranactsschema)
+def transaction_quantity_per_gwe(tranacts, power):
+    """Transaction Quantity per GWe metric returns the transaction quantity table with quantity
+    in units of kg/GWe, calculated by dividing the original quantity by the electricity generated
+    at the corresponding simulation and the specific time in TimeSeriesPower metric.
+    """
+    power = power.groupby(['SimId','Time']).sum()
+    df1 = power.reset_index()
+    tranacts = pd.DataFrame(data={'SimId': tranacts.SimId,
+                                  'TransactionId': tranacts.TransactionId,
+                                  'ResourceId': tranacts.ResourceId,
+                                  'ObjId': tranacts.ObjId,
+                                  'Time': tranacts.TimeCreated,
+                                  'SenderId': tranacts.SenderId,
+                                  'ReceiverId': tranacts.ReceiverId,
+                                  'Commodity': tranacts.Commodity,
+                                  'Units': tranacts.Units,
+                                  'Quantity': tranacts.Quantity},
+                            columns=['SimId','TransactionId','ResourceId','ObjId','Time',
+                                     'SenderId','ReceiverId','Commodity','Units','Quantity'])
+    tranacts['Units'] = "kg/GWe"    
+    tranacts=pd.merge(tranacts,df1, on=['SimId','Time'],how='left')
+    tranacts.Quantity = tranacts.Quantity/tranacts.Value
+    return tranacts[['SimId','TransactionId','ResourceId','ObjId','Time',
+                     'SenderId','ReceiverId','Commodity','Units','Quantity']]
 

tests/test_metrics.py

@@ -396,6 +396,41 @@ def test_inventory_quantity_per_gwe():
     obs = metrics.inventory_quantity_per_gwe.func(inv, tsp)
     assert_frame_equal(exp, obs)
 
+
+def test_transaction_quantity_per_gwe():
+    #exp is the expected output metrics
+    exp = pd.DataFrame(np.array([
+        (UUID('f22f2281-2464-420a-8325-37320fd418f8'), 1, 7, 3, 3,  10, 20, 'LWR Fuel', 'kg/GWe', 0.82),
+        (UUID('f22f2281-2464-420a-8325-37320fd418f8'), 2, 8, 4, 3,  20, 30, 'FR Fuel', 'kg/GWe', 0.61),
+        (UUID('f22f2281-2464-420a-8325-37320fd418f8'), 3, 9, 5, 12, 30, 40, 'Spent Fuel', 'kg/GWe', 0.09),
+        ], dtype=ensure_dt_bytes([
+                ('SimId', 'O'), ('TransactionId', '<i8'), ('ResourceId', '<i8'),
+                ('ObjId', '<i8'), ('Time', '<i8'), ('SenderId', '<i8'),
+                ('ReceiverId', '<i8'), ('Commodity', 'O'), ('Units', 'O'),
+                ('Quantity', '<f8')]))
+        )
+    #tsp is the TimeSeriesPower metrics
+    tsp = pd.DataFrame(np.array([
+        (UUID('f22f2281-2464-420a-8325-37320fd418f8'), 1, 3, 225),
+        (UUID('f22f2281-2464-420a-8325-37320fd418f8'), 2, 3, 275),
+        (UUID('f22f2281-2464-420a-8325-37320fd418f8'), 1, 12, 100),
+        ], dtype=ensure_dt_bytes([
+                ('SimId', 'O'), ('AgentId', '<i8'), ('Time', '<i8'),
+                ('Value', '<f8')]))
+        )
+    #tranacts is the TransactionQuantity metrics
+    tranacts = pd.DataFrame(np.array([
+        (UUID('f22f2281-2464-420a-8325-37320fd418f8'), 1, 7, 3, 3,  10, 20, 'LWR Fuel', 'kg', 410),
+        (UUID('f22f2281-2464-420a-8325-37320fd418f8'), 2, 8, 4, 3,  20, 30, 'FR Fuel', 'kg', 305),
+        (UUID('f22f2281-2464-420a-8325-37320fd418f8'), 3, 9, 5, 12, 30, 40, 'Spent Fuel', 'kg', 9),
+        ], dtype=ensure_dt_bytes([
+                ('SimId', 'O'), ('TransactionId', '<i8'), ('ResourceId', '<i8'),
+                ('ObjId', '<i8'), ('TimeCreated', '<i8'), ('SenderId', '<i8'),
+                ('ReceiverId', '<i8'), ('Commodity', 'O'), ('Units', 'O'),
+                ('Quantity', '<f8')]))
+        )
+    obs = metrics.transaction_quantity_per_gwe.func(tranacts, tsp)
+    assert_frame_equal(exp, obs)
 
 if __name__ == "__main__":
     nose.runmodule()