From 34477c6d8f09b3b78a9aa33e2f620d84fc43e5d6 Mon Sep 17 00:00:00 2001
From: Pilar <pilar_monsalvete@yahoo.es>
Date: Mon, 13 Mar 2023 18:23:35 -0400
Subject: [PATCH] updating costs catalog -> not completed

---
 .../cost/montreal_custom_catalog.py           |   3 +-
 .../data_models/cost/shell.py                 |  64 +++++
 hub/data/costs/montreal_costs.xml             | 233 +++++++++++++-----
 3 files changed, 243 insertions(+), 57 deletions(-)
 create mode 100644 hub/catalog_factories/data_models/cost/shell.py

diff --git a/hub/catalog_factories/cost/montreal_custom_catalog.py b/hub/catalog_factories/cost/montreal_custom_catalog.py
index d4cf0c10..e86fd3cd 100644
--- a/hub/catalog_factories/cost/montreal_custom_catalog.py
+++ b/hub/catalog_factories/cost/montreal_custom_catalog.py
@@ -2,8 +2,7 @@
 Cost catalog
 SPDX - License - Identifier: LGPL - 3.0 - or -later
 Copyright © 2022 Concordia CERC group
-Project Coder Atiya atiya.atiya@mail.concordia.ca
-Code contributors: Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
+Project Coder Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
 """
 
 import xmltodict
diff --git a/hub/catalog_factories/data_models/cost/shell.py b/hub/catalog_factories/data_models/cost/shell.py
new file mode 100644
index 00000000..d0465fd2
--- /dev/null
+++ b/hub/catalog_factories/data_models/cost/shell.py
@@ -0,0 +1,64 @@
+"""
+Shell costs from Cost catalog
+SPDX - License - Identifier: LGPL - 3.0 - or -later
+Copyright © 2023 Concordia CERC group
+Project Coder Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
+"""
+
+
+class Shell:
+  def __init__(self, refurbishment_basement, envelope, roofing):
+    self._opaque_reposition = opaque_reposition
+    self._opaque_initial_investment = opaque_initial_investment
+    self._opaque_lifetime = opaque_lifetime
+    self._transparent_reposition = transparent_reposition
+    self._transparent_initial_investment = transparent_initial_investment
+    self._transparent_lifetime = transparent_lifetime
+
+  @property
+  def opaque_reposition(self):
+    """
+    Get reposition costs for opaque envelope per area of external opaque surfaces in currency/m2
+    :return: float
+    """
+    return self._opaque_reposition
+
+  @property
+  def opaque_initial_investment(self):
+    """
+    Get initial investment for opaque envelope per area of external opaque surfaces in currency/m2
+    :return: float
+    """
+    return self._opaque_initial_investment
+
+  @property
+  def opaque_lifetime(self):
+    """
+    Get lifetime of opaque envelope in years
+    :return: float
+    """
+    return self._opaque_lifetime
+
+  @property
+  def transparent_reposition(self):
+    """
+    Get reposition costs for transparent envelope per area of windows in currency/m2
+    :return: float
+    """
+    return self._transparent_reposition
+
+  @property
+  def transparent_initial_investment(self):
+    """
+    Get initial investment for transparent envelope per area of windows in currency/m2
+    :return: float
+    """
+    return self._transparent_initial_investment
+
+  @property
+  def transparent_lifetime(self):
+    """
+    Get lifetime of transparent envelope in years
+    :return: float
+    """
+    return self._transparent_lifetime
diff --git a/hub/data/costs/montreal_costs.xml b/hub/data/costs/montreal_costs.xml
index 8cb0f0da..5853cbf1 100644
--- a/hub/data/costs/montreal_costs.xml
+++ b/hub/data/costs/montreal_costs.xml
@@ -1,71 +1,196 @@
 <archetypes>
     <archetype function="residential" municipality="montreal" currency="CAD">
         <capital_cost>
-            <structural cost_unit="currency/m3">     56          </structural>
-            <sub_structural cost_unit="currency/m2">     9.8      </sub_structural>
-            <envelope>
-                <opaque>
-                    <reposition cost_unit="currency/m2">           43.4     </reposition>
-                    <initial_investment cost_unit="currency/m2">    36    </initial_investment>
-                    <lifetime_equipment lifetime="years">       50         </lifetime_equipment>
-                </opaque>
-                <transparent>
-                    <reposition cost_unit="currency/m2">         78       </reposition>
-                    <initial_investment cost_unit="currency/m2">  984.5      </initial_investment>
-                    <lifetime_equipment lifetime="years">       20         </lifetime_equipment>
-                </transparent>
-            </envelope>
-            <systems>
-                <hvac>
-                    <heating_equipment_cost>
-                        <initial_investment cost_unit="currency/kW">  363.5      </initial_investment>
-                        <reposition cost_unit="currency/kW">       363.5        </reposition>
+            <B_shell>
+                <B10_superstructure>
+                    <refurbishment_cost_basement cost_unit="currency/m2">           0     </refurbishment_cost_basement>
+                </B10_superstructure>
+                <B20_envelope>
+                    <B2010_opaque_walls>
+                        <refurbishment_cost cost_unit="currency/m2">           304     </refurbishment_cost>
+                    </B2010_opaque_walls>
+                    <B2020_transparent>
+                        <refurbishment_cost cost_unit="currency/m2">         857.14       </refurbishment_cost>
+                    </B2020_transparent>
+                </B20_envelope>
+                <B30_roofing>
+                    <B3010_opaque_roof>
+                        <refurbishment_cost cost_unit="currency/m2">           118 </refurbishment_cost>
+                    </B3010_opaque_roof>
+                </B30_roofing>
+            </B_shell>
+            <D_services>
+                <D30_hvac>
+                    <D3010_energy_supply>
+                        <D301010_photovoltaic_system>
+                            <initial_investment cost_unit="currency/m2">    800    </initial_investment>
+                            <reposition cost_unit="currency/m2">       800         </reposition>
+                            <lifetime_equipment lifetime="years">       25         </lifetime_equipment>
+                        </D301010_photovoltaic_system>
+                    </D3010_energy_supply>
+                    <D3020_heat_generating_systems>
+                        <investment_cost cost_unit="currency/kW">  622.86      </investment_cost>
+                        <reposition cost_unit="currency/kW">       622.86       </reposition>
+                        <lifetime_equipment lifetime="years">       25         </lifetime_equipment>
+                    </D3020_heat_generating_systems>
+                    <D3030_cooling_generation_systems>
+                        <investment_cost cost_unit="currency/kW">  622.86      </investment_cost>
+                        <reposition cost_unit="currency/kW">       622.86       </reposition>
                         <lifetime_equipment lifetime="years">       15         </lifetime_equipment>
-                    </heating_equipment_cost>
-                    <cooling_equipment_cost>
-                        <initial_investment cost_unit="currency/kW">  363.5      </initial_investment>
-                        <reposition cost_unit="currency/kW">       363.5         </reposition>
+                    </D3030_cooling_generation_systems>
+                    <D3040_distribution_systems>
+                        <investment_cost cost_unit="currency/kW">  0      </investment_cost>
+                        <reposition cost_unit="currency/kW">       0       </reposition>
                         <lifetime_equipment lifetime="years">       15         </lifetime_equipment>
-                    </cooling_equipment_cost>
-                    <general_hvac_equipment_cost>
-                        <initial_investment cost_unit="currency/(m3/h)">  363.5      </initial_investment>
-                        <reposition cost_unit="currency/(m3/h)">       363.5         </reposition>
+                    </D3040_distribution_systems>
+                    <D3080_other_hvac_ahu>
+                        <investment_cost cost_unit="currency/kW">  47.62      </investment_cost>
+                        <reposition cost_unit="currency/kW">      47.62       </reposition>
                         <lifetime_equipment lifetime="years">       15         </lifetime_equipment>
-                    </general_hvac_equipment_cost>
-                </hvac>
-                <photovoltaic_system>
-                    <initial_investment cost_unit="currency/m2">    17    </initial_investment>
-                    <reposition cost_unit="currency/m2">       17         </reposition>
-                    <lifetime_equipment lifetime="years">       15         </lifetime_equipment>
-                </photovoltaic_system>
-                <other_systems>
-                    <initial_investment cost_unit="currency/m2">   365     </initial_investment>
-                    <reposition cost_unit="currency/m2">         365       </reposition>
-                    <lifetime_equipment lifetime="years">       15         </lifetime_equipment>
-                </other_systems>
-                <lighting>
-                    <initial_investment cost_unit="currency/m2">   365     </initial_investment>
-                    <reposition cost_unit="currency/m2">         365       </reposition>
-                    <lifetime_equipment lifetime="years">       15         </lifetime_equipment>
-                </lighting>
-            </systems>
-            <surface_finish cost_unit="currency/m2">   88        </surface_finish>
-            <engineer cost_unit="%">       2.5         </engineer>
+                    </D3080_other_hvac_ahu>
+                </D30_hvac>
+                <D50_electrical>
+                    <D5020lighting_and_branch_wiring>
+                        <refurbishment_cost cost_unit="currency/kW">  139      </refurbishment_cost>
+                        <reposition cost_unit="currency/kW">       139       </reposition>
+                        <lifetime_equipment lifetime="years">       20         </lifetime_equipment>
+                    </D5020lighting_and_branch_wiring>
+                </D50_electrical>
+            </D_services>
+            <Z_allowances_overhead_profit>
+                <Z10_design_allowance cost_unit="%">       2.5         </Z10_design_allowance>
+                <Z10_overhead_and_profit cost_unit="%">       14         </Z10_overhead_and_profit>
+            </Z_allowances_overhead_profit>
         </capital_cost>
         <operational_cost>
             <fuel  fuel_type="electricity">
                 <fixed>
-					<fixed_monthly cost_unit="currency/month">      0 </fixed_monthly> 
-					<fixed_power cost_unit="currency/kW">      0  </fixed_power>
+					<fixed_monthly cost_unit="currency/month">     12.27 </fixed_monthly>
+                    <fixed_power cost_unit="currency/month*kW">     0 </fixed_power>
 				</fixed>
-                <variable cost_unit="currency/kWh">      5.6  </variable>
+                <variable cost_unit="currency/kWh">      0.075  </variable>
+            </fuel>
+            <fuel  fuel_type="gas">
+                <fixed>
+					<fixed_monthly cost_unit="currency/month">     17.71 </fixed_monthly>
+				</fixed>
+                <variable cost_unit="currency/kWh">      0.640  </variable>
+            </fuel>
+            <fuel  fuel_type="diesel">
+                <variable cost_unit="currency/l">      1.2  </variable>
+            </fuel>
+            <fuel  fuel_type="biomass">
+                <variable cost_unit="currency/kg">      0.09  </variable>
+            </fuel>
+            <maintenance>
+                <heating_equipment cost_unit="currency/kW">      40     </heating_equipment>
+                <cooling_equipment cost_unit="currency/kW">      40     </cooling_equipment>
+                <photovoltaic_system cost_unit="currency/m2">      1     </photovoltaic_system>
+            </maintenance>
+            <co2_cost cost_unit="currency/kgCO2">         30          </co2_cost>
+        </operational_cost>
+        <end_of_life_cost cost_unit="currency/m2">           6.3           </end_of_life_cost>
+        <incomes>
+            <subsidies>
+                <construction_subsidy cost_unit="%">  2    </construction_subsidy>
+                <hvac_subsidy cost_unit="%">       1.5       </hvac_subsidy>
+                <photovoltaic_subsidy cost_unit="%">        3.6        </photovoltaic_subsidy>
+            </subsidies>
+            <energy_exports>
+                <electricity cost_unit="currency/kWh">     0   </electricity>
+            </energy_exports>
+            <tax_reductions>
+                <reductions_taxes cost_unit="%">  2   </reductions_taxes>
+            </tax_reductions>
+        </incomes>
+    </archetype>
+    <archetype function="non-residential" municipality="montreal" currency="CAD">
+        <capital_cost>
+            <B_shell>
+                <B10_superstructure>
+                    <refurbishment_cost_basement cost_unit="currency/m2">           0     </refurbishment_cost_basement>
+                </B10_superstructure>
+                <B20_envelope>
+                    <B2010_opaque_walls>
+                        <refurbishment_cost cost_unit="currency/m2">           304     </refurbishment_cost>
+                    </B2010_opaque_walls>
+                    <B2020_transparent>
+                        <refurbishment_cost cost_unit="currency/m2">         857.14       </refurbishment_cost>
+                    </B2020_transparent>
+                </B20_envelope>
+                <B30_roofing>
+                    <B3010_opaque_roof>
+                        <refurbishment_cost cost_unit="currency/m2">           118 </refurbishment_cost>
+                    </B3010_opaque_roof>
+                </B30_roofing>
+            </B_shell>
+            <D_services>
+                <D30_hvac>
+                    <D3010_energy_supply>
+                        <D301010_photovoltaic_system>
+                            <initial_investment cost_unit="currency/m2">    800    </initial_investment>
+                            <reposition cost_unit="currency/m2">       800         </reposition>
+                            <lifetime_equipment lifetime="years">       25         </lifetime_equipment>
+                        </D301010_photovoltaic_system>
+                    </D3010_energy_supply>
+                    <D3020_heat_generating_systems>
+                        <investment_cost cost_unit="currency/kW">  622.86      </investment_cost>
+                        <reposition cost_unit="currency/kW">       622.86       </reposition>
+                        <lifetime_equipment lifetime="years">       25         </lifetime_equipment>
+                    </D3020_heat_generating_systems>
+                    <D3030_cooling_generation_systems>
+                        <investment_cost cost_unit="currency/kW">  622.86      </investment_cost>
+                        <reposition cost_unit="currency/kW">       622.86       </reposition>
+                        <lifetime_equipment lifetime="years">       15         </lifetime_equipment>
+                    </D3030_cooling_generation_systems>
+                    <D3040_distribution_systems>
+                        <refurbishment_cost cost_unit="currency/m2">  0      </refurbishment_cost>
+                        <reposition cost_unit="currency/kW">       0       </reposition>
+                        <lifetime_equipment lifetime="years">       15         </lifetime_equipment>
+                    </D3040_distribution_systems>
+                    <D3080_other_hvac_ahu>
+                        <investment_cost cost_unit="currency/kW">  47.62      </investment_cost>
+                        <reposition cost_unit="currency/kW">      47.62       </reposition>
+                        <lifetime_equipment lifetime="years">       15         </lifetime_equipment>
+                    </D3080_other_hvac_ahu>
+                </D30_hvac>
+                <D50_electrical>
+                    <D5020_lighting_and_branch_wiring>
+                        <refurbishment_cost cost_unit="currency/kW">  139      </refurbishment_cost>
+                        <reposition cost_unit="currency/kW">       139       </reposition>
+                        <lifetime_equipment lifetime="years">       20         </lifetime_equipment>
+                    </D5020_lighting_and_branch_wiring>
+                </D50_electrical>
+            </D_services>
+            <Z_allowances_overhead_profit>
+                <Z10_design_allowance cost_unit="%">       6         </Z10_design_allowance>
+                <Z20_overhead_profit cost_unit="%">       14         </Z20_overhead_profit>
+            </Z_allowances_overhead_profit>
+        </capital_cost>
+        <operational_cost>
+            <fuel  fuel_type="electricity">
+                <fixed>
+					<fixed_monthly cost_unit="currency/month">     12.27 </fixed_monthly>
+                    <fixed_power cost_unit="currency/(month*kW)">     0 </fixed_power>
+				</fixed>
+                <variable cost_unit="currency/kWh">      0.075  </variable>
+            </fuel>
+            <fuel  fuel_type="gas">
+                <fixed>
+					<fixed_monthly cost_unit="currency/month">     17.71 </fixed_monthly>
+				</fixed>
+                <variable cost_unit="currency/m3">      0.640  </variable>
+            </fuel>
+            <fuel  fuel_type="diesel">
+                <variable cost_unit="currency/l">      1.2  </variable>
+            </fuel>
+            <fuel  fuel_type="biomass">
+                <variable cost_unit="currency/kg">      0.09  </variable>
             </fuel>
             <maintenance>
                 <heating_equipment cost_unit="currency/kW">      40     </heating_equipment>
                 <cooling_equipment cost_unit="currency/kW">      40     </cooling_equipment>
-                <general_hvac_equipment cost_unit="currency/(m3/h)">      0.05     </general_hvac_equipment>
                 <photovoltaic_system cost_unit="currency/m2">      1     </photovoltaic_system>
-                <other_systems cost_unit="currency/m2">  4.6    </other_systems>
             </maintenance>
             <CO2_cost cost_unit="currency/kgCO2">         30          </CO2_cost>
         </operational_cost>
@@ -78,12 +203,10 @@
             </subsidies>
             <energy_exports>
                 <electricity cost_unit="currency/kWh">     0   </electricity>
-                <heat cost_unit="currency/kWh">     0   </heat>
             </energy_exports>
             <tax_reductions>
                 <reductions_taxes cost_unit="%">  2   </reductions_taxes>
             </tax_reductions>
-			<CO2_income cost_unit="currency/kgCO2exported">     0   </CO2_income>
         </incomes>
     </archetype>
-</archetypes>
+</archetypes>
\ No newline at end of file