Comment the constructor

This commit is contained in:
Alireza Adli 2024-10-14 11:04:57 -04:00
parent 674e24997c
commit 5b8ddc742a

View File

@ -33,8 +33,25 @@ class LCACarbonWorkflow:
constructions_catalog_file,
catalog='nrcan',
building_parameters=('height', 'year_of_construction', 'function')):
self.file_path = Path(__file__).parent / 'input_files' / \
InputGeoJsonContent(city_path).content
"""
LCACarbonWorkflow takes a number of buildings and enrich the city object
using cerc-hub GeometryFactory and ConstructionFactory. Then it
calculates embodied and end of life carbon emission of each building.
It puts out the results of opening and envelop emission for each
mentioned cycle separately.
:param city_path: Either a path to the buildings (GeoJson)
file or the content of such a file.
:param archetypes_catalog_file_name: Path to the buildings'
archetypes (JSON).
:param constructions_catalog_file: Path to the construction materials
data.
:param catalog: Type of the catalog (in this case 'nrcan', the default
argument)
:param building_parameters: Parameters used for using the catalog (in
this case three default arguments)
"""
self.file_path = Path(__file__).parent / 'input_files' / InputGeoJsonContent(
city_path).content
self.catalogs_path = Path(__file__).parent / 'input_files'
self.archetypes_catalog_file_name = archetypes_catalog_file_name
self.constructions_catalog_file = constructions_catalog_file