accim.sim package

Submodules

accim.sim.accim_Base module

Add EnergyPlus objects in common to both ExistingHVAC and VRFsystem.

accim.sim.accim_Base.addControlFilesObjects(self, verboseMode: bool = True)[source]

Adds an OutputControl:Files object to request the generation of CSV, MRT and ESO files.

Parameters:

verboseMode – Inherited from class accim.sim.accis.addAccis

accim.sim.accim_Base.addOutputEnergyManagementSystem(self, verboseMode: bool = True)[source]
accim.sim.accim_Base.addOutputVariableDictionaryObject(self, verboseMode: bool = True)[source]

Adds an Output:VariableDictionary object to request the generation of the RDD file.

Parameters:

verboseMode

accim.sim.accim_Base.saveaccim(self, verboseMode: bool = True)[source]

Save IDF.

Parameters:

verboseMode – Inherited from class accim.sim.accis.addAccis

accim.sim.accim_Base.setComfFieldsPeople(self, EnergyPlus_version: str | None = None, TempCtrl: str | None = None, verboseMode: bool = True)[source]

Amend PEOPLE objects so that accim can work. Copy existing PEOPLE objects and adds AdaptiveASH55 and AdaptiveCEN15251 to Thermal Comfort Model types 1 and 2 fields of the existing People objects.

Parameters:

  • EnergyPlus_version – Inherited from class accim.sim.accis.addAccis

  • TempCtrl – Inherited from class accim.sim.accis.addAccis

  • verboseMode – Inherited from class accim.sim.accis.addAccis

accim.sim.accim_Base.setPMVsetpoint(self, verboseMode: bool = True)[source]

Sets PMV setpoints for temperature control.

Parameters:

verboseMode – Inherited from class accim.sim.accis.addAccis

accim.sim.accim_Base_EMS module

Add EMS objects in common to both ExistingHVAC and VRFsystem.

accim.sim.accim_Base_EMS.addEMSActuatorsBase(self, ScriptType: str | None = None, verboseMode: bool = True)[source]

Add EMS actuators for accim.

Parameters:

  • self – Used as a method for :class:accim.sim.accim_Main.accimJob

  • ScriptType – Inherited from :class:accim.sim.accis.addAccis

  • verboseMode – Inherited from :class:accim.sim.accis.addAccis

accim.sim.accim_Base_EMS.addEMSOutputVariableBase(self, ScriptType: str | None = None, verboseMode: bool = True)[source]

Add EMS output variables for Base accim. Checks if some EMS output variables objects are already in the model, and otherwise adds them.

Parameters:

  • self – Used as a method for class accim.sim.accim_Main.accimJob

  • ScriptType – Inherited from :class:accim.sim.accis.addAccis

  • verboseMode – Inherited from :class:accim.sim.accis.addAccis

accim.sim.accim_Base_EMS.addEMSPCMBase(self, verboseMode: bool = True)[source]

Add EMS program calling managers for Base accim. Checks if some EMS program calling manager objects are already in the model, and otherwise adds them.

Parameters:

  • self – Used as a method for class accim.sim.accim_Main.accimJob

  • verboseMode – Inherited from class accim.sim.accis.addAccis

accim.sim.accim_Base_EMS.addEMSProgramsBase(self, ScriptType: str | None = None, verboseMode: bool = True)[source]

Add EMS programs for Base accim. Checks if some programs objects are already in the model, and otherwise adds them.

Parameters:

  • ScriptType – Inherited from class accim.sim.accis.addAccis

  • verboseMode – Inherited from class accim.sim.accis.addAccis

accim.sim.accim_Base_EMS.addEMSSensorsBase(self, ScriptType: str | None = None, verboseMode: bool = True)[source]

Add EMS sensors for accim.

Parameters:

  • self – Used as a method for :class:accim.sim.accim_Main.accimJob

  • ScriptType – Inherited from :class:accim.sim.accis.addAccis

  • verboseMode – Inherited from :class:accim.sim.accis.addAccis

accim.sim.accim_Base_EMS.addGlobVarList(self, ScriptType: str | None = None, verboseMode: bool = True)[source]

Remove existing Global Variable objects and add correct Global Variable objects for accim.

Parameters:

  • self – Used as a method for :class:accim.sim.accim_Main.accimJob

  • ScriptType – Inherited from :class:accim.sim.accis.addAccis

  • verboseMode – Inherited from :class:accim.sim.accis.addAccis

accim.sim.accim_Base_EMS.addIntVarList(self, verboseMode: bool = True)[source]

Add Internal variables objects for accim.

Parameters:

  • self – Used as a method for :class:accim.sim.accim_Main.accimJob

  • verboseMode – Inherited from :class:accim.sim.accis.addAccis

accim.sim.accim_Base_EMS.addOutputVariablesDetailed(self, Outputs_freq: any | None = None, verboseMode: bool = True)[source]

Add Output:Variable objects for accim.

Parameters:

  • self – Used as a method for :class:accim.sim.accim_Main.accimJob

  • Outputs_freq – Inherited from :class:accim.sim.accis.addAccis

  • verboseMode – Inherited from :class:accim.sim.accis.addAccis

accim.sim.accim_Base_EMS.addOutputVariablesSimplified(self, Outputs_freq: any | None = None, TempCtrl: str | None = None, verboseMode: bool = True)[source]

Add simplified Output:Variable objects for accim. Remove all outputs and add only VFR outdoor unit consumption and operative temperature.

Parameters:

  • self – Used as a method for :class:accim.sim.accim_Main.accimJob

  • Outputs_freq – Inherited from :class:accim.sim.accis.addAccis

  • TempCtrl – Inherited from :class:accim.sim.accis.addAccis

  • verboseMode – Inherited from :class:accim.sim.accis.addAccis

accim.sim.accim_Base_EMS.addOutputVariablesStandard(self, Outputs_freq: any | None = None, ScriptType: str | None = None, TempCtrl: str | None = None, verboseMode: bool = True)[source]

Add Output:Variable objects for accim.

Parameters:

  • self – Used as a method for :class:accim.sim.accim_Main.accimJob

  • Outputs_freq – Inherited from :class:accim.sim.accis.addAccis

  • ScriptType – Inherited from :class:accim.sim.accis.addAccis

  • TempCtrl – Inherited from :class:accim.sim.accis.addAccis

  • verboseMode – Inherited from :class:accim.sim.accis.addAccis

accim.sim.accim_Base_EMS.genOutputDataframe(self, idf_filename: str | None = None)[source]

Used to generate a pandas DataFrame instance containing all Output:Variable objects in the model.

Parameters:

  • self – Used as a method for :class:accim.sim.accim_Main.accimJob

  • idf_filename – Inherited from :class:accim.sim.accis.addAccis

accim.sim.accim_Base_EMS.makeAverages(self, verboseMode)[source]

Makes averages for some variables.

Parameters:

  • self – Used as a method for :class:accim.sim.accim_Main.accimJob

  • verboseMode – Inherited from :class:accim.sim.accis.addAccis

accim.sim.accim_Base_EMS.outputsSpecified(self, remove_or_keep: str | None = None)[source]

Remove duplicated Output:Variable objects for accim.

Parameters:

  • self – Used as a method for :class:accim.sim.accim_Main.accimJob

  • remove_or_keep – Inherited from :class:accim.sim.accis.addAccis

accim.sim.accim_Base_EMS.removeDuplicatedOutputVariables(self)[source]

Remove duplicated Output:Variable objects for accim.

Parameters:

self – Used as a method for :class:accim.sim.accim_Main.accimJob

accim.sim.accim_Base_EMS.removeExistingOutputVariables(self)[source]

Remove existing Output:Variable objects for accim.

Parameters:

self – Used as a method for :class:accim.sim.accim_Main.accimJob

accim.sim.accim_Base_EMS.takeOutputDataFrame(self, idf_filename, df_outputs_in, verboseMode, singleidf=False)[source]

Used to read a pandas DataFrame containing the Output:Variable objects to be kept.

Parameters:

  • self – Used as a method for :class:accim.sim.accim_Main.accimJob

  • idf_filename – Inherited from :class:accim.sim.accis.addAccis

  • df_outputs_in – Inherited from :class:accim.sim.accis.addAccis

  • verboseMode – Inherited from :class:accim.sim.accis.addAccis

accim.sim.accim_ExistingHVAC module

Module for function in EnergyPlus scope related to models with existing HVAC systems

accim.sim.accim_ExistingHVAC.addForscriptSchExistHVAC(self, verboseMode: bool = True)[source]

Add Schedules for each zone in existing HVAC zones to override the existing setpoint temperatures.

Parameters:

  • self – Used as a method for class accim.sim.accim_Main.accimJob

  • verboseMode – Inherited from class accim.sim.accis.addAccis

accim.sim.accim_ExistingHVAC_EMS module

Module for EMS functions and models with existing HVAC systems

accim.sim.accim_ExistingHVAC_EMS.addEMSSensorsExisHVAC(self, verboseMode: bool = True)[source]

Adds the EMS sensors for models with existing HVAC system.

Parameters:

  • self – Used as a method for class accim.sim.accim_Main.accimJob

  • verboseMode – Inherited from class accim.sim.accis.addAccis

accim.sim.accim_IDFgeneration module

Generate IDFs.

accim.sim.accim_IDFgeneration.genIDF(self, ScriptType: str | None = None, TempCtrl: str | None = None, ComfStand: list | None = None, CAT: list | None = None, CATcoolOffset: float = 0, CATheatOffset: float = 0, ComfMod: list | None = None, SetpointAcc: float = 10000, CustAST_ACSTaul: float = 0, CustAST_ACSTall: float = 0, CustAST_AHSTaul: float = 0, CustAST_AHSTall: float = 0, CustAST_m: float = 0, CustAST_n: float = 0, CustAST_ACSToffset: float = 0, CustAST_AHSToffset: float = 0, CoolSeasonStart=121, CoolSeasonEnd=274, HVACmode: list | None = None, VentCtrl: list | None = None, MaxTempDiffVOF: float = 6, MinTempDiffVOF: float = 1, MultiplierVOF: float = 0.25, VSToffset: list = [0], MinOToffset: list = [50], MaxWindSpeed: list = [50], ASTtol_start: float = 0.1, ASTtol_end_input: float = 0.1, ASTtol_steps: float = 0.1, NameSuffix: str = '', verboseMode: bool = True, confirmGen: bool | None = None)[source]

Generate IDFs.

