Correct headers to match coding style guide

README.md

@@ -1,6 +1,9 @@
-# costs
+# Cerc costs 
 
-This module processes the object-oriented generalization for the cost workflow
+Uses the cerc-hub as a base for cost calculation, it's intended to be used after executing the complete monthly energy
+balance workflow called building by building
+
+This module processes the object-oriented generalization to be used the cost workflow
 
 # installation
 
@@ -8,4 +11,21 @@ This module processes the object-oriented generalization for the cost workflow
 
 # usage
 
-> TBD
+> from costs.cost import Cost
+>
+> Cost(building, retrofit_scenario=[scenario]>).life_cycle
+> 
+
+The available scenarios are defined in the constant class as an enum
+
+> # constants
+> CURRENT_STATUS = 0
+> 
+> SKIN_RETROFIT = 1
+> 
+> SYSTEM_RETROFIT_AND_PV = 2
+> 
+> SKIN_RETROFIT_AND_SYSTEM_RETROFIT_AND_PV = 3
+> 
+> RETROFITTING_SCENARIOS = [CURRENT_STATUS, SKIN_RETROFIT, SYSTEM_RETROFIT_AND_PV, SKIN_RETROFIT_AND_SYSTEM_RETROFIT_AND_PV]
+>

costs/README.md

@@ -1,4 +0,0 @@
-# Cerc costs 
-
-Uses the cerc-hub as a base for cost calculation, it's intended to be used after executing the complete monthly energy
-balance workflow called building by building

costs/__init__.py

@@ -1,5 +1,9 @@
 """
 Cost workflow initialization
+SPDX - License - Identifier: LGPL - 3.0 - or -later
+Copyright © 2023 Project Coder Guille Gutierrez guillermo.gutierrezmorote@concordia.ca
+Code contributor Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
+Code contributor Oriol Gavalda Torrellas oriol.gavalda@concordia.ca
 """
 from .capital_costs import CapitalCosts
 from .end_of_life_costs import EndOfLifeCosts

costs/__main__.py

@@ -1,6 +1,6 @@
 """
 Costs Workflow
 SPDX - License - Identifier: LGPL - 3.0 - or -later
-Copyright © 2022 Project Author Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
+Copyright © 2023 Project Author Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
 Code contributor Oriol Gavalda Torrellas oriol.gavalda@concordia.ca
 """

costs/capital_costs.py

@@ -1,5 +1,9 @@
 """
 Capital costs module
+SPDX - License - Identifier: LGPL - 3.0 - or -later
+Copyright © 2023 Project Coder Guille Gutierrez guillermo.gutierrezmorote@concordia.ca
+Code contributor Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
+Code contributor Oriol Gavalda Torrellas oriol.gavalda@concordia.ca
 """
 import math
 

costs/configuration.py

@@ -1,5 +1,9 @@
 """
 Configuration module
+SPDX - License - Identifier: LGPL - 3.0 - or -later
+Copyright © 2023 Project Coder Guille Gutierrez guillermo.gutierrezmorote@concordia.ca
+Code contributor Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
+Code contributor Oriol Gavalda Torrellas oriol.gavalda@concordia.ca
 """
 from hub.catalog_factories.costs_catalog_factory import CostsCatalogFactory
 from hub.catalog_factories.catalog import Catalog

costs/constants.py

@@ -1,5 +1,9 @@
 """
 Constants module
+SPDX - License - Identifier: LGPL - 3.0 - or -later
+Copyright © 2023 Project Coder Guille Gutierrez guillermo.gutierrezmorote@concordia.ca
+Code contributor Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
+Code contributor Oriol Gavalda Torrellas oriol.gavalda@concordia.ca
 """
 
 # constants

costs/cost.py

@@ -1,5 +1,9 @@
 """
 Cost module
+SPDX - License - Identifier: LGPL - 3.0 - or -later
+Copyright © 2023 Project Coder Guille Gutierrez guillermo.gutierrezmorote@concordia.ca
+Code contributor Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
+Code contributor Oriol Gavalda Torrellas oriol.gavalda@concordia.ca
 """
 import pandas as pd
 import numpy_financial as npf

costs/cost_base.py

@@ -1,5 +1,9 @@
 """
 Cost base module
+SPDX - License - Identifier: LGPL - 3.0 - or -later
+Copyright © 2023 Project Coder Guille Gutierrez guillermo.gutierrezmorote@concordia.ca
+Code contributor Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
+Code contributor Oriol Gavalda Torrellas oriol.gavalda@concordia.ca
 """
 
 from hub.city_model_structure.building import Building

costs/end_of_life_costs.py

@@ -1,5 +1,9 @@
 """
 End of life costs module
+SPDX - License - Identifier: LGPL - 3.0 - or -later
+Copyright © 2023 Project Coder Guille Gutierrez guillermo.gutierrezmorote@concordia.ca
+Code contributor Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
+Code contributor Oriol Gavalda Torrellas oriol.gavalda@concordia.ca
 """
 import math
 import pandas as pd

costs/peak_load.py

@@ -1,15 +1,29 @@
+"""
+Peak load module
+SPDX - License - Identifier: LGPL - 3.0 - or -later
+Copyright © 2023 Project Coder Guille Gutierrez guillermo.gutierrezmorote@concordia.ca
+Code contributor Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
+Code contributor Oriol Gavalda Torrellas oriol.gavalda@concordia.ca
+"""
+
 import pandas as pd
 
 import hub.helpers.constants as cte
 
 
 class PeakLoad:
+  """
+  Peak load class
+  """
 
   def __init__(self, building):
     self._building = building
 
   @property
   def electricity_peak_load(self):
+    """
+    Get the electricity peak load in W
+    """
     array = [None] * 12
     heating = 0
     cooling = 0

costs/total_maintenance_costs.py

@@ -1,5 +1,9 @@
 """
 Total maintenance costs module
+SPDX - License - Identifier: LGPL - 3.0 - or -later
+Copyright © 2023 Project Coder Guille Gutierrez guillermo.gutierrezmorote@concordia.ca
+Code contributor Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
+Code contributor Oriol Gavalda Torrellas oriol.gavalda@concordia.ca
 """
 import math
 import pandas as pd

costs/total_operational_costs.py

@@ -1,5 +1,9 @@
 """
 Total operational costs module
+SPDX - License - Identifier: LGPL - 3.0 - or -later
+Copyright © 2023 Project Coder Guille Gutierrez guillermo.gutierrezmorote@concordia.ca
+Code contributor Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
+Code contributor Oriol Gavalda Torrellas oriol.gavalda@concordia.ca
 """
 import math
 import pandas as pd

costs/total_operational_incomes.py

@@ -1,5 +1,9 @@
 """
 Total operational incomes module
+SPDX - License - Identifier: LGPL - 3.0 - or -later
+Copyright © 2023 Project Coder Guille Gutierrez guillermo.gutierrezmorote@concordia.ca
+Code contributor Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
+Code contributor Oriol Gavalda Torrellas oriol.gavalda@concordia.ca
 """
 import math
 import pandas as pd

costs/version.py

@@ -1,4 +1,8 @@
 """
 Cost version number
+SPDX - License - Identifier: LGPL - 3.0 - or -later
+Copyright © 2023 Project Coder Guille Gutierrez guillermo.gutierrezmorote@concordia.ca
+Code contributor Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
+Code contributor Oriol Gavalda Torrellas oriol.gavalda@concordia.ca
 """
 __version__ = '0.1.0.0'