py4design.py2energyplus.idf_writer module¶

py4design.py2energyplus.idf_writer.write_surface(name, type, construction, zone, boundary, boundary_object, sun_exp, wind_exp, points)¶

This function writes all the surface information into energyplus readable string

Parameters:

name : str

The name of the surface.

type : str

The type of the surface, options: “Floor”, “Wall”, “Ceiling”, “Roof” .

construction : str

The name of the construction. The construction must be in the base.idf file. e.g. “Medium Roof/Ceiling”

zone : str

The name of the zone the surface belongs to.

boundary : str

The boundary condition of the surface, options: “Outdoors”, “Adiabatic”, “Ground” or the name of the surface it is adjacent to.

boundary_object : str

The object the surface is adjacent to. If boundary is “Outdoors” or “Ground” give an empty string, if “Adiabatic” give its own name, else give the name of the surface it is adjacent to.

sun_exp : str

Describes if the surface is exposed to sun. Gives either “SunExposed” or “NoSun”.

win_exp : str

Describes if the surface is exposed to wind. Gives either “WindExposed” or “NoWind”.

points : pyptlist

List of points that defines the surface. Pyptlist is a list of tuples of floats. A pypt is a tuple that documents the xyz coordinates of a pt e.g. (x,y,z), thus a pyptlist is a list of tuples e.g. [(x1,y1,z1), (x2,y2,z2), …]

Returns:

surface data : str

The idf string of the surface data.

py4design.py2energyplus.idf_writer.write_window(name, construction, surface, shading, frame, points)¶

This function writes all the window information into energyplus readable string

Parameters:

name : str

The name of the surface.

construction : str

The name of the construction. The construction must be in the base.idf file.

surface : str

The name of the host surface. e.g. “wall1”.

shading : str

The name of the shading surface that belongs to the window. if none just give an empty string “”.

frame : str

The name of the frame that belongs to the window. if none just give an empty string “”.

points : pyptlist

List of points that defines the surface. Pyptlist is a list of tuples of floats. A pypt is a tuple that documents the xyz coordinates of a pt e.g. (x,y,z), thus a pyptlist is a list of tuples e.g. [(x1,y1,z1), (x2,y2,z2), …]

Returns:

window data : str

The idf string of the window data.

py4design.py2energyplus.idf_writer.write_building_shade(name, transmittance, points)¶

This function writes all the all the surfaces of the surrounding context, e.g. shadings that are not attached to the buildings which includes trees and surrounding site into energyplus readable string.

Parameters:

name : str

The name of the surface.

transmittance : str

The transmittance value of the subsurface, only used for shading surfaces. If not provided energyplus will default to 0, means a totally opaque surface.

points : pyptlist

List of points that defines the surface. Pyptlist is a list of tuples of floats. A pypt is a tuple that documents the xyz coordinates of a pt e.g. (x,y,z), thus a pyptlist is a list of tuples e.g. [(x1,y1,z1), (x2,y2,z2), …]

Returns:

building shade data : str

The idf string of the building shade data.

py4design.py2energyplus.idf_writer.write_shadingoverhang(name, window_name, height_above_window, tilt_angle, left_extension, right_extension, depth)¶

This function writes all the shading overhang information into energyplus readable string.

Parameters:

name : str

The name of the surface.

window_name : str

The window name the overhang belongs to.

height_above_window : str

The height of the overhang above the window in metres.

tilt_angle : str

The tilt angle of the overhang in degree.

left_extension : str

The left extension of the overhang in metres.

right_extension : str

The right extension of the overhang in metres.

depth : str

The depthof the overhang in metres.

Returns:

overhang shade data : str

The idf string of the overhang shade data.

py4design.py2energyplus.idf_writer.write_zone(name)¶

This function writes all the zone information into energyplus readable string

Parameters:

name : str

The name of the zone.

Returns:

zone data : str

The idf string of the zone data.

py4design.py2energyplus.idf_writer.write_zone_shade(name, host_surface, transmittance, points)¶

This function writes all the zone shade information into energyplus readable string

Parameters:

name : str

The name of the shade.

host_surface : str

The name of the host surface. e.g. “wall1”.

transmittance : str