Parameters:

  • self – Used as a method for class accim.sim.accim_Main.accimJob

  • ScriptType – Inherited from class accim.sim.accis.addAccis

  • TempCtrl – Inherited from class accim.sim.accis.addAccis

  • ComfStand – Inherited from class accim.sim.accis.addAccis

  • CustAST_m – Inherited from class accim.sim.accis.addAccis

  • CustAST_n – Inherited from class accim.sim.accis.addAccis

  • CustAST_ACSToffset – Inherited from class accim.sim.accis.addAccis

  • CustAST_AHSToffset – Inherited from class accim.sim.accis.addAccis

  • CustAST_ACSTall – Inherited from class accim.sim.accis.addAccis

  • CustAST_ACSTaul – Inherited from class accim.sim.accis.addAccis

  • CustAST_AHSTall – Inherited from class accim.sim.accis.addAccis

  • CustAST_AHSTaul – Inherited from class accim.sim.accis.addAccis

  • CAT – Inherited from class accim.sim.accis.addAccis

  • CATcoolOffset – Inherited from class accim.sim.accis.addAccis

  • CATheatOffset – Inherited from class accim.sim.accis.addAccis

  • ComfMod – Inherited from :class:accim.sim.accis.addAccis

  • SetpointAcc – Inherited from :class:accim.sim.accis.addAccis

  • CoolSeasonStart – Inherited from :class:accim.sim.accis.addAccis

  • CoolSeasonEnd – Inherited from :class:accim.sim.accis.addAccis

  • HVACmode – Inherited from :class:accim.sim.accis.addAccis

  • VentCtrl – Inherited from :class:accim.sim.accis.addAccis

  • MaxTempDiffVOF – Inherited from :class:accim.sim.accis.addAccis

  • MinTempDiffVOF – Inherited from :class:accim.sim.accis.addAccis

  • MultiplierVOF – Inherited from :class:accim.sim.accis.addAccis

  • VSToffset – Inherited from :class:accim.sim.accis.addAccis

  • MinOToffset – Inherited from :class:accim.sim.accis.addAccis

  • MaxWindSpeed – Inherited from :class:accim.sim.accis.addAccis

  • ASTtol_start – Inherited from :class:accim.sim.accis.addAccis

  • ASTtol_end_input – Inherited from :class:accim.sim.accis.addAccis

  • ASTtol_steps – Inherited from :class:accim.sim.accis.addAccis

  • NameSuffix – Inherited from :class:accim.sim.accis.addAccis

  • verboseMode – Inherited from :class:accim.sim.accis.addAccis

  • confirmGen – Inherited from :class:accim.sim.accis.addAccis

accim.sim.accim_IDFgeneration.inputData(self, ScriptType: str | None = None)[source]

Input data for IDF generation.

Parameters:

  • self – Used as a method for class accim.sim.accim_Main.accimJob

  • ScriptType – Inherited from class accim.sim.accis.addAccis

accim.sim.accim_Main module

Class for accim.

class accim.sim.accim_Main.accimJob(filename_temp, ScriptType: str | None = None, EnergyPlus_version: str = 'auto', TempCtrl: str | None = None, verboseMode: bool = True, accimNotWorking: bool = False)[source]

Bases: object

Class to start the process to add the class accim.sim.accis.addAccis.

Parameters:

  • filename_temp – the filename of the idf

  • ScriptType – Inherited from class accim.sim.accis.addAccis

  • EnergyPlus_version – Inherited from class accim.sim.accis.addAccis

  • TempCtrl – Inherited from class accim.sim.accis.addAccis

  • verboseMode – Inherited from class accim.sim.accis.addAccis

  • accimNotWorking – True if problems detected in class accim.sim.accis.addAccis

addBaseSchedules(verboseMode: bool = True)

Amend Schedule:Compact objects. Checks Schedule:Compact objects needed for accim, and add them in case these are not in the model

Parameters:

  • self – Used as a method for class accim.sim.accim_Main.accimJob

  • verboseMode – Inherited from class accim.sim.accis.addAccis

addControlFilesObjects(verboseMode: bool = True)

Adds an OutputControl:Files object to request the generation of CSV, MRT and ESO files.

Parameters:

verboseMode – Inherited from class accim.sim.accis.addAccis

addCurveObj(verboseMode: bool = True)

Add Curve Objects needed for VRFsystem to work.

Parameters:

  • self – Used as a method for class accim.sim.accim_Main.accimJob

  • verboseMode – Inherited from class accim.sim.accis.addAccis

addDetHVACobj(EnergyPlus_version: str | None = None, verboseMode: bool = True, SupplyAirTempInputMethod: str | None = None, eer: float = 2, cop: float = 2.1, VRFschedule: str = 'On 24/7')

Add Detailed HVAC objects for VRFsystem to work.

Parameters:

  • self – Used as a method for class accim.sim.accim_Main.accimJob

  • EnergyPlus_version – Inherited from class accim.sim.accis.addAccis

  • verboseMode – Inherited from class accim.sim.accis.addAccis

  • SupplyAirTempInputMethod – Inherited from class accim.sim.accis.addAccis

addEMSActuatorsBase(ScriptType: str | None = None, verboseMode: bool = True)

Add EMS actuators for accim.

Parameters:

  • self – Used as a method for :class:accim.sim.accim_Main.accimJob

  • ScriptType – Inherited from :class:accim.sim.accis.addAccis

  • verboseMode – Inherited from :class:accim.sim.accis.addAccis

addEMSOutputVariableBase(ScriptType: str | None = None, verboseMode: bool = True)

Add EMS output variables for Base accim. Checks if some EMS output variables objects are already in the model, and otherwise adds them.

Parameters:

  • self – Used as a method for class accim.sim.accim_Main.accimJob

  • ScriptType – Inherited from :class:accim.sim.accis.addAccis

  • verboseMode – Inherited from :class:accim.sim.accis.addAccis

addEMSPCMBase(verboseMode: bool = True)

Add EMS program calling managers for Base accim. Checks if some EMS program calling manager objects are already in the model, and otherwise adds them.

Parameters:

  • self – Used as a method for class accim.sim.accim_Main.accimJob

  • verboseMode – Inherited from class accim.sim.accis.addAccis

addEMSProgramsBase(ScriptType: str | None = None, verboseMode: bool = True)

Add EMS programs for Base accim. Checks if some programs objects are already in the model, and otherwise adds them.

Parameters:

  • ScriptType – Inherited from class accim.sim.accis.addAccis

  • verboseMode – Inherited from class accim.sim.accis.addAccis

addEMSSensorsBase(ScriptType: str | None = None, verboseMode: bool = True)

Add EMS sensors for accim.

Parameters:

  • self – Used as a method for :class:accim.sim.accim_Main.accimJob

  • ScriptType – Inherited from :class:accim.sim.accis.addAccis

  • verboseMode – Inherited from :class:accim.sim.accis.addAccis

addEMSSensorsExisHVAC(verboseMode: bool = True)

Adds the EMS sensors for models with existing HVAC system.

Parameters:

  • self – Used as a method for class accim.sim.accim_Main.accimJob

  • verboseMode – Inherited from class accim.sim.accis.addAccis

addEMSSensorsVRFsystem(ScriptType: str | None = None, verboseMode: bool = True)

Add EMS sensors for VRF system accim.

Parameters:

  • self – Used as a method for class accim.sim.accim_Main.accimJob

  • ScriptType – Inherited from class accim.sim.accis.addAccis

  • verboseMode – Inherited from class accim.sim.accis.addAccis

addForscriptSchExistHVAC(verboseMode: bool = True)

Add Schedules for each zone in existing HVAC zones to override the existing setpoint temperatures.

Parameters:

  • self – Used as a method for class accim.sim.accim_Main.accimJob

  • verboseMode – Inherited from class accim.sim.accis.addAccis

addForscriptSchVRFsystem(verboseMode: bool = True)

Add AST Schedules for each zone for VRFsystem.

Parameters:

  • self – Used as a method for class accim.sim.accim_Main.accimJob

  • verboseMode – Inherited from :class:accim.sim.accis.addAccis

addGlobVarList(ScriptType: str | None = None, verboseMode: bool = True)

Remove existing Global Variable objects and add correct Global Variable objects for accim.

Parameters:

  • self – Used as a method for :class:accim.sim.accim_Main.accimJob

  • ScriptType – Inherited from :class:accim.sim.accis.addAccis

  • verboseMode – Inherited from :class:accim.sim.accis.addAccis

addIntVarList(verboseMode: bool = True)

Add Internal variables objects for accim.

Parameters:

  • self – Used as a method for :class:accim.sim.accim_Main.accimJob

  • verboseMode – Inherited from :class:accim.sim.accis.addAccis

addOpTempTherm(verboseMode: bool = True)

Amend ZoneControl:Thermostat:OperativeTemperature objects. Add ZoneControl:Thermostat:OperativeTemperature objects for each zone.

Parameters:

  • self – Used as a method for class accim.sim.accim_Main.accimJob

  • verboseMode – Inherited from class accim.sim.accis.addAccis

addOutputEnergyManagementSystem(verboseMode: bool = True)
addOutputVariableDictionaryObject(verboseMode: bool = True)

Adds an Output:VariableDictionary object to request the generation of the RDD file.

Parameters:

verboseMode

addOutputVariablesDetailed(Outputs_freq: any | None = None, verboseMode: bool = True)

Add Output:Variable objects for accim.

Parameters:

  • self – Used as a method for :class:accim.sim.accim_Main.accimJob

  • Outputs_freq – Inherited from :class:accim.sim.accis.addAccis

  • verboseMode – Inherited from :class:accim.sim.accis.addAccis

addOutputVariablesSimplified(Outputs_freq: any | None = None, TempCtrl: str | None = None, verboseMode: bool = True)

Add simplified Output:Variable objects for accim. Remove all outputs and add only VFR outdoor unit consumption and operative temperature.

Parameters:

  • self – Used as a method for :class:accim.sim.accim_Main.accimJob

  • Outputs_freq – Inherited from :class:accim.sim.accis.addAccis

  • TempCtrl – Inherited from :class:accim.sim.accis.addAccis

  • verboseMode – Inherited from :class:accim.sim.accis.addAccis

addOutputVariablesStandard(Outputs_freq: any | None = None, ScriptType: str | None = None, TempCtrl: str | None = None, verboseMode: bool = True)

Add Output:Variable objects for accim.

Parameters:

  • self – Used as a method for :class:accim.sim.accim_Main.accimJob

  • Outputs_freq – Inherited from :class:accim.sim.accis.addAccis

  • ScriptType – Inherited from :class:accim.sim.accis.addAccis

  • TempCtrl – Inherited from :class:accim.sim.accis.addAccis

  • verboseMode – Inherited from :class:accim.sim.accis.addAccis

addVRFsystemSch(verboseMode: bool = True)

Amend Schedule:Compact objects for VRFsystem. Add Schedule:Compact objects needed for VRFsystem to work, other than AHST_Sch and ACST_Sch Schedules.

Parameters:

  • self – Used as a method for class accim.sim.accim_Main.accimJob

  • verboseMode – Inherited from class accim.sim.accis.addAccis

