eureca_ubem package

Modules

eureca_ubem.city

IMPORTING MODULES

class eureca_ubem.city.City(city_model: str, envelope_types_file: str, end_uses_types_file: str, epw_weather_file: str, output_folder: str, building_model='2C', shading_calculation=False)[source]

Bases: object

This class manages the city simulation via json input file: geojson or cityjson

T_w_0 = 15.0
T_out_inf = 15.0
T_out_AHU = 15.0
V_0_inf = 0.0
V_0_vent = 0.0
H_waste_0 = 0.0
__init__(city_model: str, envelope_types_file: str, end_uses_types_file: str, epw_weather_file: str, output_folder: str, building_model='2C', shading_calculation=False)[source]

Creates the city from all the input files

Parameters:

  • city_model (str) – path to the json/cityjson file

  • envelope_types_file (str) – path to the envelope_types file

  • end_uses_types_file (str) – path to the end_uses file

  • epw_weather_file (str) – path to the epw weather file

  • output_folder (str) – folder to save results

  • building_model (str, default "2C") – 1C or 2C string

  • shading_calculation (bool, default False) – whether to do or not the mutual shading calculation

property building_model: str
buildings_creation_from_cityjson(json_path)[source]

This method creates the city from the json file (CityJSON 3D)

Parameters:

json_path (str) – path of the cityJSON file

buildings_creation_from_geojson(json_path)[source]

Function to create buildings from geojson file (2D file).

Parameters:

json_path (str) – Path to geojson file.

loads_calculation()[source]

This method does the internal heat gains and solar calculation, as well as it sets the setpoints, ventilation and systems to each building

simulate(print_single_building_results=False)[source]

Simulation of the whole city, and memorization and stamp of results.

Parameters:

print_single_building_results (bool, default False) – If True, the prints a file with time step results for each building. USE CAREFULLY: It might fill a lot of disk space

geometric_preprocessing()[source]

This method firstly reduces the area of coincidence surfaces in the city. This first part must be done to get consistent results Moreover, it takes into account the shading effect between buildings surfaces, if shading_calculation is set to True at the city creation

eureca_ubem.end_uses

This module includes a container class for schedule end-uses

eureca_ubem.end_uses.load_schedules(path)[source]

Schedule type loading in case you use daily schedules This function takes the path to the spreadsheet consisting of the schedules and loads; it Works for the daily schedule (see file ScheduleSemp.xlsx in eureca_ubem/Input/)

Parameters:

path (str) – Path to the spreadsheet to read file_schedule.xlsx

Returns:

dictionary with EndUse_key/ eureca_ubem.end_uses.EndUse objects

Return type:

dict

class eureca_ubem.end_uses.EndUse(name)[source]

Bases: object

This class builds up the loads and schedules for different type of buildings

__init__(name)[source]

Creates the object with many dictionaries to store various loads and schedules

Parameters:

name (str) – name of the archetype

property domestic_hot_water
property heat_gains
property infiltration
property zone_system
property air_handling_unit_system

Take care of units!!!

classmethod load_daily_sched(name, daily_df_from_excel, scalar_df_from_excel, holidays)[source]

Class method to create the EndUse object from the spreadsheet page

Parameters:

  • name (str) – name

  • daily_df_from_excel (pandas.DataFrame) – DataFrame containing schedules from the end_use

  • scalar_df_from_excel (pandas.DataFrame) – This series includes some additional data about the archetype (from the GeneralInfo page in the spreadsheet) (Sensible and Latent AHU recovery, Convective fraction of internal gains)

Return type:

eureca_ubem.end_uses.EndUse

static rescale_df(ts, sched_df)[source]

Static method to rescale the schedule dataframe from the hour to the simulation time step

Parameters:

  • ts (int) – Number of time steps per hour

  • sched_df (pandas.DataFrame) – DataFrame to rescale

Returns:

The rescaled df

Return type:

pandas.DataFrame

eureca_ubem.envelope_types

This module includes a container class for envelope types

eureca_ubem.envelope_types.load_envelopes(path)[source]

load_envelopes loads all materials, windows, stratigraphies and envelopes archetypes in a database that is then utilized by the main program

Parameters:

path (str) – Path containing the string of the Buildings_Envelopes.xlsx

Returns:

Dictionary with eureca_ubem.EnvelopeType objects

Return type:

dict

class eureca_ubem.envelope_types.EnvelopeType(name: str, roof: Construction, ground_floor: Construction, interior_ceiling: Construction, external_wall: Construction, interior_wall: Construction, window: SimpleWindow)[source]

Bases: object

Definition of the EnvelopeType class Each object of EnvelopeType contains several informations about stratigraphies

__init__(name: str, roof: Construction, ground_floor: Construction, interior_ceiling: Construction, external_wall: Construction, interior_wall: Construction, window: SimpleWindow)[source]

Create an envelope type. Just a container of some constructions objects

Parameters:

Module contents