The transmittance value of the subsurface. If not provided, an empty string “” is given, energyplus will default to 0, means a totally opaque surface.

points : pyptlist

List of points that defines the surface. Pyptlist is a list of tuples of floats. A pypt is a tuple that documents the xyz coordinates of a pt e.g. (x,y,z), thus a pyptlist is a list of tuples e.g. [(x1,y1,z1), (x2,y2,z2), …]

Returns:

shade data : str

The idf string of the shade data.

py4design.py2energyplus.idf_writer.write_hvac_ideal_load_air_system(zone_name, thermostat)¶

This function writes all the ideal load hvac information into energyplus readable string

Parameters:

zone_name : str

The name of the zone to apply the system to.

thermostat : str

The name of the thermostat schedule.

Returns:

ideal hvac data : str

The idf string of the ideal hvac data.

py4design.py2energyplus.idf_writer.write_lights(zone_name, schedule_name, watts_per_m2)¶

This function writes all the lights information into energyplus readable string

Parameters:

zone_name : str

The name of the zone to apply the system to.

schedule_name : str

The name of the lighting schedule.

watts_per_m2 : str

The Watts per m2 of the lighting, e.g. “10”

Returns:

lights data : str

The idf string of the lights data.

py4design.py2energyplus.idf_writer.write_people(zone_name, schedule_name, people_per_m2)¶: This function writes all the occupancy information into energyplus readable string. In PROGRESS …

py4design.py2energyplus.idf_writer.write_internal_gains_other_equipment(zone_name, schedule_name, watts_per_m2)¶

This function writes all the other equipment internal gain information into energyplus readable string.

Parameters:

zone_name : str

The name of the zone to apply the system to.

schedule_name : str

The name of the internal gain schedule.

watts_per_m2 : str

The Watts per m2 of the equipment, e.g. “20”

Returns:

internal gain data : str

The idf string of the internal gain data data.

py4design.py2energyplus.idf_writer.write_version(version)¶

This function writes all the energyplus version.

Parameters:

version : str

The energyplus version, e.g. “EnergyPlusV8-7-0”.

Returns:

version data : str

The idf string of the version data.

py4design.py2energyplus.idf_writer.write_time_step(time_step)¶

This function writes all the time step information into energyplus readable string.

Parameters:

time_step : str

The time step of the simulation in minutes.

Returns:

time step data : str

The idf string of the time step data.

py4design.py2energyplus.idf_writer.write_ground_temp_bldg_srf(ground_temp)¶

This function writes all the ground temperature information into energyplus readable string.

Parameters:

ground_temp : list of str

The the ground temperature for each month. e.g. [“20”, “20”, “20”, “20”, “20”, “20”,”20”, “20”, “20”, “20”, “20”, “20”]

Returns:

ground temperature data : str

The idf string of the ground temperature data.

py4design.py2energyplus.idf_writer.write_shadow_calc(calc_frequency, max_figures)¶

This function writes all the shadow calculation information into energyplus readable string.

Parameters:

calc_frequency : str

The calculation frequency, e.g. “20”.

max_figures : str

The max figures. e.g. “100000”

Returns:

shadow calculation data : str

The idf string of the shadow calculation data.

py4design.py2energyplus.idf_writer.write_building(north, terrain, solar_dist, max_warmup_days)¶

This function writes all the building information into energyplus readable string.

Parameters:

north : str

The north direction in degrees. If “0” it means the y-direction is north, if “90” x-direction is north.

terrain : str

The terrain of the simulation environment. e.g. “Urban”, “Suburbs”, “Country”, “City”, “Ocean”.

solar_dist : str

The solar distribuition setting. e.g. “FullExterior”, “MinimalShadowing”, “FullInteriorAndExterior”, “FullExteriorWithReflections”, “FullInteriorAndExteriorWithReflections”.

max_warmup_days : str

The maximum number of warmup days. At least “25”.

Returns:

building data : str

The idf string of the building data.

py4design.py2energyplus.idf_writer.write_runperiod(start_month, start_day, end_month, end_day)¶

This function writes all the run period information into energyplus readable string.

Parameters:

start_month : str

The starting month of the energyplus simulation.

start_day : str

The starting day of the starting month of the energyplus simulation.

end_month : str