amend_idf_version_from_dsb()

Amends the idf version of the Designbuilder-sourced idf file, for Designbuilder v7.X. Replaces the string ‘Version, 9.4.0.002’ with ‘Version, 9.4’.

Parameters:

idf_path (str) – the path to the idf

checkVentIsOn(verboseMode: bool = True)

Check ventilation settings.

Parameters:

  • self – Used as a method for :class:accim.sim.accim_Main.accimJob

  • verboseMode – Inherited from :class:accim.sim.accis.addAccis

genIDF(ScriptType: str | None = None, TempCtrl: str | None = None, ComfStand: list | None = None, CAT: list | None = None, CATcoolOffset: float = 0, CATheatOffset: float = 0, ComfMod: list | None = None, SetpointAcc: float = 10000, CustAST_ACSTaul: float = 0, CustAST_ACSTall: float = 0, CustAST_AHSTaul: float = 0, CustAST_AHSTall: float = 0, CustAST_m: float = 0, CustAST_n: float = 0, CustAST_ACSToffset: float = 0, CustAST_AHSToffset: float = 0, CoolSeasonStart=121, CoolSeasonEnd=274, HVACmode: list | None = None, VentCtrl: list | None = None, MaxTempDiffVOF: float = 6, MinTempDiffVOF: float = 1, MultiplierVOF: float = 0.25, VSToffset: list = [0], MinOToffset: list = [50], MaxWindSpeed: list = [50], ASTtol_start: float = 0.1, ASTtol_end_input: float = 0.1, ASTtol_steps: float = 0.1, NameSuffix: str = '', verboseMode: bool = True, confirmGen: bool | None = None)

Generate IDFs.

Parameters:

  • self – Used as a method for class accim.sim.accim_Main.accimJob

  • ScriptType – Inherited from class accim.sim.accis.addAccis

  • TempCtrl – Inherited from class accim.sim.accis.addAccis

  • ComfStand – Inherited from class accim.sim.accis.addAccis

  • CustAST_m – Inherited from class accim.sim.accis.addAccis

  • CustAST_n – Inherited from class accim.sim.accis.addAccis

  • CustAST_ACSToffset – Inherited from class accim.sim.accis.addAccis

  • CustAST_AHSToffset – Inherited from class accim.sim.accis.addAccis

  • CustAST_ACSTall – Inherited from class accim.sim.accis.addAccis

  • CustAST_ACSTaul – Inherited from class accim.sim.accis.addAccis

  • CustAST_AHSTall – Inherited from class accim.sim.accis.addAccis

  • CustAST_AHSTaul – Inherited from class accim.sim.accis.addAccis

  • CAT – Inherited from class accim.sim.accis.addAccis

  • CATcoolOffset – Inherited from class accim.sim.accis.addAccis

  • CATheatOffset – Inherited from class accim.sim.accis.addAccis

  • ComfMod – Inherited from :class:accim.sim.accis.addAccis

  • SetpointAcc – Inherited from :class:accim.sim.accis.addAccis

  • CoolSeasonStart – Inherited from :class:accim.sim.accis.addAccis

  • CoolSeasonEnd – Inherited from :class:accim.sim.accis.addAccis

  • HVACmode – Inherited from :class:accim.sim.accis.addAccis

  • VentCtrl – Inherited from :class:accim.sim.accis.addAccis

  • MaxTempDiffVOF – Inherited from :class:accim.sim.accis.addAccis

  • MinTempDiffVOF – Inherited from :class:accim.sim.accis.addAccis

  • MultiplierVOF – Inherited from :class:accim.sim.accis.addAccis

  • VSToffset – Inherited from :class:accim.sim.accis.addAccis

  • MinOToffset – Inherited from :class:accim.sim.accis.addAccis

  • MaxWindSpeed – Inherited from :class:accim.sim.accis.addAccis

  • ASTtol_start – Inherited from :class:accim.sim.accis.addAccis

  • ASTtol_end_input – Inherited from :class:accim.sim.accis.addAccis

  • ASTtol_steps – Inherited from :class:accim.sim.accis.addAccis

  • NameSuffix – Inherited from :class:accim.sim.accis.addAccis

  • verboseMode – Inherited from :class:accim.sim.accis.addAccis

  • confirmGen – Inherited from :class:accim.sim.accis.addAccis

genOutputDataframe(idf_filename: str | None = None)

Used to generate a pandas DataFrame instance containing all Output:Variable objects in the model.

Parameters:

  • self – Used as a method for :class:accim.sim.accim_Main.accimJob

  • idf_filename – Inherited from :class:accim.sim.accis.addAccis

get_idd_path_from_ep_version()
inputData(ScriptType: str | None = None)

Input data for IDF generation.

Parameters:

  • self – Used as a method for class accim.sim.accim_Main.accimJob

  • ScriptType – Inherited from class accim.sim.accis.addAccis

listdir()

Return a list containing the names of the files in the directory.

path can be specified as either str, bytes, or a path-like object. If path is bytes,

the filenames returned will also be bytes; in all other circumstances the filenames returned will be str.

If path is None, uses the path=’.’. On some platforms, path may also be specified as an open file descriptor;

the file descriptor must refer to a directory. If this functionality is unavailable, using it raises NotImplementedError.

The list is in arbitrary order. It does not include the special entries ‘.’ and ‘..’ even if they are present in the directory.

makeAverages(verboseMode)

Makes averages for some variables.

Parameters:

  • self – Used as a method for :class:accim.sim.accim_Main.accimJob

  • verboseMode – Inherited from :class:accim.sim.accis.addAccis

numpy = <module 'numpy' from '/home/docs/checkouts/readthedocs.org/user_builds/accim/envs/v0.7.6/lib/python3.9/site-packages/numpy/__init__.py'>
outputsSpecified(remove_or_keep: str | None = None)

Remove duplicated Output:Variable objects for accim.

Parameters:

  • self – Used as a method for :class:accim.sim.accim_Main.accimJob

  • remove_or_keep – Inherited from :class:accim.sim.accis.addAccis

removeDuplicatedOutputVariables()

Remove duplicated Output:Variable objects for accim.

Parameters:

self – Used as a method for :class:accim.sim.accim_Main.accimJob

removeExistingOutputVariables()

Remove existing Output:Variable objects for accim.

Parameters:

self – Used as a method for :class:accim.sim.accim_Main.accimJob

saveaccim(verboseMode: bool = True)

Save IDF.

Parameters:

verboseMode – Inherited from class accim.sim.accis.addAccis

scan_zones()

Used to scan the occupied zones in an idf.

setAvailSchOn(verboseMode: bool = True)

Amend availability schedules. Assign On Compact:Schedule to heating and cooling availability schedule names.

Parameters:

  • self – Used as a method for class accim.sim.accim_Main.accimJob

  • verboseMode – Inherited from class accim.sim.accis.addAccis

setComfFieldsPeople(EnergyPlus_version: str | None = None, TempCtrl: str | None = None, verboseMode: bool = True)

Amend PEOPLE objects so that accim can work. Copy existing PEOPLE objects and adds AdaptiveASH55 and AdaptiveCEN15251 to Thermal Comfort Model types 1 and 2 fields of the existing People objects.

Parameters:

  • EnergyPlus_version – Inherited from class accim.sim.accis.addAccis

  • TempCtrl – Inherited from class accim.sim.accis.addAccis

  • verboseMode – Inherited from class accim.sim.accis.addAccis

setPMVsetpoint(verboseMode: bool = True)

Sets PMV setpoints for temperature control.

Parameters:

verboseMode – Inherited from class accim.sim.accis.addAccis

takeOutputDataFrame(idf_filename, df_outputs_in, verboseMode, singleidf=False)

Used to read a pandas DataFrame containing the Output:Variable objects to be kept.

Parameters:

  • self – Used as a method for :class:accim.sim.accim_Main.accimJob

  • idf_filename – Inherited from :class:accim.sim.accis.addAccis

  • df_outputs_in – Inherited from :class:accim.sim.accis.addAccis

  • verboseMode – Inherited from :class:accim.sim.accis.addAccis

accim.sim.accim_Main_single_idf module

Class for accim.

class accim.sim.accim_Main_single_idf.accimJob(idf_class_instance, ScriptType: str | None = None, EnergyPlus_version: str | None = None, TempCtrl: str | None = None, verboseMode: bool = True)[source]

Bases: object

Class to start the process to add the class accim.sim.accis.addAccis.

Parameters:

  • idf_class_instance – the filename of the idf

  • ScriptType – Inherited from class accim.sim.accis.addAccis

  • EnergyPlus_version – Inherited from class accim.sim.accis.addAccis

  • TempCtrl – Inherited from class accim.sim.accis.addAccis

  • verboseMode – Inherited from class accim.sim.accis.addAccis

  • accimNotWorking – True if problems detected in class accim.sim.accis.addAccis

addBaseSchedules(verboseMode: bool = True)

Amend Schedule:Compact objects. Checks Schedule:Compact objects needed for accim, and add them in case these are not in the model

Parameters:

  • self – Used as a method for class accim.sim.accim_Main.accimJob

  • verboseMode – Inherited from class accim.sim.accis.addAccis

addControlFilesObjects(verboseMode: bool = True)

Adds an OutputControl:Files object to request the generation of CSV, MRT and ESO files.

Parameters:

verboseMode – Inherited from class accim.sim.accis.addAccis

addCurveObj(verboseMode: bool = True)

Add Curve Objects needed for VRFsystem to work.

Parameters:

  • self – Used as a method for class accim.sim.accim_Main.accimJob

  • verboseMode – Inherited from class accim.sim.accis.addAccis

addDetHVACobj(EnergyPlus_version: str | None = None, verboseMode: bool = True, SupplyAirTempInputMethod: str | None = None, eer: float = 2, cop: float = 2.1, VRFschedule: str = 'On 24/7')

Add Detailed HVAC objects for VRFsystem to work.

Parameters:

  • self – Used as a method for class accim.sim.accim_Main.accimJob

  • EnergyPlus_version – Inherited from class accim.sim.accis.addAccis

  • verboseMode – Inherited from class accim.sim.accis.addAccis

  • SupplyAirTempInputMethod – Inherited from class accim.sim.accis.addAccis

addEMSActuatorsBase(ScriptType: str | None = None, verboseMode: bool = True)

Add EMS actuators for accim.

Parameters:

  • self – Used as a method for :class:accim.sim.accim_Main.accimJob

  • ScriptType – Inherited from :class:accim.sim.accis.addAccis

  • verboseMode – Inherited from :class:accim.sim.accis.addAccis

addEMSOutputVariableBase(ScriptType: str | None = None, verboseMode: bool = True)

