accim package

Subpackages

• accim.data package
  • Subpackages
    • accim.data.postprocessing package
      • Submodules
      • accim.data.postprocessing.main module
      • accim.data.postprocessing.utils module
      • Module contents
  • Submodules
  • accim.data.morphing module
    • morph_epws()
  • accim.data.preprocessing module
  • Module contents
• accim.parametric_and_optimisation package
  • Subpackages
    • accim.parametric_and_optimisation.funcs_for_besos package
      • Submodules
      • accim.parametric_and_optimisation.funcs_for_besos.param_accis module
      • accim.parametric_and_optimisation.funcs_for_besos.param_apmv module
      • Module contents
  • Submodules
  • accim.parametric_and_optimisation.main module
    • AccimPredefModelsParamSim
    • OptimParamSimulation
      • OptimParamSimulation.get_available_parameters()
      • OptimParamSimulation.get_hourly_df()
      • OptimParamSimulation.get_hourly_df_columns()
      • OptimParamSimulation.get_output_meter_df_from_idf()
      • OptimParamSimulation.get_output_var_df_from_idf()
      • OptimParamSimulation.get_outputs_df_from_testsim()
      • OptimParamSimulation.run_optimisation()
      • OptimParamSimulation.run_parametric_simulation()
      • OptimParamSimulation.sampling_full_factorial()
      • OptimParamSimulation.sampling_full_set()
      • OptimParamSimulation.sampling_lhs()
      • OptimParamSimulation.set_evaluator()
      • OptimParamSimulation.set_output_met_objects_to_idf()
      • OptimParamSimulation.set_output_var_df_to_idf()
      • OptimParamSimulation.set_outputs_for_simulation()
      • OptimParamSimulation.set_parameters()
      • OptimParamSimulation.set_problem()
    • get_mdd_file_as_df()
    • get_rdd_file_as_df()
    • parse_mtd_file()
  • accim.parametric_and_optimisation.objectives module
    • average_results()
    • return_time_series()
    • sum_results()
  • accim.parametric_and_optimisation.parameters module
    • ASTtol
      • ASTtol.modify()
    • CAT
      • CAT.modify()
    • CATcoolOffset
      • CATcoolOffset.modify()
    • CATheatOffset
      • CATheatOffset.modify()
    • ComfMod
      • ComfMod.modify()
    • ComfStand
      • ComfStand.modify()
    • CoolSeasonEnd
      • CoolSeasonEnd.modify()
    • CoolSeasonStart
      • CoolSeasonStart.modify()
    • CustAST_ACSTall
      • CustAST_ACSTall.modify()
    • CustAST_ACSTaul
      • CustAST_ACSTaul.modify()
    • CustAST_ACSToffset
      • CustAST_ACSToffset.modify()
    • CustAST_AHSTall
      • CustAST_AHSTall.modify()
    • CustAST_AHSTaul
      • CustAST_AHSTaul.modify()
    • CustAST_AHSToffset
      • CustAST_AHSToffset.modify()
    • CustAST_ASTall
      • CustAST_ASTall.modify()
    • CustAST_ASTaul
      • CustAST_ASTaul.modify()
    • CustAST_ASToffset
      • CustAST_ASToffset.modify()
    • CustAST_m
      • CustAST_m.modify()
    • CustAST_n
      • CustAST_n.modify()
    • HVACmode
      • HVACmode.modify()
    • MaxTempDiffVOF
      • MaxTempDiffVOF.modify()
    • MaxWindSpeed
      • MaxWindSpeed.modify()
    • MinOToffset
      • MinOToffset.modify()
    • MinTempDiffVOF
      • MinTempDiffVOF.modify()
    • MultiplierVOF
      • MultiplierVOF.modify()
    • Parameter
      • Parameter.modify()
    • SetpointAcc
      • SetpointAcc.modify()
    • VSToffset
      • VSToffset.modify()
    • VentCtrl
      • VentCtrl.modify()
    • accis_parameter()
    • get_available_params_accim_custom_models()
    • get_available_params_accim_predef_models()
    • get_available_params_apmv_setpoints()
  • accim.parametric_and_optimisation.params_dicts module
  • accim.parametric_and_optimisation.utils module
    • descriptor_has_options()
    • expand_to_hourly_dataframe()
    • identify_hourly_columns()
    • make_all_combinations()
  • Module contents
• accim.run package
  • Submodules
  • accim.run.run module
    • make_eplaunch_options()
    • removefiles()
    • runEp()
  • Module contents