The end month of the energyplus simulation.

end_day : str

The end day of the end month of the energyplus simulation.

Returns:

run period data : str

The idf string of the run period data.

py4design.py2energyplus.idf_writer.write_schedule_type_limits(name, lower_limit, upper_limit, numeric_type, unit_type)¶

This function writes all the schedule type limit information into energyplus readable string.

Parameters:

name : str

The name of the schedule type limit.

lower_limit : str

The lower limit of the schedule.

upper_limit : str

The upper limit of the schedule.

numeric_type : str

The numeric type of the schedule, e.g. “Continuous” or “Discrete” .

unit_type : str

The unit type of the schedule, e.g. “Dimensionless”, “Temperature”, “ActivityLevel” etc.

Returns:

schedule type limit data : str

The idf string of the schedule type limit data.

py4design.py2energyplus.idf_writer.write_hvacschedule(name, sch_type_limits_name, day_start_time, day_end_time, setpoint_day, setpoint_night)¶

This function writes all the hvac schedule information into energyplus readable string.

Parameters:

name : str

The name of the schedule.

sch_type_limits_name : str

The name of schedule type limit to use.

day_start_time : str

The starting time of the cooling schedule, e.g. “09:00”.

day_end_time : str

The ending time of the cooling schedule, e.g. “17:00”.

setpoint_day : str

The set point temperature of the cooling, e.g. “25”.

setpoint_night : str

The set point temperature of the cooling after end time, e.g. “50”.

Returns:

hvac schedule data : str

The idf string of the hvac schedule data.

py4design.py2energyplus.idf_writer.write_alldays_schedule(name, sch_type_limits_name, start, end)¶

This function writes all the all day schedule information into energyplus readable string.

Parameters:

name : str

The name of the schedule.

sch_type_limits_name : str

The name of schedule type limit to use.

start : str

The starting time of the schedule, e.g. “09:00”.

end : str

The ending time of the schedule, e.g. “17:00”.

Returns:

all day schedule data : str

The idf string of the all day schedule data.

py4design.py2energyplus.idf_writer.write_thermostat(name, heat_sch, cool_sch)¶

This function writes all the thermostat information into energyplus readable string.

Parameters:

name : str

The name of the thermostat.

heat_sch : str

The name of heating schedule to use.

cool_sch : str

The name of cooling schedule to use.

Returns:

thermostat data : str

The idf string of the thermostat data.

py4design.py2energyplus.idf_writer.write_outputvar(variable_name, report_frequency)¶

This function writes all the output variable information into energyplus readable string.

Parameters:

variable_name : str

The name of the variable.

report_frequency : str

The report frequency of the variable, e.g. “Hourly”, “Monthly”, “Daily”.

Returns:

output variable data : str

The idf string of the output variable data.

py4design.py2energyplus.idf_writer.write_outputmeter(variable_name, report_frequency)¶

This function writes all the output meter information into energyplus readable string.

Parameters:

variable_name : str

The name of the variable.

report_frequency : str

The report frequency of the variable, e.g. “Hourly”, “Monthly”, “Daily”.

Returns:

output meter data : str

The idf string of the output meter data.

py4design.py2energyplus.idf_writer.write_output_surfaces_drawing(drawing_type)¶

This function writes all the output drawing information into energyplus readable string.

Parameters:

drawing_type : str

The 3D model of the simulated building, e.g. “DXF”.

Returns:

output drawing data : str

The idf string of the output drawing data.

py4design.py2energyplus.idf_writer.write_output_control_table_style(column_sep, unit_conversion)¶

This function writes all the output control table style information into energyplus readable string.

Parameters:

column_sep : str

The style of the table, e.g. “HTML”.

unit_conversion : str

The unit conversion, e.g. JtoKWH.

Returns:

table style data : str

The idf string of the table style data.

py4design.py2energyplus.idf_writer.write_output_table_summary_reports(report_types)¶

This function writes all the output table summary information into energyplus readable string.

Parameters:

report_type : str or list of str

The reports to be outputted after the simulation, e.g. “AllSummary”.

Returns:

table summary data : str

The idf string of the table summary data.

py4design.py2energyplus.idf_writer module¶

py4design

Navigation

Related Topics