diff --git a/city_model_structure/attributes/thermal_boundary.py b/city_model_structure/attributes/thermal_boundary.py index 110eb82f..1ba99e7c 100644 --- a/city_model_structure/attributes/thermal_boundary.py +++ b/city_model_structure/attributes/thermal_boundary.py @@ -2,9 +2,9 @@ ThermalBoundary module SPDX - License - Identifier: LGPL - 3.0 - or -later Copyright © 2020 Project Author Guille Gutierrez guillermo.gutierrezmorote@concordia.ca +Contributors Pilar Monsalvete pilar_monsalvete@yahoo.es """ from typing import List - from city_model_structure.attributes.layer import Layer from city_model_structure.attributes.thermal_opening import ThermalOpening from city_model_structure.attributes.thermal_zone import ThermalZone diff --git a/city_model_structure/attributes/thermal_opening.py b/city_model_structure/attributes/thermal_opening.py index 3ed23816..eb6f7114 100644 --- a/city_model_structure/attributes/thermal_opening.py +++ b/city_model_structure/attributes/thermal_opening.py @@ -2,6 +2,7 @@ ThermalOpening module SPDX - License - Identifier: LGPL - 3.0 - or -later Copyright © 2020 Project Author Guille Gutierrez guillermo.gutierrezmorote@concordia.ca +Contributors Pilar Monsalvete pilar_monsalvete@yahoo.es """ from helpers.configuration_helper import ConfigurationHelper diff --git a/city_model_structure/attributes/usage_zone.py b/city_model_structure/attributes/usage_zone.py index 83cf98c6..1f1b2b05 100644 --- a/city_model_structure/attributes/usage_zone.py +++ b/city_model_structure/attributes/usage_zone.py @@ -1,11 +1,10 @@ """ UsageZone module SPDX - License - Identifier: LGPL - 3.0 - or -later -Copyright © 2020 Project Author Guille Gutierrez guillermo.gutierrezmorote@concordia.ca -Contributors Pilar Monsalvete pilar_monsalvete@yahoo.es +Copyright © 2020 Project Author Pilar Monsalvete pilar_monsalvete@yahoo.es +Contributors Guille Gutierrez guillermo.gutierrezmorote@concordia.ca """ from typing import List - from city_model_structure.attributes.internal_gains import InternalGains from helpers.configuration_helper import ConfigurationHelper @@ -218,7 +217,6 @@ class UsageZone: @property def occupancy_density(self): - # todo: review units """ Get occupancy density in persons per m2 :return: float @@ -235,7 +233,6 @@ class UsageZone: @property def dhw_average_volume_pers_day(self): - # todo: review units """ Get average DHW consumption in liters per person per day :return: float @@ -252,7 +249,6 @@ class UsageZone: @property def dhw_preparation_temperature(self): - # todo: review units """ Get preparation temperature of the DHW in degree Celsius :return: float @@ -269,9 +265,8 @@ class UsageZone: @property def electrical_app_average_consumption_sqm_year(self): - # todo: review units """ - Get average consumption of electrical appliances in Watts per m2 and year + Get average consumption of electrical appliances in kiloWatts hour per m2 and year (kWh/m2yr) :return: float """ return self._electrical_app_average_consumption_sqm_year @@ -279,8 +274,7 @@ class UsageZone: @electrical_app_average_consumption_sqm_year.setter def electrical_app_average_consumption_sqm_year(self, values): """ - average consumption of electrical appliances in Watts per m2 and year + average consumption of electrical appliances in kiloWatts hour per m2 and year (kWh/m2yr) :param values: float """ self._electrical_app_average_consumption_sqm_year = values - diff --git a/city_model_structure/bixi_feature.py b/city_model_structure/bixi_feature.py index 69b2fa45..22d6c076 100644 --- a/city_model_structure/bixi_feature.py +++ b/city_model_structure/bixi_feature.py @@ -1,7 +1,7 @@ """ bixi_feature module SPDX - License - Identifier: LGPL - 3.0 - or -later -Copyright © 2020 Project Author Guille Gutierrez guillermo.gutierrezmorote@concordia.ca +Copyright © 2020 Project Author Pilar Monsalvete pilar_monsalvete@yahoo.es """ from city_model_structure.city_object import CityObject diff --git a/city_model_structure/building.py b/city_model_structure/building.py index 8ceb39c4..0f07c79a 100644 --- a/city_model_structure/building.py +++ b/city_model_structure/building.py @@ -12,8 +12,6 @@ import numpy as np from matplotlib import pylab from shapely import ops from shapely.geometry import MultiPolygon -import pandas as pd -import helpers.constants as cte from city_model_structure.attributes.surface import Surface from city_model_structure.attributes.thermal_boundary import ThermalBoundary @@ -147,7 +145,7 @@ class Building(CityObject): City object heated volume in cubic meters :return: float """ - # ToDo: this need to be the calculated based on the basement and attic heated values + # ToDo: this need to be calculated based on the basement and attic heated values return self.volume @property diff --git a/city_model_structure/building_unit.py b/city_model_structure/building_unit.py index bcc3b345..395c7780 100644 --- a/city_model_structure/building_unit.py +++ b/city_model_structure/building_unit.py @@ -1,7 +1,7 @@ """ Building module SPDX - License - Identifier: LGPL - 3.0 - or -later -Copyright © 2020 Project Author Guille Gutierrez guillermo.gutierrezmorote@concordia.ca +Copyright © 2020 Project Author Sanam Dabirian sanam.dabirian@mail.concordia.ca """ from builtins import float diff --git a/city_model_structure/city_object.py b/city_model_structure/city_object.py index bf252a62..e40872bb 100644 --- a/city_model_structure/city_object.py +++ b/city_model_structure/city_object.py @@ -91,8 +91,6 @@ class CityObject: self._polyhedron = Polyhedron(self.surfaces) self._polyhedron.show() - - @property def max_height(self): """ diff --git a/city_model_structure/composting_plant.py b/city_model_structure/composting_plant.py index c0b26ce2..a078d87d 100644 --- a/city_model_structure/composting_plant.py +++ b/city_model_structure/composting_plant.py @@ -1,7 +1,7 @@ """ Composting plant module SPDX - License - Identifier: LGPL - 3.0 - or -later -Copyright © 2020 Project Author Guille Gutierrez guillermo.gutierrezmorote@concordia.ca +Copyright © 2020 Project Author Pilar Monsalvete pilar_monsalvete@yahoo.es """ from city_model_structure.city_object import CityObject diff --git a/city_model_structure/subway_entrance.py b/city_model_structure/subway_entrance.py index 9235b0bc..d7c268bd 100644 --- a/city_model_structure/subway_entrance.py +++ b/city_model_structure/subway_entrance.py @@ -1,7 +1,15 @@ +""" +Subway entrance module +SPDX - License - Identifier: LGPL - 3.0 - or -later +Copyright © 2020 Project Author Pilar Monsalvete pilar_monsalvete@yahoo.es +""" from city_model_structure.city_object import CityObject class SubwayEntrance(CityObject): + """ + SubwayEntrance(CityObject) class + """ def __init__(self, name, latitude, longitude): super().__init__(0, [], name) self._name = name @@ -10,12 +18,26 @@ class SubwayEntrance(CityObject): @property def latitude(self): + # todo: to be defined the spacial point and the units + """ + Get latitude + :return: float + """ return self._latitude @property def longitude(self): + # todo: to be defined the spacial point and the units + """ + Get longitude + :return: float + """ return self._longitude @property def name(self): + """ + Get name + :return: string + """ return self._name diff --git a/city_model_structure/tree.py b/city_model_structure/tree.py index 3f86fe35..298f405d 100644 --- a/city_model_structure/tree.py +++ b/city_model_structure/tree.py @@ -1,7 +1,7 @@ """ Tree module SPDX - License - Identifier: LGPL - 3.0 - or -later -Copyright © 2020 Project Author Guille Gutierrez guillermo.gutierrezmorote@concordia.ca +Copyright © 2020 Project Author Pilar Monsalvete pilar_monsalvete@yahoo.es """ from city_model_structure.city_object import CityObject diff --git a/factories/physics_feeders/us_base_physics_parameters.py b/factories/physics_feeders/us_base_physics_parameters.py index c89bfb14..b74d14bd 100644 --- a/factories/physics_feeders/us_base_physics_parameters.py +++ b/factories/physics_feeders/us_base_physics_parameters.py @@ -93,9 +93,9 @@ class UsBasePhysicsParameters: opening.g_value = w_lib['solar_transmittance_at_normal_incidence']['#text'] opening.thickness = w_lib['thickness']['#text'] opening.back_side_solar_transmittance_at_normal_incidence = \ - w_lib['back_side_solar_transmittance_at_normal_incidence']['#text'] + w_lib['back_side_solar_transmittance_at_normal_incidence']['#text'] opening.front_side_solar_transmittance_at_normal_incidence = \ - w_lib['front_side_solar_transmittance_at_normal_incidence']['#text'] + w_lib['front_side_solar_transmittance_at_normal_incidence']['#text'] def _search_archetype(self, building_type, standard, climate_zone): for archetype in self._archetypes['archetypes']['archetype']: diff --git a/factories/usage_feeders/de_usage_parameters.py b/factories/usage_feeders/de_usage_parameters.py index 3504b4f5..70fe6e68 100644 --- a/factories/usage_feeders/de_usage_parameters.py +++ b/factories/usage_feeders/de_usage_parameters.py @@ -6,7 +6,6 @@ Copyright © 2020 Project Author Guille Gutierrez guillermo.gutierrezmorote@conc from pathlib import Path import xmltodict - from factories.usage_feeders.helpers.us_function_to_usage import UsFunctionToUsage diff --git a/factories/usage_feeders/helpers/us_function_to_usage.py b/factories/usage_feeders/helpers/us_function_to_usage.py index 51f7a0d4..d8126b06 100644 --- a/factories/usage_feeders/helpers/us_function_to_usage.py +++ b/factories/usage_feeders/helpers/us_function_to_usage.py @@ -1,7 +1,7 @@ """ UsFunctionToUsage helper SPDX - License - Identifier: LGPL - 3.0 - or -later -Copyright © 2020 Project Author Guille Gutierrez guillermo.gutierrezmorote@concordia.ca +Copyright © 2020 Project Author Pilar Monsalvete pilar_monsalvete@yahoo.es """ diff --git a/factories/usage_feeders/us_base_usage_parameters.py b/factories/usage_feeders/us_base_usage_parameters.py index 4cf71d64..ce175281 100644 --- a/factories/usage_feeders/us_base_usage_parameters.py +++ b/factories/usage_feeders/us_base_usage_parameters.py @@ -2,6 +2,7 @@ UsBaseUsageParameters base class to model the usage properties for a building in NYC and US SPDX - License - Identifier: LGPL - 3.0 - or -later Copyright © 2020 Project Author Guille Gutierrez guillermo.gutierrezmorote@concordia.ca +Contributors Pilar Monsalvete pilar_monsalvete@yahoo.es """ from pathlib import Path diff --git a/factories/weather_factory.py b/factories/weather_factory.py index 9eb85416..0334a544 100644 --- a/factories/weather_factory.py +++ b/factories/weather_factory.py @@ -3,7 +3,6 @@ WeatherFactory retrieve the specific weather module for the given source format SPDX - License - Identifier: LGPL - 3.0 - or -later Copyright © 2020 Project Author Pilar Monsalvete pilar_monsalvete@yahoo.es """ - from pathlib import Path from factories.weather_feeders.dat_weather_parameters import DatWeatherParameters diff --git a/factories/weather_feeders/helpers/weather.py b/factories/weather_feeders/helpers/weather.py index ed4cf6d4..311a9119 100644 --- a/factories/weather_feeders/helpers/weather.py +++ b/factories/weather_feeders/helpers/weather.py @@ -1,12 +1,24 @@ +""" +weather helper +SPDX - License - Identifier: LGPL - 3.0 - or -later +Copyright © 2020 Project Author Pilar Monsalvete pilar_monsalvete@yahoo.es +""" import math import helpers.constants as cte class Weather(object): + """ + Weather class + """ @staticmethod def sky_temperature(ambient_temperature): - # Swinbank - Fuentes sky model approximation(1963) based on cloudiness statistics(32 %) in United States + """ + sky temperature from ambient temperature in degree Celsius + :return: float + """ + # Swinbank - Source sky model approximation(1963) based on cloudiness statistics(32 %) in United States # ambient temperatures( in °C) # sky temperatures( in °C) values = [] diff --git a/helpers/geometry_helper.py b/helpers/geometry_helper.py index a0df287a..04c05be6 100644 --- a/helpers/geometry_helper.py +++ b/helpers/geometry_helper.py @@ -2,6 +2,7 @@ Geometry helper SPDX - License - Identifier: LGPL - 3.0 - or -later Copyright © 2020 Project Author Guille Gutierrez guillermo.gutierrezmorote@concordia.ca +Contributors Pilar Monsalvete pilar_monsalvete@yahoo.es """ import math