Add EMS output variables for Base accim. Checks if some EMS output variables objects are already in the model, and otherwise adds them.

Parameters:

  • self – Used as a method for class accim.sim.accim_Main.accimJob

  • ScriptType – Inherited from :class:accim.sim.accis.addAccis

  • verboseMode – Inherited from :class:accim.sim.accis.addAccis

addEMSPCMBase(verboseMode: bool = True)

Add EMS program calling managers for Base accim. Checks if some EMS program calling manager objects are already in the model, and otherwise adds them.

Parameters:

  • self – Used as a method for class accim.sim.accim_Main.accimJob

  • verboseMode – Inherited from class accim.sim.accis.addAccis

addEMSProgramsBase(ScriptType: str | None = None, verboseMode: bool = True)

Add EMS programs for Base accim. Checks if some programs objects are already in the model, and otherwise adds them.

Parameters:

  • ScriptType – Inherited from class accim.sim.accis.addAccis

  • verboseMode – Inherited from class accim.sim.accis.addAccis

addEMSSensorsBase(ScriptType: str | None = None, verboseMode: bool = True)

Add EMS sensors for accim.

Parameters:

  • self – Used as a method for :class:accim.sim.accim_Main.accimJob

  • ScriptType – Inherited from :class:accim.sim.accis.addAccis

  • verboseMode – Inherited from :class:accim.sim.accis.addAccis

addEMSSensorsExisHVAC(verboseMode: bool = True)

Adds the EMS sensors for models with existing HVAC system.

Parameters:

  • self – Used as a method for class accim.sim.accim_Main.accimJob

  • verboseMode – Inherited from class accim.sim.accis.addAccis

addEMSSensorsVRFsystem(ScriptType: str | None = None, verboseMode: bool = True)

Add EMS sensors for VRF system accim.

Parameters:

  • self – Used as a method for class accim.sim.accim_Main.accimJob

  • ScriptType – Inherited from class accim.sim.accis.addAccis

  • verboseMode – Inherited from class accim.sim.accis.addAccis

addForscriptSchExistHVAC(verboseMode: bool = True)

Add Schedules for each zone in existing HVAC zones to override the existing setpoint temperatures.

Parameters:

  • self – Used as a method for class accim.sim.accim_Main.accimJob

  • verboseMode – Inherited from class accim.sim.accis.addAccis

addForscriptSchVRFsystem(verboseMode: bool = True)

Add AST Schedules for each zone for VRFsystem.

Parameters:

  • self – Used as a method for class accim.sim.accim_Main.accimJob

  • verboseMode – Inherited from :class:accim.sim.accis.addAccis

addGlobVarList(ScriptType: str | None = None, verboseMode: bool = True)

Remove existing Global Variable objects and add correct Global Variable objects for accim.

Parameters:

  • self – Used as a method for :class:accim.sim.accim_Main.accimJob

  • ScriptType – Inherited from :class:accim.sim.accis.addAccis

  • verboseMode – Inherited from :class:accim.sim.accis.addAccis

addIntVarList(verboseMode: bool = True)

Add Internal variables objects for accim.

Parameters:

  • self – Used as a method for :class:accim.sim.accim_Main.accimJob

  • verboseMode – Inherited from :class:accim.sim.accis.addAccis

addOpTempTherm(verboseMode: bool = True)

Amend ZoneControl:Thermostat:OperativeTemperature objects. Add ZoneControl:Thermostat:OperativeTemperature objects for each zone.

Parameters:

  • self – Used as a method for class accim.sim.accim_Main.accimJob

  • verboseMode – Inherited from class accim.sim.accis.addAccis

addOutputEnergyManagementSystem(verboseMode: bool = True)
addOutputVariableDictionaryObject(verboseMode: bool = True)

Adds an Output:VariableDictionary object to request the generation of the RDD file.

Parameters:

verboseMode

addOutputVariablesDetailed(Outputs_freq: any | None = None, verboseMode: bool = True)

Add Output:Variable objects for accim.

Parameters:

  • self – Used as a method for :class:accim.sim.accim_Main.accimJob

  • Outputs_freq – Inherited from :class:accim.sim.accis.addAccis

  • verboseMode – Inherited from :class:accim.sim.accis.addAccis

addOutputVariablesSimplified(Outputs_freq: any | None = None, TempCtrl: str | None = None, verboseMode: bool = True)

Add simplified Output:Variable objects for accim. Remove all outputs and add only VFR outdoor unit consumption and operative temperature.

Parameters:

  • self – Used as a method for :class:accim.sim.accim_Main.accimJob

  • Outputs_freq – Inherited from :class:accim.sim.accis.addAccis

  • TempCtrl – Inherited from :class:accim.sim.accis.addAccis

  • verboseMode – Inherited from :class:accim.sim.accis.addAccis

addOutputVariablesStandard(Outputs_freq: any | None = None, ScriptType: str | None = None, TempCtrl: str | None = None, verboseMode: bool = True)

Add Output:Variable objects for accim.

Parameters:

  • self – Used as a method for :class:accim.sim.accim_Main.accimJob

  • Outputs_freq – Inherited from :class:accim.sim.accis.addAccis

  • ScriptType – Inherited from :class:accim.sim.accis.addAccis

  • TempCtrl – Inherited from :class:accim.sim.accis.addAccis

  • verboseMode – Inherited from :class:accim.sim.accis.addAccis

addVRFsystemSch(verboseMode: bool = True)

Amend Schedule:Compact objects for VRFsystem. Add Schedule:Compact objects needed for VRFsystem to work, other than AHST_Sch and ACST_Sch Schedules.

Parameters:

  • self – Used as a method for class accim.sim.accim_Main.accimJob

  • verboseMode – Inherited from class accim.sim.accis.addAccis

checkVentIsOn(verboseMode: bool = True)

Check ventilation settings.

Parameters:

  • self – Used as a method for :class:accim.sim.accim_Main.accimJob

  • verboseMode – Inherited from :class:accim.sim.accis.addAccis

genOutputDataframe(idf_filename: str | None = None)

Used to generate a pandas DataFrame instance containing all Output:Variable objects in the model.

Parameters:

  • self – Used as a method for :class:accim.sim.accim_Main.accimJob

  • idf_filename – Inherited from :class:accim.sim.accis.addAccis

listdir()

Return a list containing the names of the files in the directory.

path can be specified as either str, bytes, or a path-like object. If path is bytes,

the filenames returned will also be bytes; in all other circumstances the filenames returned will be str.

If path is None, uses the path=’.’. On some platforms, path may also be specified as an open file descriptor;

the file descriptor must refer to a directory. If this functionality is unavailable, using it raises NotImplementedError.

The list is in arbitrary order. It does not include the special entries ‘.’ and ‘..’ even if they are present in the directory.

makeAverages(verboseMode)

Makes averages for some variables.

Parameters:

  • self – Used as a method for :class:accim.sim.accim_Main.accimJob

  • verboseMode – Inherited from :class:accim.sim.accis.addAccis

numpy = <module 'numpy' from '/home/docs/checkouts/readthedocs.org/user_builds/accim/envs/v0.7.6/lib/python3.9/site-packages/numpy/__init__.py'>
outputsSpecified(remove_or_keep: str | None = None)

Remove duplicated Output:Variable objects for accim.

Parameters:

  • self – Used as a method for :class:accim.sim.accim_Main.accimJob

  • remove_or_keep – Inherited from :class:accim.sim.accis.addAccis

removeDuplicatedOutputVariables()

Remove duplicated Output:Variable objects for accim.

Parameters:

self – Used as a method for :class:accim.sim.accim_Main.accimJob

removeExistingOutputVariables()

Remove existing Output:Variable objects for accim.

Parameters:

self – Used as a method for :class:accim.sim.accim_Main.accimJob

saveaccim(verboseMode: bool = True)

Save IDF.

Parameters:

verboseMode – Inherited from class accim.sim.accis.addAccis

scan_zones()

Used to scan the occupied zones in an idf.

setAvailSchOn(verboseMode: bool = True)

Amend availability schedules. Assign On Compact:Schedule to heating and cooling availability schedule names.

Parameters:

  • self – Used as a method for class accim.sim.accim_Main.accimJob

  • verboseMode – Inherited from class accim.sim.accis.addAccis

setComfFieldsPeople(EnergyPlus_version: str | None = None, TempCtrl: str | None = None, verboseMode: bool = True)

Amend PEOPLE objects so that accim can work. Copy existing PEOPLE objects and adds AdaptiveASH55 and AdaptiveCEN15251 to Thermal Comfort Model types 1 and 2 fields of the existing People objects.

Parameters:

  • EnergyPlus_version – Inherited from class accim.sim.accis.addAccis

  • TempCtrl – Inherited from class accim.sim.accis.addAccis

  • verboseMode – Inherited from class accim.sim.accis.addAccis

setPMVsetpoint(verboseMode: bool = True)

Sets PMV setpoints for temperature control.

Parameters:

verboseMode – Inherited from class accim.sim.accis.addAccis

takeOutputDataFrame(idf_filename, df_outputs_in, verboseMode, singleidf=False)

Used to read a pandas DataFrame containing the Output:Variable objects to be kept.

Parameters:

  • self – Used as a method for :class:accim.sim.accim_Main.accimJob

  • idf_filename – Inherited from :class:accim.sim.accis.addAccis

  • df_outputs_in – Inherited from :class:accim.sim.accis.addAccis

  • verboseMode – Inherited from :class:accim.sim.accis.addAccis

accim.sim.accim_VRFsystem module

Add EnergyPlus objects only for VRFsystem.

accim.sim.accim_VRFsystem.addBaseSchedules(self, verboseMode: bool = True)[source]

Amend Schedule:Compact objects. Checks Schedule:Compact objects needed for accim, and add them in case these are not in the model

Parameters:

  • self – Used as a method for class accim.sim.accim_Main.accimJob

  • verboseMode – Inherited from class accim.sim.accis.addAccis

accim.sim.accim_VRFsystem.addCurveObj(self, verboseMode: bool = True)[source]

Add Curve Objects needed for VRFsystem to work.

Parameters:

  • self – Used as a method for class accim.sim.accim_Main.accimJob

  • verboseMode – Inherited from class accim.sim.accis.addAccis

accim.sim.accim_VRFsystem.addDetHVACobj(self, EnergyPlus_version: str | None = None, verboseMode: bool = True, SupplyAirTempInputMethod: str | None = None, eer: float = 2, cop: float = 2.1, VRFschedule: str = 'On 24/7')[source]

Add Detailed HVAC objects for VRFsystem to work.

Parameters:

  • self – Used as a method for class accim.sim.accim_Main.accimJob

  • EnergyPlus_version – Inherited from class accim.sim.accis.addAccis

  • verboseMode – Inherited from class accim.sim.accis.addAccis

  • SupplyAirTempInputMethod – Inherited from class accim.sim.accis.addAccis

