Welcome to accim 0.7.5’s documentation!

Tutorial:

• 1. Requirements
• 2. Installation
• 3. Quick tutorial
  • 3.1 Implementing adaptive setpoint temperatures
    • 3.1.1 Short version
    • 3.1.2 Long version
  • 3.2 Other uses
• 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
  • 5.1 Errors you might get
  • 5.2 General recommendations
• 6. Citation
• 7. Credits

How-to Guides:

• Using addAccis() to apply adaptive setpoint temperatures
  • 1. General use
    • 1.1 Short version
    • 1.2 Longer version
  • 2. Other uses
    • 2.1 Storing the addAccis() class and inspecting the output IDFs
    • 2.2 Specifying the outputs in the IDF
      • 2.2.1 Using Output_type='custom'
      • 2.2.2 Using Output_gen_dataframe and Output_take_dataframe
• Using rename_epw_files() to rename the EPWs for proper data analysis after simulation
  • Using data from coordinates
  • Using data from user-defined dicts
• Using runEp() to directly run simulations with EnergyPlus
• Using the class Table() for data analysis
  • 1. Getting the full dataset of simulation results
  • 2. Filtering results
  • 3. Making graphs
    • 3.1 Scatter plot:
    • 3.2 Adaptive vs Static data scatter plot:
  • 4. Making tables
• Full example of adaptive setpoint temperature simulation: IBPSA webinar
  • 1. Data pre-processing
    • 1.1. Implementing ACCIS (using addAccis())
    • 1.2. Preparing EPW files (using rename_epw_files())
  • 2. Running the simulation (using runEp())
  • 3. Data post-processing
    • 3.1 Visualizing the data
    • 3.2 Analysing the data
• accim: a Python library to perform building energy simulations considering adaptive comfort and data analytics
  • 3. Results
  • 3.1 Data pre-processing
    • 3.1.1. EPW files preparation
    • 3.1.2. ACCIS implementation
  • 3.2. Running simulations
  • 3.3. Data analysis
    • 3.3.1 Tables
    • 3.3.2. Data visualization
• aPMV (Adaptive Predicted Mean Vote) Setpoints Demonstration
  • Prerequisites
  • Workflow Overview
  • Initial Setup and Model Loading
  • Part 1: Baseline Scenario (Standard PMV)
    • Applying PMV Setpoints (λ = 0)
    • Running the Baseline Simulation
    • Visualizing the Baseline Results
  • Part 2: Adaptive Scenario (aPMV)
    • Defining Zone-Specific Adaptive Coefficients
    • Applying aPMV Setpoints with Custom Coefficients
    • Validating the EMS Implementation
    • Running the Adaptive Simulation
    • Visualizing the Adaptive Results
  • Cleanup

API Reference:

• accim
  • 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
    • accim.utils module
      • amend_idf_version_from_dsb()
      • get_accim_args()
      • get_accim_args_flattened()
      • get_idd_path_from_ep_version()
      • modify_timesteps()
      • modify_timesteps_path()
      • print_available_outputs_mod
      • reduce_runtime()
      • remove_accents()
      • remove_accents_in_idf()
      • set_occupancy_to_always()
      • set_occupancy_to_always_path()
      • transform_ddmm_to_int()
    • Module contents

Documentation for previous versions:

• Documentation for previous versions

Indices and tables

• Index

• Module Index

• Search Page