2.51.11 release; new TEA tables

Author: yoelcortes

Bioindustrial-Park

@@ -13,7 +13,7 @@
 
 """
 from __future__ import annotations
-__version__ = '2.51.10'
+__version__ = '2.51.11'
 
 #: Chemical engineering plant cost index (defaults to 567.5 at 2017).
 CE: float = 567.5 

biosteam/__init__.py

@@ -380,6 +380,41 @@ class TEA:
         'India': 0.85,
     }
 
+    class Accounting:
+        __slots__ = ('index', 'data', 'names', 'units')
+        
+        def __init__(self, units, names=None):
+            self.units = units
+            self.names = names
+            self.index = []
+            self.data =[]
+        
+        def entry(self, index: str, cost: list|float, notes: str = ''):
+            self.index.append(index)
+            if getattr(cost, 'ndim') == 0: cost = float(cost)
+            if isinstance(cost, (float, int, str)):
+                self.data.append([notes, cost])
+            else:
+                self.data.append([notes, *cost])
+
+        @property
+        def total_costs(self):
+            if self.names is None:
+                return sum([i[1] for i in self.data])
+            else:
+                N = len(self.data[0])
+                return [sum([i[index] for i in self.data]) for index in range(1, N)]
+        
+        def table(self):
+            names = self.names
+            units = self.units
+            index = self.index
+            return pd.DataFrame(
+                self.data, 
+                index=pd.MultiIndex.from_tuples(index) if isinstance(index[0], tuple) else index,
+                columns=('Notes', f'Cost [{units}]') if names is None else ('Notes', [f'{i}\n[{units}]' for i in names]),
+            )
+
     def __init_subclass__(cls, isabstract=False):
         if isabstract: return
         for method in ('_DPI', '_TDC', '_FCI', '_FOC'):
@@ -995,6 +1030,21 @@ def solve_price(self, streams: bst.Stream|Collection[bst.Stream]):
             current_price = sum([system.get_market_value(i) for i in streams]) / abs(price2cost)
         return current_price + sales / price2cost 
 
+    def VOC_table(
+            self, products, functional_unit='MT', with_products=False, 
+        ):
+        return bst.report.voc_table(
+            [self.system], products, 
+            system_names=None, functional_unit=functional_unit,
+            with_products=with_products, dataframe=True
+        )
+        
+    def CAPEX_table(self):
+        return NotImplemented
+    
+    def FOC_table(self):
+        return NotImplemented
+    
     def solve_sales(self):
         """
         Return the required additional sales [USD] to reach the breakeven 

biosteam/_tea.py

@@ -1412,10 +1412,11 @@ def addcapex(key):
                     addkey(('Design', ki))
                     if ki in units:
                         ui = units[ki]
-                        q = Quantity(vi, ui)
-                        q = q.to_base_units()
-                        vi = q.magnitude
-                        ui = q.units
+                        if ui != 'hr':
+                            q = Quantity(vi, ui)
+                            q = q.to_base_units()
+                            vi = q.magnitude
+                            ui = q.units
                     else:
                         ui = ''
                     addval((ui, vi))

biosteam/_unit.py

@@ -13,7 +13,7 @@
 def element_name(element):
     if element:
         if isinstance(element, str):
-            return format_title(element)
+            return element
         elif hasattr(element, 'line'):
             return element.line + '-' + format_title(str(element))
         else:

biosteam/evaluation/_name.py

@@ -37,7 +37,7 @@ def _reformat(name):
     if name.islower(): name= name.capitalize()
     return name
 
-# %% Detailed TEA tables
+# %%
 
 class FOCTableBuilder:
     __slots__ = ('index', 'data', 'costs')
@@ -52,30 +52,37 @@ def entry(self, index, costs, notes='-'):
         self.data.append([notes, *costs])
         self.costs.append(costs)
 
-    def table(self, names):
+    def table(self, names, dataframe=True):
         data = self.data
         index = self.index.copy()
         index.append('Fixed operating cost (FOC)')
         data.append(("", *sum(self.costs)))
-        return pd.DataFrame(np.array(data), 
-                            index=index,
-                            columns=(
-                                'Notes',
-                                *[i + '\n[MM$ / yr]' for i in names],
-                            )
-        )
-
+        columns = ('Notes', *[i + '\n[MM$ / yr]' for i in names])
+        if dataframe:
+            return pd.DataFrame(
+                np.array(data), 
+                index=index,
+                columns=columns,
+            )
+        else:
+            return data, index, columns
+        
 # %% Multiple system tables
 
-def voc_table(systems, product_IDs, system_names=None, unit='MT', with_products=False):
+def voc_table(
+        systems, product_IDs, 
+        system_names=None, functional_unit='MT',
+        with_products=False, dataframe=True
+    ):
     # Not ready for users yet
     isa = isinstance
     if isa(systems, bst.System): systems = [systems]
     if isa(product_IDs, str): product_IDs = [product_IDs]
+    product_IDs = [(i.ID if hasattr(i, 'ID') else i) for i in product_IDs]
     inlet_cost_dct = {}
     outlet_revenue_dct = {}
     prices = bst.stream_prices
-    factor = 1 / tmo.units_of_measure.convert(1, 'kg', unit)
+    factor = 1 / tmo.units_of_measure.convert(1, 'kg', functional_unit)
 
     def getsubdct(dct, name):
         if name in dct:
@@ -166,11 +173,17 @@ def reformat(name):
     VOC_index = N_rows - N_products - 1
     data[VOC_index, 1:] = data[:N_consumed, 1:].sum(axis=0) - data[N_consumed:VOC_index, 1:].sum(axis=0)
     if system_names is None:
-        system_names = [i.ID for i in systems]
-    columns = [i + " [MM$/yr]" for i in system_names]
-    return pd.DataFrame(data, 
-                        index=pd.MultiIndex.from_tuples(table_index),
-                        columns=(f'Price [$/{unit}]', *columns))
+        if len(systems) == 1:
+            columns = ["Cost [MM$/yr]"]
+        else:
+            system_names = [i.ID for i in systems]
+            columns = [i + " [MM$/yr]" for i in system_names]
+    if dataframe:
+        return pd.DataFrame(data, 
+                            index=pd.MultiIndex.from_tuples(table_index),
+                            columns=(f'Price [$/{functional_unit}]', *columns))
+    else:
+        return data, table_index, (f'Price [$/{functional_unit}]', *columns)
 
 def lca_inventory_table(systems, key, items=(), system_names=None):
     isa = isinstance

biosteam/report/table.py

@@ -110,7 +110,7 @@ class HX(Unit, isabstract=True):
 
     @property
     def material(self):
-        """Default 'Carbon steel/carbon steel'"""
+        """Default 'Carbon steel/carbon steel'."""
         return self._material
 
     @material.setter

biosteam/units/heat_exchange.py

@@ -11,7 +11,7 @@
     name='biosteam',
     packages=['biosteam'],
     license='MIT',
-    version='2.51.10',
+    version='2.51.11',
     description='The Biorefinery Simulation and Techno-Economic Analysis Modules',
     long_description=open('README.rst', encoding='utf-8').read(),
     author='Yoel Cortes-Pena',