accim.sim.accim_VRFsystem.addForscriptSchVRFsystem(self, verboseMode: bool = True)[source]

Add AST Schedules for each zone for VRFsystem.

Parameters:

  • self – Used as a method for class accim.sim.accim_Main.accimJob

  • verboseMode – Inherited from :class:accim.sim.accis.addAccis

accim.sim.accim_VRFsystem.addOpTempTherm(self, verboseMode: bool = True)[source]

Amend ZoneControl:Thermostat:OperativeTemperature objects. Add ZoneControl:Thermostat:OperativeTemperature objects for each zone.

Parameters:

  • self – Used as a method for class accim.sim.accim_Main.accimJob

  • verboseMode – Inherited from class accim.sim.accis.addAccis

accim.sim.accim_VRFsystem.addVRFsystemSch(self, verboseMode: bool = True)[source]

Amend Schedule:Compact objects for VRFsystem. Add Schedule:Compact objects needed for VRFsystem to work, other than AHST_Sch and ACST_Sch Schedules.

Parameters:

  • self – Used as a method for class accim.sim.accim_Main.accimJob

  • verboseMode – Inherited from class accim.sim.accis.addAccis

accim.sim.accim_VRFsystem.checkVentIsOn(self, verboseMode: bool = True)[source]

Check ventilation settings.

Parameters:

  • self – Used as a method for :class:accim.sim.accim_Main.accimJob

  • verboseMode – Inherited from :class:accim.sim.accis.addAccis

accim.sim.accim_VRFsystem.setAvailSchOn(self, verboseMode: bool = True)[source]

Amend availability schedules. Assign On Compact:Schedule to heating and cooling availability schedule names.

Parameters:

  • self – Used as a method for class accim.sim.accim_Main.accimJob

  • verboseMode – Inherited from class accim.sim.accis.addAccis

accim.sim.accim_VRFsystem_EMS module

Add EMS objects only for VRFsystem.

accim.sim.accim_VRFsystem_EMS.addEMSSensorsVRFsystem(self, ScriptType: str | None = None, verboseMode: bool = True)[source]

Add EMS sensors for VRF system accim.

Parameters:

  • self – Used as a method for class accim.sim.accim_Main.accimJob

  • ScriptType – Inherited from class accim.sim.accis.addAccis

  • verboseMode – Inherited from class accim.sim.accis.addAccis

accim.sim.accis module

Run the function below to add the ACCIS.

This function transform fixed setpoint temperature building energy models into adaptive setpoint temperature energy models by adding the Adaptive Comfort Control Implementation Script (ACCIS)

class accim.sim.accis.addAccis(idfs: list | None = None, ScriptType: str | None = None, SupplyAirTempInputMethod: str | None = None, Output_type: str | None = None, Output_freqs: any | None = None, Output_keep_existing: bool | None = None, Output_gen_dataframe: bool | None = None, Output_take_dataframe: DataFrame | None = None, EnergyPlus_version: str = 'auto', TempCtrl: str | None = None, VRFschedule: str = 'On 24/7', ComfStand: any | None = None, CAT: any | None = None, CATcoolOffset: float = 0, CATheatOffset: float = 0, ComfMod: any | None = None, SetpointAcc: float = 10000, CustAST_ACSTaul: float = 0, CustAST_ACSTall: float = 0, CustAST_AHSTaul: float = 0, CustAST_AHSTall: float = 0, CustAST_m: float = 0, CustAST_n: float = 0, CustAST_ACSToffset: float = 0, CustAST_AHSToffset: float = 0, CoolSeasonStart: any = 121, CoolSeasonEnd: any = 274, HVACmode: any | None = None, VentCtrl: any | None = None, MaxTempDiffVOF: float = 6, MinTempDiffVOF: float = 1, MultiplierVOF: float = 0.25, VSToffset: any = [0], MinOToffset: any = [50], MaxWindSpeed: any = [50], ASTtol_start: float = 0.1, ASTtol_end_input: float = 0.1, ASTtol_steps: float = 0.1, NameSuffix: str = '', verboseMode: bool = True, confirmGen: bool | None = None, eer: float = 2, cop: float = 2.1, make_averages: bool = False, debugging: bool = False)[source]

Bases: object

Adds the Adaptive-Comfort-Control Implementation Script, which is an EnergyManagementSystem script that applies adaptive setpoint temperatures to EnergyPlus building energy models.

Parameters:

  • ScriptType (str) – The default is None. ‘vrf_ac’ for VRF system with full air-conditioning mode, ‘vrf_mm’ for VRF system with mixed-mode, ‘ex_ac’ for existing HVAC only with full air-conditioning mode, ‘ex_mm’ for existing HVAC with mixed-mode.

  • SupplyAirTempInputMethod (str) – The default is None. ‘supply air temperature’ or ‘temperature difference’ to use such supply air temperature input method in the VRF system. Only used if vrf_ac or vrf_mm are used.

  • Output_type (str) – The default is None. Can be ‘standard’, ‘simplified’, ‘detailed’ or ‘custom’.

  • Output_freqs (list) – The default is None. A list containing the following strings: [‘timestep’, ‘hourly’, ‘daily’, ‘monthly’, ‘runperiod’]

  • Output_keep_existing (bool) – The default is None. It is a boolean (True or False) to keep the existing Output:Variable objects or not.

  • Output_gen_dataframe (bool) – The default is None. It is a boolean (True or False) to generate a pandas DataFrame instance containing all Output:Variable objects.

  • Output_take_dataframe (bool) – It takes the pandas DataFrame previously generated with Output_gen_dataframe, which the user has filtered to keep only the rows related to the Output:Variable objects that need to be kept in the model.

  • EnergyPlus_version (str) – The default is ‘auto’. Can be ‘9.1’, ‘9.2’, ‘9.3’, ‘9.4’, ‘9.5’, ‘9.6’, ‘22.1’, ‘22.2’, ‘23.1’, ‘23.2’, ‘24.1’, ‘24.2’, ‘25.1’ or ‘auto’.

  • TempCtrl (str) – The default is None. Can be ‘temp’ or ‘pmv’.

  • ComfStand (list) – The default is None. ‘0 = ESP CTE; ‘1 = INT EN16798; ‘2 = INT ASHRAE55; ‘3 = JPN Rijal; ‘4 = CHN GBT50785 Cold; ‘5 = CHN GBT50785 HotMild; ‘6 = CHN Yang; ‘7 = IND IMAC C NV; ‘8 = IND IMAC C MM; ‘9 = IND IMAC R 7DRM; ‘10 = IND IMAC R 30DRM; ‘11 = IND Dhaka; ‘12 = ROM Udrea; ‘13 = AUS Williamson; ‘14 = AUS DeDear; ‘15 = BRA Rupp NV; ‘16 = BRA Rupp AC; ‘17 = MEX Oropeza Arid; ‘18 = MEX Oropeza DryTropic; ‘19 = MEX Oropeza Temperate; ‘20 = MEX Oropeza HumTropic; ‘21 = CHL Perez-Fargallo; ‘22 = INT ISO7730; ‘99 = CUSTOM;

  • CustAST_m (float) – The m coefficient (slope) of custom model linear regression (mx+n)

  • CustAST_n (float) – The n coefficient of custom model linear regression (mx+n)

  • CustAST_AHSToffset (float) – The offset for heating setpoint from neutral temperature for the custom model linear regression. This value will be summed, therefore, it must be negative.

  • CustAST_ACSToffset (float) – The offset for cooling setpoint from neutral temperature for the custom model linear regression. This value will be summed, therefore, it must be positive.

  • CustAST_ACSTaul (float) – The value for the cooling setpoint applicability upper limit (ACSTaul).

  • CustAST_ACSTall (float) – The value for the cooling setpoint applicability lower limit (ACSTall).

  • CustAST_AHSTaul (float) – The value for the heating setpoint applicability upper limit (AHSTaul).

  • CustAST_AHSTall (float) – The value for the heating setpoint applicability lower limit (AHSTall).

  • CAT (list) – The default is None. (1 = CAT I; 2 = CAT II; 3 = CAT III; 80 = 80% ACCEPT; 85 = 85% ACCEPT; 90 = 90% ACCEPT)

  • CATcoolOffset (float) – An offset to modify comfort models. This value is summed to the predefined cooling setpoint offset for the CAT value.

  • CATheatOffset (float) – An offset to modify comfort models. This value is summed to the predefined heating setpoint offset for the CAT value.

  • ComfMod (list) – The default is None. (0/0.X = Static; 1/1.X = Adaptive when applicable, otherwise relevant local static model; 2 = Adaptive when applicable, otherwise relevant international static model 3 = Adaptive when applicable, otherwise horizontal extention of adaptive setpoints)

  • SetpointAcc (float) – A float. It is the number for the accuracy of the setpoint temperatures. For instance, if 2 was used, setpoints would be rounded to every half Celsius degree; if 10 was used, the setpoints would be rounded to the first decimal.

  • CoolSeasonStart (any) – A date in format dd/mm, or the number of the day in the year. Defines when start the cooling season, only used in some static setpoint temperatures.

  • CoolSeasonEnd (any) – A date in format dd/mm, or the number of the day in the year. Defines when ends the cooling season, only used in some static setpoint temperatures.

  • HVACmode (list) – The default is None. (0 = Fully Air-conditioned; 1 = Naturally ventilated; 2 = Mixed Mode)

  • VentCtrl (list) – The default is None. (if HVACmode = 1: 0 = Ventilates above neutral temperature; 1 = Ventilates above upper comfort limit; if HVACmode = 2: 0 = Ventilates above neutral temperature and fully opens doors and windows; 1 = Ventilates above lower comfort limit and fully opens doors and windows; 2 = Ventilates above neutral temperature and opens doors and windows based on the customised venting opening factor; 3 = Ventilates above lower comfort limit and opens doors and windows based on the customised venting opening factor; )

  • MaxTempDiffVOF (float) – The maximum temperature difference for the Venting Opening Factor. Must be a number greater than 0.

  • MinTempDiffVOF (float) – The minimum temperature difference for the Venting Opening Factor. Must be a number greater than 0 and smaller than the maximum temperature difference.

  • MultiplierVOF (float) – The multiplier for the modulation of the Venting Opening Factor. Must be a number between 0 and 1.

  • VSToffset (list) – The default is 0. Please refer to documentation.

  • MinOToffset (list) – The default is 50. Please refer to documentation.

  • MaxWindSpeed (list) – The default is 50. Please refer to documentation.

  • ASTtol_start (float) – The default is 0.1. Please refer to documentation.

  • ASTtol_end_input (float) – The default is 0.1. Please refer to documentation.

  • ASTtol_steps (float) – The default is 0.1. Please refer to documentation.

  • NameSuffix (str) – The default is ‘’ (an empty string). Please refer to documentation.

  • eer – The energy efficiency ratio of the VRF system for each zone,

