Finalize comments

This commit is contained in:
Alireza Adli 2024-10-13 12:40:24 -04:00
parent b50724690f
commit 38c468b29b

View File

@ -143,7 +143,8 @@ class AccessNrcanCatalog:
def search_material(self, material_name):
"""
Brings up the material's embodied carbon based on material's name
Search materials and bring up the specific material data
based on the material's name
:param material_name: <class 'str'>
:return: <class 'dict'>
"""
@ -152,17 +153,24 @@ class AccessNrcanCatalog:
def search_transparent_surfaces(
self, surface_type, opaque_surface_code):
"""
:param surface_type:
:param opaque_surface_code:
:return:
Search transparent surfaces and bring up the specific surface data
based on its type and opaque surface code
:param surface_type: <class 'str'>
:param opaque_surface_code: <class 'str'>
:return: <class 'dict'>
"""
return self.transparent_surfaces[
f'{surface_type}_{opaque_surface_code}']
def find_opaque_surface(
self, function, period_of_construction, climate_zone):
"""Returns the opaque_surface_name corresponding to the given arguments."""
"""
Returns the opaque_surface_name based on the below parameters.
:param function: <class 'str'>
:param period_of_construction: <class 'str'>
:param climate_zone: <class 'str'>
:return: <class 'str'>
"""
for archetype in self.archetypes['archetypes']:
if archetype['function'] != function:
continue