eureca_ubem package

Modules

eureca_ubem.city

eureca_ubem.end_uses

This module includes a container class for schedule end-uses

eureca_ubem.end_uses.__maintainer__ = 'Enrico Prataviera'

IMPORTING MODULES

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

__dict__ = mappingproxy({'__module__': 'eureca_ubem.end_uses', '__doc__': 'This class builds up the loads and schedules for different type of buildings\n    ', '__init__': <function EndUse.__init__>, 'domestic_hot_water': <property object>, 'heat_gains': <property object>, 'infiltration': <property object>, 'zone_system': <property object>, 'air_handling_unit_system': <property object>, 'load_daily_sched': <classmethod(<function EndUse.load_daily_sched>)>, 'rescale_df': <staticmethod(<function EndUse.rescale_df>)>, '__dict__': <attribute '__dict__' of 'EndUse' objects>, '__weakref__': <attribute '__weakref__' of 'EndUse' objects>, '__annotations__': {}})
__doc__ = 'This class builds up the loads and schedules for different type of buildings\n    '
__module__ = 'eureca_ubem.end_uses'
__weakref__

list of weak references to the object (if defined)

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 an EndUse object from an Excel worksheet.

Parameters:
  • name (str) –

  • archetype. (Name of the building) –

  • daily_df_from_excel (pandas.DataFrame) –

  • loads. (Hourly schedules for various systems and internal) –

  • scalar_df_from_excel (pandas.DataFrame) –

  • fraction (Metadata such as convective) –

  • ratios (recovery) –

  • methods. (and calculation) –

  • holidays (list of int) –

  • schedules. (List of holidays (0–364) used to adjust) –

Returns:

  • EndUse

  • Configured EndUse object with schedule and system properties set.

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.__maintainer__ = 'Enrico Prataviera'

IMPORTING MODULES

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:
__dict__ = mappingproxy({'__module__': 'eureca_ubem.envelope_types', '__doc__': 'Definition of the EnvelopeType class\n    Each object of EnvelopeType contains several informations about stratigraphies\n    ', '__init__': <function EnvelopeType.__init__>, '__dict__': <attribute '__dict__' of 'EnvelopeType' objects>, '__weakref__': <attribute '__weakref__' of 'EnvelopeType' objects>, '__annotations__': {}})
__doc__ = 'Definition of the EnvelopeType class\n    Each object of EnvelopeType contains several informations about stratigraphies\n    '
__module__ = 'eureca_ubem.envelope_types'
__weakref__

list of weak references to the object (if defined)

Module contents