added when using ScriptType vrf_mm or vrf_ac :type: eer: int :param cop: The coefficient of performance of the VRF system for each zone, added when using ScriptType vrf_mm or vrf_ac :type: cop: int :param make_averages: Used to make averages of hour-counting variables. :type make_averages: bool :param debugging: If True, an Output:EnergyManagementSystem object is used

to generate the EDD file.

Parameters:

  • verboseMode (bool) – True to print the process on screen. Default is True.

  • confirmGen (bool) – True to skip confirmation of output IDF generation. Default is None.

Variables:

  • arguments – A dictionary containing all arguments

  • df_outputs – the pandas DataFrame instance created with argument Output_gen_dataframe

  • input_idfs – A dictionary containing all input IDFs following the format {‘input idf filename’: class eppy.modeleditor.IDF object}

  • occupied_zones – A dictionary containing all input idfs and occupied zone names following the format {‘idf filename’: [list of zone names]}

  • occupied_zones_original_name – A dictionary containing all input idfs and occupied zone original names following the format {‘idf filename’: [list of zone original names]}

  • output_idfs – A dictionary containing all output IDFs following the format {‘output idf filename’: class eppy.modeleditor.IDF object}

  • windows_and_doors – A dictionary containing all input idfs and window and door names following the format {‘idf filename’: [list of window and door names]}

  • windows_and_doors_original_name – A dictionary containing all input idfs and window and door original names following the format {‘idf filename’: [list of window and door original names]}

accim.sim.accis_single_idf module

Run the function below to add the ACCIS.

This function transform fixed setpoint temperature building energy models into adaptive setpoint temperature energy models by adding the Adaptive Comfort Control Implementation Script (ACCIS)

class accim.sim.accis_single_idf.addAccis(idf: <module 'besos.IDF_class' from '/home/docs/checkouts/readthedocs.org/user_builds/accim/envs/v0.7.6/lib/python3.9/site-packages/besos/IDF_class.py'> = None, ScriptType: str = None, SupplyAirTempInputMethod: str = None, Output_type: str = None, Output_freqs: any = None, Output_keep_existing: bool = None, Output_gen_dataframe: bool = None, Output_take_dataframe: ~pandas.core.frame.DataFrame = None, EnergyPlus_version: str = None, TempCtrl: str = None, VRFschedule: str = 'On 24/7', verboseMode: bool = True, eer: float = 2, cop: float = 2.1, make_averages: bool = False, debugging: bool = False)[source]

Bases: object

Adds the Adaptive-Comfort-Control Implementation Script, which is an EnergyManagementSystem script that applies adaptive setpoint temperatures to EnergyPlus building energy models.

Parameters:

  • ScriptType (str) – The default is None. ‘vrf_ac’ for VRF system with full air-conditioning mode, ‘vrf_mm’ for VRF system with mixed-mode, ‘ex_ac’ for existing HVAC only with full air-conditioning mode, ‘ex_mm’ for existing HVAC with mixed-mode.

  • SupplyAirTempInputMethod (str) – The default is None. ‘supply air temperature’ or ‘temperature difference’ to use such supply air temperature input method in the VRF system. Only used if vrf_ac or vrf_mm are used.

  • Output_type (str) – The default is None. Can be ‘standard’, ‘simplified’, ‘detailed’ or ‘custom’.

  • Output_freqs (list) – The default is None. A list containing the following strings: [‘timestep’, ‘hourly’, ‘daily’, ‘monthly’, ‘runperiod’]

  • Output_keep_existing (bool) – The default is None. It is a boolean (True or False) to keep the existing Output:Variable objects or not.

  • Output_gen_dataframe (bool) – The default is None. It is a boolean (True or False) to generate a pandas DataFrame instance containing all Output:Variable objects.

  • Output_take_dataframe (bool) – It takes the pandas DataFrame previously generated with Output_gen_dataframe, which the user has filtered to keep only the rows related to the Output:Variable objects that need to be kept in the model.

  • EnergyPlus_version (str) – The default is None. Can be ‘9.1’, ‘9.2’, ‘9.3’, ‘9.4’, ‘9.5’, ‘9.6’, ‘22.1’, ‘22.2’, ‘23.1’, ‘23.2’, ‘24.1’, ‘24.2’, ‘25.1’ or ‘auto’.

  • TempCtrl (str) – The default is None. Can be ‘temp’ or ‘pmv’.

  • verboseMode (bool) – True to print the process on screen. Default is True.

  • eer – The energy efficiency ratio of the VRF system for each zone,

added when using ScriptType vrf_mm or vrf_ac :type: eer: int :param cop: The coefficient of performance of the VRF system for each zone, added when using ScriptType vrf_mm or vrf_ac :type: cop: int :param make_averages: Used to make averages of hour-counting variables. :type make_averages: bool :param debugging: If True, an Output:EnergyManagementSystem object is used

to generate the EDD file.

Variables:

  • arguments – A dictionary containing all arguments

  • df_outputs – the pandas DataFrame instance created with argument Output_gen_dataframe

  • occupied_zones – A list containing all occupied zone names within the input idf.

  • occupied_zones_original_name – A list containing all occupied zone original names within the input idf.

  • windows_and_doors – A list containing all window and door names within the input idf.

  • windows_and_doors_original_name – A list containing all window and door original names within the input idf.

modifyAccis(ComfStand: int | None = None, CAT: int | None = None, CATcoolOffset: float = 0, CATheatOffset: float = 0, ComfMod: float | None = None, SetpointAcc: float = 10000, CustAST_ACSTaul: float = 0, CustAST_ACSTall: float = 0, CustAST_AHSTaul: float = 0, CustAST_AHSTall: float = 0, CustAST_m: float = 0, CustAST_n: float = 0, CustAST_ACSToffset: float = 0, CustAST_AHSToffset: float = 0, CoolSeasonStart: any = 121, CoolSeasonEnd: any = 274, HVACmode: int | None = None, VentCtrl: int | None = None, MaxTempDiffVOF: float = 6, MinTempDiffVOF: float = 1, MultiplierVOF: float = 0.25, VSToffset: int = 0, MinOToffset: int = 50, MaxWindSpeed: int = 50, ASTtol: int = 0.1)[source]
Parameters:

  • ComfStand (int) – The default is None. ‘0 = ESP CTE; ‘1 = INT EN16798; ‘2 = INT ASHRAE55; ‘3 = JPN Rijal; ‘4 = CHN GBT50785 Cold; ‘5 = CHN GBT50785 HotMild; ‘6 = CHN Yang; ‘7 = IND IMAC C NV; ‘8 = IND IMAC C MM; ‘9 = IND IMAC R 7DRM; ‘10 = IND IMAC R 30DRM; ‘11 = IND Dhaka; ‘12 = ROM Udrea; ‘13 = AUS Williamson; ‘14 = AUS DeDear; ‘15 = BRA Rupp NV; ‘16 = BRA Rupp AC; ‘17 = MEX Oropeza Arid; ‘18 = MEX Oropeza DryTropic; ‘19 = MEX Oropeza Temperate; ‘20 = MEX Oropeza HumTropic; ‘21 = CHL Perez-Fargallo; ‘22 = INT ISO7730

  • CAT (int) – The default is None. (1 = CAT I; 2 = CAT II; 3 = CAT III; 80 = 80% ACCEPT; 85 = 85% ACCEPT; 90 = 90% ACCEPT)

  • ComfMod (float) – The default is None. (0/0.X = Static; 1/1.X = Adaptive when applicable, otherwise relevant local static model; 2 = Adaptive when applicable, otherwise relevant international static model 3 = Adaptive when applicable, otherwise horizontal extention of adaptive setpoints)

  • SetpointAcc (float) – A float. It is the number for the accuracy of the setpoint temperatures. For instance, if 2 was used, setpoints would be rounded to every half Celsius degree; if 10 was used, the setpoints would be rounded to the first decimal.

  • CoolSeasonStart (any) – A date in format dd/mm, or the number of the day in the year. Defines when start the cooling season, only used in some static setpoint temperatures.

  • CoolSeasonEnd (any) – A date in format dd/mm, or the number of the day in the year. Defines when ends the cooling season, only used in some static setpoint temperatures.

  • HVACmode (int) – The default is None. (0 = Fully Air-conditioned; 1 = Naturally ventilated; 2 = Mixed Mode)

  • VentCtrl (int) – The default is None. (if HVACmode = 1: 0 = Ventilates above neutral temperature; 1 = Ventilates above upper comfort limit; if HVACmode = 2: 0 = Ventilates above neutral temperature and fully opens doors and windows; 1 = Ventilates above lower comfort limit and fully opens doors and windows; 2 = Ventilates above neutral temperature and opens doors and windows based on the customised venting opening factor; 3 = Ventilates above lower comfort limit and opens doors and windows based on the customised venting opening factor; )

  • MaxTempDiffVOF (float) – The maximum temperature difference for the Venting Opening Factor. Must be a number greater than 0.

  • MinTempDiffVOF (float) – The minimum temperature difference for the Venting Opening Factor. Must be a number greater than 0 and smaller than the maximum temperature difference.

  • MultiplierVOF (float) – The multiplier for the modulation of the Venting Opening Factor. Must be a number between 0 and 1.

  • VSToffset (float) – The default is 0. Please refer to documentation.

  • MinOToffset (float) – The default is 50. Please refer to documentation.

  • MaxWindSpeed (float) – The default is 50. Please refer to documentation.

  • ASTtol (float) – The default is 0.1. Please refer to documentation.

accim.sim.accis_single_idf_funcs module

Run the function below to add the ACCIS.

This function transform fixed setpoint temperature building energy models into adaptive setpoint temperature energy models by adding the Adaptive Comfort Control Implementation Script (ACCIS)

accim.sim.accis_single_idf_funcs.addAccis(idf: <module 'besos.IDF_class' from '/home/docs/checkouts/readthedocs.org/user_builds/accim/envs/v0.7.6/lib/python3.9/site-packages/besos/IDF_class.py'> = None, ScriptType: str = None, SupplyAirTempInputMethod: str = None, Output_type: str = None, Output_freqs: any = None, Output_keep_existing: bool = None, Output_take_dataframe: ~pandas.core.frame.DataFrame = None, EnergyPlus_version: str = None, TempCtrl: str = None, VRFschedule: str = 'On 24/7', verboseMode: bool = True, eer: float = 2, cop: float = 2.1, make_averages: bool = False, debugging: bool = False)[source]

Adds the Adaptive-Comfort-Control Implementation Script, which is an EnergyManagementSystem script that applies adaptive setpoint temperatures to EnergyPlus building energy models.