• accim.sim package
  • Submodules
  • accim.sim.accim_Base module
    • addControlFilesObjects()
    • addOutputEnergyManagementSystem()
    • addOutputVariableDictionaryObject()
    • saveaccim()
    • setComfFieldsPeople()
    • setPMVsetpoint()
  • accim.sim.accim_Base_EMS module
    • addEMSActuatorsBase()
    • addEMSOutputVariableBase()
    • addEMSPCMBase()
    • addEMSProgramsBase()
    • addEMSSensorsBase()
    • addGlobVarList()
    • addIntVarList()
    • addOutputVariablesDetailed()
    • addOutputVariablesSimplified()
    • addOutputVariablesStandard()
    • genOutputDataframe()
    • makeAverages()
    • outputsSpecified()
    • removeDuplicatedOutputVariables()
    • removeExistingOutputVariables()
    • takeOutputDataFrame()
  • accim.sim.accim_ExistingHVAC module
    • addForscriptSchExistHVAC()
  • accim.sim.accim_ExistingHVAC_EMS module
    • addEMSSensorsExisHVAC()
  • accim.sim.accim_IDFgeneration module
    • genIDF()
    • inputData()
  • accim.sim.accim_Main module
    • accimJob
      • accimJob.addBaseSchedules()
      • accimJob.addControlFilesObjects()
      • accimJob.addCurveObj()
      • accimJob.addDetHVACobj()
      • accimJob.addEMSActuatorsBase()
      • accimJob.addEMSOutputVariableBase()
      • accimJob.addEMSPCMBase()
      • accimJob.addEMSProgramsBase()
      • accimJob.addEMSSensorsBase()
      • accimJob.addEMSSensorsExisHVAC()
      • accimJob.addEMSSensorsVRFsystem()
      • accimJob.addForscriptSchExistHVAC()
      • accimJob.addForscriptSchVRFsystem()
      • accimJob.addGlobVarList()
      • accimJob.addIntVarList()
      • accimJob.addOpTempTherm()
      • accimJob.addOutputEnergyManagementSystem()
      • accimJob.addOutputVariableDictionaryObject()
      • accimJob.addOutputVariablesDetailed()
      • accimJob.addOutputVariablesSimplified()
      • accimJob.addOutputVariablesStandard()
      • accimJob.addVRFsystemSch()
      • accimJob.amend_idf_version_from_dsb()
      • accimJob.checkVentIsOn()
      • accimJob.genIDF()
      • accimJob.genOutputDataframe()
      • accimJob.get_idd_path_from_ep_version()
      • accimJob.inputData()
      • accimJob.listdir()
      • accimJob.makeAverages()
      • accimJob.numpy
      • accimJob.outputsSpecified()
      • accimJob.removeDuplicatedOutputVariables()
      • accimJob.removeExistingOutputVariables()
      • accimJob.saveaccim()
      • accimJob.scan_zones()
      • accimJob.setAvailSchOn()
      • accimJob.setComfFieldsPeople()
      • accimJob.setPMVsetpoint()
      • accimJob.takeOutputDataFrame()
  • accim.sim.accim_Main_single_idf module
    • accimJob
      • accimJob.addBaseSchedules()
      • accimJob.addControlFilesObjects()
      • accimJob.addCurveObj()
      • accimJob.addDetHVACobj()
      • accimJob.addEMSActuatorsBase()
      • accimJob.addEMSOutputVariableBase()
      • accimJob.addEMSPCMBase()
      • accimJob.addEMSProgramsBase()
      • accimJob.addEMSSensorsBase()
      • accimJob.addEMSSensorsExisHVAC()
      • accimJob.addEMSSensorsVRFsystem()
      • accimJob.addForscriptSchExistHVAC()
      • accimJob.addForscriptSchVRFsystem()
      • accimJob.addGlobVarList()
      • accimJob.addIntVarList()
      • accimJob.addOpTempTherm()
      • accimJob.addOutputEnergyManagementSystem()
      • accimJob.addOutputVariableDictionaryObject()
      • accimJob.addOutputVariablesDetailed()
      • accimJob.addOutputVariablesSimplified()
      • accimJob.addOutputVariablesStandard()
      • accimJob.addVRFsystemSch()
      • accimJob.checkVentIsOn()
      • accimJob.genOutputDataframe()
      • accimJob.listdir()
      • accimJob.makeAverages()
      • accimJob.numpy
      • accimJob.outputsSpecified()
      • accimJob.removeDuplicatedOutputVariables()
      • accimJob.removeExistingOutputVariables()
      • accimJob.saveaccim()
      • accimJob.scan_zones()
      • accimJob.setAvailSchOn()
      • accimJob.setComfFieldsPeople()
      • accimJob.setPMVsetpoint()
      • accimJob.takeOutputDataFrame()
  • accim.sim.accim_VRFsystem module
    • addBaseSchedules()
    • addCurveObj()
    • addDetHVACobj()
    • addForscriptSchVRFsystem()
    • addOpTempTherm()
    • addVRFsystemSch()
    • checkVentIsOn()
    • setAvailSchOn()
  • accim.sim.accim_VRFsystem_EMS module
    • addEMSSensorsVRFsystem()
  • accim.sim.accis module
    • addAccis
  • accim.sim.accis_single_idf module
    • addAccis
      • addAccis.modifyAccis()
  • accim.sim.accis_single_idf_funcs module
    • addAccis()
    • gen_outputs_df()
    • modifyAccis()
    • modify_param()
  • accim.sim.apmv_setpoints module
    • add_vrf_system()
    • apply_apmv_setpoints()
    • change_adaptive_coeff()
    • change_pmv_cooling_setpoint()
    • change_pmv_heating_setpoint()
    • change_pmv_setpoints()
    • generate_df_from_args()
    • set_zones_always_occupied()
  • accim.sim.chile_funcs module
    • apply_heating_activation_time_sch()
  • accim.sim.dicts module
  • accim.sim.lists module
  • accim.sim.utils module
    • add_vrf_system()
    • scan_zones()
  • Module contents

