diff --git a/README.md b/README.md index a31ed7e..ce05dc7 100644 --- a/README.md +++ b/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 \ No newline at end of file +> 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] +> diff --git a/costs/README.md b/costs/README.md deleted file mode 100644 index bae8105..0000000 --- a/costs/README.md +++ /dev/null @@ -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 diff --git a/costs/__init__.py b/costs/__init__.py index a388181..26cf04b 100644 --- a/costs/__init__.py +++ b/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 diff --git a/costs/__main__.py b/costs/__main__.py index 87e2e44..097faa8 100644 --- a/costs/__main__.py +++ b/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 """ diff --git a/costs/capital_costs.py b/costs/capital_costs.py index 7c6049c..3dc7933 100644 --- a/costs/capital_costs.py +++ b/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 diff --git a/costs/configuration.py b/costs/configuration.py index c61813d..f868da7 100644 --- a/costs/configuration.py +++ b/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 diff --git a/costs/constants.py b/costs/constants.py index 15b0ff6..cbf11e5 100644 --- a/costs/constants.py +++ b/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 diff --git a/costs/cost.py b/costs/cost.py index fee9af7..9780e41 100644 --- a/costs/cost.py +++ b/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 diff --git a/costs/cost_base.py b/costs/cost_base.py index 16b74ef..e6aeb13 100644 --- a/costs/cost_base.py +++ b/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 diff --git a/costs/end_of_life_costs.py b/costs/end_of_life_costs.py index 4723300..f7d0d63 100644 --- a/costs/end_of_life_costs.py +++ b/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 diff --git a/costs/peak_load.py b/costs/peak_load.py index 2097ced..dc46d14 100644 --- a/costs/peak_load.py +++ b/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 diff --git a/costs/total_maintenance_costs.py b/costs/total_maintenance_costs.py index 8e7f01a..081df44 100644 --- a/costs/total_maintenance_costs.py +++ b/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 diff --git a/costs/total_operational_costs.py b/costs/total_operational_costs.py index 82674c4..dece3fb 100644 --- a/costs/total_operational_costs.py +++ b/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 diff --git a/costs/total_operational_incomes.py b/costs/total_operational_incomes.py index 512db8c..474d26b 100644 --- a/costs/total_operational_incomes.py +++ b/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 diff --git a/costs/version.py b/costs/version.py index 04b8b73..5552889 100644 --- a/costs/version.py +++ b/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'