Parameters:

  • idf (besos.IDF_class) – The besos or eppy IDF class instance.

  • ScriptType (str) – The default is None. ‘vrf_ac’ for VRF system with full air-conditioning mode, ‘vrf_mm’ for VRF system with mixed-mode, ‘ex_ac’ for existing HVAC only with full air-conditioning mode, ‘ex_mm’ for existing HVAC with mixed-mode.

  • SupplyAirTempInputMethod (str) – The default is None. ‘supply air temperature’ or ‘temperature difference’ to use such supply air temperature input method in the VRF system. Only used if vrf_ac or vrf_mm are used.

  • Output_type (str) – The default is None. Can be ‘standard’, ‘simplified’, ‘detailed’ or ‘custom’.

  • Output_freqs (list) – The default is None. A list containing the following strings: [‘timestep’, ‘hourly’, ‘daily’, ‘monthly’, ‘runperiod’]

  • Output_keep_existing (bool) – The default is None. It is a boolean (True or False) to keep the existing Output:Variable objects or not.

  • Output_gen_dataframe (bool) – The default is None. It is a boolean (True or False) to generate a pandas DataFrame instance containing all Output:Variable objects.

  • Output_take_dataframe (bool) – It takes the pandas DataFrame previously generated with Output_gen_dataframe, which the user has filtered to keep only the rows related to the Output:Variable objects that need to be kept in the model.

  • EnergyPlus_version (str) – The default is None. Can be ‘9.1’, ‘9.2’, ‘9.3’, ‘9.4’, ‘9.5’, ‘9.6’, ‘22.1’, ‘22.2’, ‘23.1’, ‘23.2’, ‘24.1’, ‘24.2’, ‘25.1’ or ‘auto’.

  • TempCtrl (str) – The default is None. Can be ‘temp’ or ‘pmv’.

  • verboseMode (bool) – True to print the process on screen. Default is True.

  • eer – The energy efficiency ratio of the VRF system for each zone,

added when using ScriptType vrf_mm or vrf_ac :type: eer: int :param cop: The coefficient of performance of the VRF system for each zone, added when using ScriptType vrf_mm or vrf_ac :type: cop: int :param make_averages: Used to make averages of hour-counting variables. :type make_averages: bool :param debugging: If True, an Output:EnergyManagementSystem object is used

to generate the EDD file.

Variables:

  • arguments – A dictionary containing all arguments

  • df_outputs – the pandas DataFrame instance created with argument Output_gen_dataframe

  • occupied_zones – A list containing all occupied zone names within the input idf.

  • occupied_zones_original_name – A list containing all occupied zone original names within the input idf.

  • windows_and_doors – A list containing all window and door names within the input idf.

  • windows_and_doors_original_name – A list containing all window and door original names within the input idf.

accim.sim.accis_single_idf_funcs.gen_outputs_df(idf: <module 'besos.IDF_class' from '/home/docs/checkouts/readthedocs.org/user_builds/accim/envs/v0.7.6/lib/python3.9/site-packages/besos/IDF_class.py'> = None, ScriptType: str = None, Output_type: str = None, Output_freqs: any = None, Output_keep_existing: bool = None, TempCtrl: str = None, make_averages: bool = False, verboseMode: bool = False) → DataFrame[source]

Returns a pandas.Dataframe instance which contains the Output:Variable objects in the idf.

Parameters:

  • idf (besos.IDF_class) – The besos or eppy IDF class instance.

  • ScriptType (str) – The default is None. ‘vrf_ac’ for VRF system with full air-conditioning mode, ‘vrf_mm’ for VRF system with mixed-mode, ‘ex_ac’ for existing HVAC only with full air-conditioning mode, ‘ex_mm’ for existing HVAC with mixed-mode.

  • Output_type (str) – The default is None. Can be ‘standard’, ‘simplified’, ‘detailed’ or ‘custom’.

  • Output_freqs (list) – The default is None. A list containing the following strings: [‘timestep’, ‘hourly’, ‘daily’, ‘monthly’, ‘runperiod’]

  • Output_keep_existing (bool) – The default is None. It is a boolean (True or False) to keep the existing Output:Variable objects or not.

  • TempCtrl (str) – The default is None. Can be ‘temp’ or ‘pmv’.

  • make_averages (bool) – Used to make averages of hour-counting variables.

  • verboseMode (bool) – True to print the process on screen. Default is True.

Returns:

pandas.Dataframe instance which contains the Output:Variable objects in the idf

accim.sim.accis_single_idf_funcs.modifyAccis(idf, ComfStand: int | None = None, CAT: int | None = None, CATcoolOffset: float = 0, CATheatOffset: float = 0, ComfMod: float | None = None, SetpointAcc: float = 10000, CustAST_ACSTaul: float = 0, CustAST_ACSTall: float = 0, CustAST_AHSTaul: float = 0, CustAST_AHSTall: float = 0, CustAST_m: float = 0, CustAST_n: float = 0, CustAST_ACSToffset: float = 0, CustAST_AHSToffset: float = 0, CoolSeasonStart: any = 121, CoolSeasonEnd: any = 274, HVACmode: int | None = None, VentCtrl: int | None = None, MaxTempDiffVOF: float = 6, MinTempDiffVOF: float = 1, MultiplierVOF: float = 0.25, VSToffset: int = 0, MinOToffset: int = 50, MaxWindSpeed: int = 50, ASTtol: int = 0.1)[source]
Parameters:

  • ComfStand (int) – The default is None. ‘0 = ESP CTE; ‘1 = INT EN16798; ‘2 = INT ASHRAE55; ‘3 = JPN Rijal; ‘4 = CHN GBT50785 Cold; ‘5 = CHN GBT50785 HotMild; ‘6 = CHN Yang; ‘7 = IND IMAC C NV; ‘8 = IND IMAC C MM; ‘9 = IND IMAC R 7DRM; ‘10 = IND IMAC R 30DRM; ‘11 = IND Dhaka; ‘12 = ROM Udrea; ‘13 = AUS Williamson; ‘14 = AUS DeDear; ‘15 = BRA Rupp NV; ‘16 = BRA Rupp AC; ‘17 = MEX Oropeza Arid; ‘18 = MEX Oropeza DryTropic; ‘19 = MEX Oropeza Temperate; ‘20 = MEX Oropeza HumTropic; ‘21 = CHL Perez-Fargallo; ‘22 = INT ISO7730

  • CustAST_m (float) – The m coefficient (slope) of custom model linear regression (mx+n)

  • CustAST_n (float) – The n coefficient of custom model linear regression (mx+n)

  • CustAST_AHSToffset (float) – The offset for heating setpoint from neutral temperature for the custom model linear regression. This value will be summed, therefore, it must be negative.

  • CustAST_ACSToffset (float) – The offset for cooling setpoint from neutral temperature for the custom model linear regression. This value will be summed, therefore, it must be positive.

  • CustAST_ACSTaul (float) – The value for the cooling setpoint applicability upper limit (ACSTaul).

  • CustAST_ACSTall (float) – The value for the cooling setpoint applicability lower limit (ACSTall).

  • CustAST_AHSTaul (float) – The value for the heating setpoint applicability upper limit (AHSTaul).

  • CustAST_AHSTall (float) – The value for the heating setpoint applicability lower limit (AHSTall).

  • CAT (int) – The default is None. (1 = CAT I; 2 = CAT II; 3 = CAT III; 80 = 80% ACCEPT; 85 = 85% ACCEPT; 90 = 90% ACCEPT)

  • CATcoolOffset (float) – An offset to modify comfort models. This value is summed to the predefined cooling setpoint offset for the CAT value.

  • CATheatOffset (float) – An offset to modify comfort models. This value is summed to the predefined heating setpoint offset for the CAT value.

  • ComfMod (float) – The default is None. (0/0.X = Static; 1/1.X = Adaptive when applicable, otherwise relevant local static model; 2 = Adaptive when applicable, otherwise relevant international static model 3 = Adaptive when applicable, otherwise horizontal extention of adaptive setpoints)

  • SetpointAcc (float) – A float. It is the number for the accuracy of the setpoint temperatures. For instance, if 2 was used, setpoints would be rounded to every half Celsius degree; if 10 was used, the setpoints would be rounded to the first decimal.

  • CoolSeasonStart (any) – A date in format dd/mm, or the number of the day in the year. Defines when start the cooling season, only used in some static setpoint temperatures.

  • CoolSeasonEnd (any) – A date in format dd/mm, or the number of the day in the year. Defines when ends the cooling season, only used in some static setpoint temperatures.

  • HVACmode (int) – The default is None. (0 = Fully Air-conditioned; 1 = Naturally ventilated; 2 = Mixed Mode)

  • VentCtrl (int) – The default is None. (if HVACmode = 1: 0 = Ventilates above neutral temperature; 1 = Ventilates above upper comfort limit; if HVACmode = 2: 0 = Ventilates above neutral temperature and fully opens doors and windows; 1 = Ventilates above lower comfort limit and fully opens doors and windows; 2 = Ventilates above neutral temperature and opens doors and windows based on the customised venting opening factor; 3 = Ventilates above lower comfort limit and opens doors and windows based on the customised venting opening factor; )

  • MaxTempDiffVOF (float) – The maximum temperature difference for the Venting Opening Factor. Must be a number greater than 0.

  • MinTempDiffVOF (float) – The minimum temperature difference for the Venting Opening Factor. Must be a number greater than 0 and smaller than the maximum temperature difference.

  • MultiplierVOF (float) – The multiplier for the modulation of the Venting Opening Factor. Must be a number between 0 and 1.

  • VSToffset (float) – The default is 0. Please refer to documentation.

  • MinOToffset (float) – The default is 50. Please refer to documentation.

  • MaxWindSpeed (float) – The default is 50. Please refer to documentation.

  • ASTtol (float) – The default is 0.1. Please refer to documentation.

accim.sim.accis_single_idf_funcs.modify_param(idf, parameter, value)[source]

accim.sim.apmv_setpoints module

Contains the functions to apply setpoints based on the Adaptive Predicted Mean Vote (aPMV) index. Unified version supporting EnergyPlus versions pre and post 23.1.

This module implements a robust logic to identify target zones or spaces based on the Global Model Hierarchy (Space > ZoneList > Zone) and generates the necessary EnergyManagementSystem (EMS) objects to control thermal comfort dynamically.

accim.sim.apmv_setpoints.add_ems_debug_output(building: IDF, verbose_mode: bool = True)[source]

Adds an Output:EnergyManagementSystem object to the IDF.

This object enables verbose reporting in the EnergyPlus output files (specifically the .edd file). It is essential for debugging EMS scripts, as it lists all available actuators, internal variables, and runtime errors.