Submodules

accim.lists module

Lists to be used in the whole project.

accim.utils module

accim.utils.amend_idf_version_from_dsb(file_path: str)

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

accim.utils.get_accim_args(idf_object: <module 'besos.IDF_class' from '/home/docs/checkouts/readthedocs.org/user_builds/accim/envs/v0.7.5/lib/python3.9/site-packages/besos/IDF_class.py'>) → dict

Collects all the EnergyManagementSystem:Program Program lines used to set the values for the arguments of ACCIS, and saves them in a dictionary.

Parameters:

idf_object – the besos.IDF_class instance

Returns:

a dictionary

accim.utils.get_accim_args_flattened(idf_object)

accim.utils.get_idd_path_from_ep_version(EnergyPlus_version: str)

accim.utils.modify_timesteps(idf_object: IDF, timesteps: int) → IDF

Modifies the timesteps of the idf object.

Parameters:

• idf_object (IDF) – the IDF class from besos or eppy

• timesteps (int) – The number of timesteps. Allowable values include 1, 2, 3, 4, 5, 6, 10, 12, 15, 20, 30, and 60

accim.utils.modify_timesteps_path(idfpath: str, timesteps: int)

Modifies the timesteps of the idf.

Parameters:

• idfpath (str) – the path to the idf

• timesteps (int) – The number of timesteps. Allowable values include 1, 2, 3, 4, 5, 6, 10, 12, 15, 20, 30, and 60

class accim.utils.print_available_outputs_mod(building, version=None, name=None, frequency=None)

Bases: object

accim.utils.reduce_runtime(idf_object: IDF, minimal_shadowing: bool = True, shading_calculation_update_frequency: int = 20, maximum_figures_in_shadow_overlap_calculations: int = 200, timesteps: int = 6, runperiod_begin_month: int = 1, runperiod_begin_day_of_month: int = 1, runperiod_end_month: int = 1, runperiod_end_day_of_month: int = 1) → IDF

Modifies the idf to reduce the simulation runtime.

Parameters:

• idf_object

• minimal_shadowing – True or False. If True, applies minimal shadowing setting.

• shading_calculation_update_frequency – An integer. Sets the intervals for the shading calculation update

• maximum_figures_in_shadow_overlap_calculations – An integer. Applies the number to the maximum figures in shadow overlap calculations.

• timesteps – An integer. Sets the number of timesteps.

• runperiod_begin_day_of_month – the day of the month to start the simulation

• runperiod_begin_month – the month to start the simulation

• runperiod_end_day_of_month – the day of the month to end the simulation

• runperiod_end_month – the month to end the simulation

accim.utils.remove_accents(input_str: str) → str

accim.utils.remove_accents_in_idf(idf_path: str)

Replaces all letters with accent with the same letter without accent.

accim.utils.set_occupancy_to_always(idf_object: IDF) → IDF

Sets the occupancy to always occupied for all zones with people object.

Parameters:

idf_object (IDF) – the IDF class from besos or eppy

accim.utils.set_occupancy_to_always_path(idfpath: str)

Sets the occupancy to always occupied for all zones with people object.

Parameters:

idfpath (str) – the path to the idf

accim.utils.transform_ddmm_to_int(string_date: str) → int

This function converts a date string in the format “dd/mm” to the day of the year as an integer.

Parameters:

string_date – A string representing the date in format “dd/mm”

Returns:

The day of the year as an integer

Return type:

int

Module contents