Correct the methods descriptions

This commit is contained in:
Alireza Adli 2024-12-01 12:09:12 -05:00
parent 4ba920668d
commit c3916853ea

View File

@ -3,8 +3,10 @@ lca_carbon_workflow module
Returns the summarize of envelope and energy systems Returns the summarize of envelope and energy systems
SPDX - License - Identifier: LGPL - 3.0 - or -later SPDX - License - Identifier: LGPL - 3.0 - or -later
Copyright © 2024 Concordia CERC group Copyright © 2024 Concordia CERC group
Project Developer: Alireza Adli alireza.adli@mail.concordia.ca Project Designer and Developer: Alireza Adli
Theoritical Support: Mohammad Reza Seyedabadi mohammad.seyedabadi@mail.concordia.ca alireza.adli@mail.concordia.ca
Theoritical Support for LCA emissions:
Mohammad Seyedabadi mohammad.seyedabadi@mail.concordia.ca
""" """
from pathlib import Path from pathlib import Path
@ -113,7 +115,7 @@ class LCACarbonWorkflow:
The building parameter comes from the calculate_emission() method The building parameter comes from the calculate_emission() method
which iterates through the city object buildings. which iterates through the city object buildings.
:param building: <class 'hub.city_model_structure.building.Building'> :param building: <class 'hub.city_model_structure.building.Building'>
:return: <class 'tuple'> :return: tuple
""" """
surface_envelope_emission = [] surface_envelope_emission = []
surface_opening_emission = [] surface_opening_emission = []
@ -178,7 +180,7 @@ class LCACarbonWorkflow:
:param boundary: <class :param boundary: <class
'hub.city_model_structure. 'hub.city_model_structure.
building_demand.thermal_boundary.ThermalBoundary'> building_demand.thermal_boundary.ThermalBoundary'>
:return: <class 'tuple'> :return: tuple
""" """
layer_emission = [] layer_emission = []
layer_end_of_life_emission = [] layer_end_of_life_emission = []
@ -223,12 +225,11 @@ class LCACarbonWorkflow:
:param building: <class 'hub.city_model_structure.building.Building'> :param building: <class 'hub.city_model_structure.building.Building'>
:param surface: <class :param surface: <class
'hub.city_model_structure.building_demand.surface.Surface'> 'hub.city_model_structure.building_demand.surface.Surface'>
:param boundary: <class :param boundary:
'hub.city_model_structure. hub.city_model_structure.building_demand.thermal_boundary.ThermalBoundary
building_demand.thermal_boundary.ThermalBoundary'> :param opaque_surface_code: str
:param opaque_surface_code: <class 'str'> :param density: int
:param density: <class 'int'> :return: tuple
:return: <class 'tuple'>
""" """
opening_emission = [] opening_emission = []
opening_end_of_life_emission = [] opening_end_of_life_emission = []