Configuration applied: - Actuator Availability: Verbose - Internal Variable Availability: Verbose - EMS Runtime Language Debug Output Level: Verbose

Parameters:

  • building – The BESOS/eppy IDF object.

  • verbose_mode – If True, prints success messages. Warnings are always printed.

accim.sim.apmv_setpoints.add_vrf_system(building: IDF, SupplyAirTempInputMethod: str = 'supply air temperature', eer: float = 2, cop: float = 2.1, VRFschedule: str = 'On 24/7', verbose_mode: bool = True)[source]

Adds a Variable Refrigerant Flow (VRF) system to the model using the accim_Main module. This is a helper wrapper to facilitate HVAC integration.

Parameters:

  • building – The BESOS/eppy IDF object.

  • SupplyAirTempInputMethod – Method for supply air temperature (‘supply air temperature’ or ‘temperature difference’).

  • eer – Energy Efficiency Ratio for cooling.

  • cop – Coefficient of Performance for heating.

  • VRFschedule – Name of the availability schedule for the VRF system.

  • verbose_mode – If True, prints progress from the accim_Main job.

accim.sim.apmv_setpoints.apply_apmv_setpoints(building: IDF, outputs_freq: List[str] = ['hourly'], other_PMV_related_outputs: bool = True, adap_coeff_cooling: float | dict = 0.293, adap_coeff_heating: float | dict = -0.293, pmv_cooling_sp: float | dict = -0.5, pmv_heating_sp: float | dict = 0.5, tolerance_cooling_sp_cooling_season: float | dict = -0.1, tolerance_cooling_sp_heating_season: float | dict = -0.1, tolerance_heating_sp_cooling_season: float | dict = 0.1, tolerance_heating_sp_heating_season: float | dict = 0.1, cooling_season_start: float | str = 120, cooling_season_end: float | str = 210, dflt_for_adap_coeff_cooling: float = 0.4, dflt_for_adap_coeff_heating: float = -0.4, dflt_for_pmv_cooling_sp: float = 0.5, dflt_for_pmv_heating_sp: float = -0.5, dflt_for_tolerance_cooling_sp_cooling_season: float = -0.1, dflt_for_tolerance_cooling_sp_heating_season: float = -0.1, dflt_for_tolerance_heating_sp_cooling_season: float = 0.1, dflt_for_tolerance_heating_sp_heating_season: float = 0.1, verbose_mode: bool = True) → IDF[source]

Applies setpoints based on the Adaptive Predicted Mean Vote (aPMV) index.

This function modifies the EnergyPlus IDF model to include an Energy Management System (EMS) control logic. It calculates the aPMV in real-time and adjusts the heating and cooling setpoints dynamically to maintain thermal comfort within the specified adaptive limits.

It supports both legacy EnergyPlus versions (Zone-based) and modern versions (Space-based), automatically resolving the model hierarchy.

Parameters:

  • building – The BESOS/eppy IDF object to be modified.

  • outputs_freq – List of reporting frequencies for the output variables (e.g., [‘hourly’, ‘timestep’]).

  • other_PMV_related_outputs – If True, adds additional comfort-related output variables (e.g., Fanger PMV, PPD).

  • adap_coeff_cooling – Adaptive coefficient (lambda) for cooling. Can be a single float (applied globally) or a dict {TargetName: Value}.

  • adap_coeff_heating – Adaptive coefficient (lambda) for heating. Float or Dict {TargetName: Value}.

  • pmv_cooling_sp – Target PMV setpoint for cooling (e.g., 0.5). Float or Dict.

  • pmv_heating_sp – Target PMV setpoint for heating (e.g., -0.5). Float or Dict.

  • tolerance_cooling_sp_cooling_season – Tolerance to widen the cooling setpoint band during cooling season.

  • tolerance_cooling_sp_heating_season – Tolerance to widen the cooling setpoint band during heating season.

  • tolerance_heating_sp_cooling_season – Tolerance to widen the heating setpoint band during cooling season.

  • tolerance_heating_sp_heating_season – Tolerance to widen the heating setpoint band during heating season.

  • cooling_season_start – Start day of the cooling season. Can be an integer (Day of Year) or string (‘dd/mm’).

  • cooling_season_end – End day of the cooling season. Can be an integer (Day of Year) or string (‘dd/mm’).

  • dflt_for_adap_coeff_cooling – Default value for cooling adaptive coefficient if key is missing in dict input.

  • dflt_for_adap_coeff_heating – Default value for heating adaptive coefficient if key is missing in dict input.

  • dflt_for_pmv_cooling_sp – Default value for cooling PMV setpoint if key is missing in dict input.

  • dflt_for_pmv_heating_sp – Default value for heating PMV setpoint if key is missing in dict input.

  • dflt_for_tolerance_cooling_sp_cooling_season – Default tolerance value if key is missing.

  • dflt_for_tolerance_cooling_sp_heating_season – Default tolerance value if key is missing.

  • dflt_for_tolerance_heating_sp_cooling_season – Default tolerance value if key is missing.

  • dflt_for_tolerance_heating_sp_heating_season – Default tolerance value if key is missing.

  • verbose_mode – If True, prints detailed progress messages (added objects) and warnings to the console.

Returns:

The modified BESOS IDF object with EMS controls added.

accim.sim.apmv_setpoints.change_adaptive_coeff(building: IDF, df_arguments: DataFrame)[source]

Updates the adaptive coefficients in the existing EMS programs based on a new DataFrame. This allows modifying parameters (e.g., for optimization) without regenerating the entire EMS structure from scratch.

Parameters:

  • building – The BESOS/eppy IDF object.

  • df_arguments – DataFrame containing the new coefficients, indexed by target key.

accim.sim.apmv_setpoints.generate_df_from_args(target_keys_input: List[str], ems_suffixes: List[str], adap_coeff_cooling: float | Dict[str, float], adap_coeff_heating: float | Dict[str, float], pmv_cooling_sp: float | Dict[str, float], pmv_heating_sp: float | Dict[str, float], tolerance_cooling_sp_cooling_season: float | Dict[str, float], tolerance_cooling_sp_heating_season: float | Dict[str, float], tolerance_heating_sp_cooling_season: float | Dict[str, float], tolerance_heating_sp_heating_season: float | Dict[str, float], dflt_for_adap_coeff_cooling: float, dflt_for_adap_coeff_heating: float, dflt_for_pmv_cooling_sp: float, dflt_for_pmv_heating_sp: float, dflt_for_tolerance_cooling_sp_cooling_season: float, dflt_for_tolerance_cooling_sp_heating_season: float, dflt_for_tolerance_heating_sp_cooling_season: float, dflt_for_tolerance_heating_sp_heating_season: float) → DataFrame[source]

Maps user input arguments (which can be single floats or dictionaries) to the resolved target keys. It creates a pandas DataFrame where each row corresponds to a target (Space/Zone) and columns correspond to the simulation parameters.

Parameters:

  • target_keys_input – List of unique keys identifying the targets (e.g., “Space1 People”).

  • ems_suffixes – List of sanitized suffixes corresponding to the keys (e.g., “Space1_People”).

  • adap_coeff_* – Adaptive coefficients for cooling/heating.

  • pmv_*_sp – PMV setpoints for cooling/heating.

  • tolerance_* – Tolerance bands for different seasons and modes.

  • dflt_* – Default values to use if a specific key is missing in the dictionary inputs.

Returns:

A pandas DataFrame indexed by target keys, containing all parameters and the ‘underscore_zonename’.

accim.sim.apmv_setpoints.get_available_target_names(building: IDF) → List[str][source]

Identifies and returns a list of valid target names (keys) for the current model. These keys are what the user should use in the input dictionaries (e.g., adap_coeff_cooling).

Parameters:

building – The BESOS/eppy IDF object.

Returns:

A list of strings representing the valid keys (e.g., [‘Space1 People’, ‘Space2 People’]).

accim.sim.apmv_setpoints.get_input_template_dictionary(building: IDF) → Dict[str, str][source]

Generates a template dictionary with all valid target keys and placeholder values. Useful for the user to know exactly which keys to populate.

Parameters:

building – The BESOS/eppy IDF object.

Returns:

A dictionary {target_name: “replace-me-with-float-value”}.

accim.sim.apmv_setpoints.set_pmv_input_parameters(building: <module 'besos.IDF_class' from '/home/docs/checkouts/readthedocs.org/user_builds/accim/envs/v0.7.6/lib/python3.9/site-packages/besos/IDF_class.py'>, activity_level: float | ~typing.Dict[str, float] | None = None, clothing_insulation: float | ~typing.Dict[str, float] | None = None, air_velocity: float | ~typing.Dict[str, float] | None = None, work_efficiency: float | ~typing.Dict[str, float] | None = None, verbose_mode: bool = True)[source]

Modifies ‘People’ objects in the IDF to set the parameters that influence the PMV calculation.

It creates ‘Schedule:Compact’ objects for the specified parameters and assigns them to the People objects.

IMPORTANT: If a parameter is set to None (default), it will NOT be modified in the IDF. This allows you to update only specific parameters (e.g., just air velocity) without overwriting existing schedules for activity or clothing.

Parameters:

  • building – The BESOS/eppy IDF object.

  • activity_level – Metabolic rate in W/person. If None, ignores this parameter.

  • clothing_insulation – Clothing insulation in clo units. If None, ignores this parameter.

  • air_velocity – Air velocity in m/s. If None, ignores this parameter.

  • work_efficiency – Work efficiency (0.0 - 1.0). If None, ignores this parameter.

  • verbose_mode – If True, prints created schedules to console.

accim.sim.apmv_setpoints.set_zones_always_occupied(building: IDF, verbose_mode: bool = True)[source]

Sets the occupancy schedule of all ‘People’ objects to ‘On’ (always occupied). If the ‘On’ schedule does not exist, it creates it.

Parameters:

  • building – The BESOS/eppy IDF object.

  • verbose_mode – If True, prints success messages. Warnings are always printed.

accim.sim.chile_funcs module

Functions for building energy modelling research in Chile

accim.sim.chile_funcs.apply_heating_activation_time_sch(idf_path: str, apply_to_occupancy: bool = True) → object[source]

Applies the heating activation time for Chile. See reference: https://www.sciencedirect.com/science/article/pii/S0378778823003833

Parameters:

  • idf_path (IDF_class) – The eppy or besos idf class instance.

  • apply_to_occupancy (bool) – True to apply the same schedule to the occupancy.

accim.sim.dicts module

Dictionaries to be used in multiple files

accim.sim.lists module

accim.sim.utils module

accim.sim.utils.add_vrf_system(z, TempCtrl, verboseMode, EnergyPlus_version, SupplyAirTempInputMethod, eer, cop, VRFschedule)[source]
accim.sim.utils.scan_zones(self)[source]

Used to scan the occupied zones in an idf.

Module contents