Welcome to accim 0.7.8’s documentation!
Tutorial:
- 1. Requirements
- 2. Installation
- 3. Quick tutorial
- 4. Detailed use and explanation of arguments
- 4.1 First steps
- 4.2 Setting up the target IDFs
- 4.3 Full list of setpoint temperatures
- 4.4 Putting it into practice: Adaptive setpoint temperatures step by step
- 4.5 Renaming epw files for later data analysis
- 4.6 Running simulations
- 4.7 Functions and methods for data analysis; making figures and tables
- 5. Troubleshooting
- 6. Citation
- 7. Credits
How-to Guides:
- Using
addAccis()to apply adaptive setpoint temperatures - Using
rename_epw_files()to rename the EPWs for proper data analysis after simulation - Using
runEp()to directly run simulations with EnergyPlus - Using the class
Table()for data analysis - Full example of adaptive setpoint temperature simulation: IBPSA webinar
- accim: a Python library to perform building energy simulations considering adaptive comfort and data analytics
- Applying aPMV setpoints
API Reference:
- accim
- accim package
- Subpackages
- accim.data package
- accim.parametric_and_optimisation package
- Subpackages
- Submodules
- accim.parametric_and_optimisation.main module
- accim.parametric_and_optimisation.objectives module
- accim.parametric_and_optimisation.parameters module
ASTtolCATCATcoolOffsetCATheatOffsetComfModComfStandCoolSeasonEndCoolSeasonStartCustAST_ACSTallCustAST_ACSTaulCustAST_ACSToffsetCustAST_AHSTallCustAST_AHSTaulCustAST_AHSToffsetCustAST_ASTallCustAST_ASTaulCustAST_ASToffsetCustAST_mCustAST_nHVACmodeMaxTempDiffVOFMaxWindSpeedMinOToffsetMinTempDiffVOFMultiplierVOFParameterSetpointAccVSToffsetVentCtrlaccis_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
- Module contents
- accim.run package
- accim.sim package
- Submodules
- accim.sim.accim_Base module
- 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
- accim.sim.accim_ExistingHVAC_EMS module
- accim.sim.accim_IDFgeneration module
- accim.sim.accim_Main module
accimJobaccimJob.addBaseSchedules()accimJob.addControlFilesObjects()accimJob.addCurveObj()accimJob.addDetHVACobj()accimJob.addEMSActuatorsBase()accimJob.addEMSInitExisHVAC()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.numpyaccimJob.outputsSpecified()accimJob.removeDuplicatedOutputVariables()accimJob.removeExistingOutputVariables()accimJob.resolve_hvac_zone_map()accimJob.saveaccim()accimJob.scan_zones()accimJob.setAvailSchOn()accimJob.setComfFieldsPeople()accimJob.setPMVsetpoint()accimJob.setSimulationControlSizing()accimJob.takeOutputDataFrame()
- accim.sim.accim_Main_single_idf module
accimJobaccimJob.addBaseSchedules()accimJob.addControlFilesObjects()accimJob.addCurveObj()accimJob.addDetHVACobj()accimJob.addEMSActuatorsBase()accimJob.addEMSInitExisHVAC()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.numpyaccimJob.outputsSpecified()accimJob.removeDuplicatedOutputVariables()accimJob.removeExistingOutputVariables()accimJob.resolve_hvac_zone_map()accimJob.saveaccim()accimJob.scan_zones()accimJob.setAvailSchOn()accimJob.setComfFieldsPeople()accimJob.setPMVsetpoint()accimJob.setSimulationControlSizing()accimJob.takeOutputDataFrame()
- accim.sim.accim_VRFsystem module
- accim.sim.accim_VRFsystem_EMS module
- accim.sim.accis module
- accim.sim.accis_single_idf module
- accim.sim.accis_single_idf_funcs module
- accim.sim.apmv_setpoints module
- accim.sim.chile_funcs module
- accim.sim.dicts module
- accim.sim.lists module
- accim.sim.utils module
- Module contents
- Submodules
- accim.lists module
- accim.utils module
AccimSimulationVerifieramend_idf_version_from_dsb()convert_standard_to_comfort_thermostats()get_accim_args()get_accim_args_flattened()get_available_fields()get_idd_path_from_ep_version()get_idf_hierarchy()get_idf_hierarchy_with_people()get_people_hierarchy()get_people_names_for_ems()get_spaces_from_spacelist()identify_variable_key_pattern()inspect_thermostat_objects()modify_timesteps()modify_timesteps_path()print_available_outputs_modread_eso_using_readvarseso()reduce_runtime()remove_accents()remove_accents_in_idf()set_occupancy_to_always()set_occupancy_to_always_path()set_operative_temp_control()transform_ddmm_to_int()update_idf_version()verify_accim_simulation()
- Module contents
- Subpackages
- accim package
Documentation for previous versions: