SustainDC

This section includes complete documentation of SustainDC including core environment, training, evaluation, algorithms, environments, utilities code and input data sets.

Core Environment (LINK)

• Core Environment
  • EnvConfig
    • EnvConfig.DEFAULT_CONFIG
  • SustainDC
    • SustainDC.calculate_reward()
    • SustainDC.close()
    • SustainDC.get_avail_actions()
    • SustainDC.get_avail_agent_actions()
    • SustainDC.render()
    • SustainDC.reset()
    • SustainDC.seed()
    • SustainDC.state()
    • SustainDC.step()

Training (LINK)

• Training
  • main()

Evaluation (LINK)

• Evaluation
  • baseline_actors

Algorithms (LINK)

• Algorithms
  • Subpackages
    • harl.algorithms package
      • Subpackages
      • Module contents
    • harl.common package
      • Subpackages
      • Submodules
      • harl.common.base_logger module
      • harl.common.valuenorm module
      • Module contents
    • harl.envs package
      • Submodules
      • harl.envs.env_wrappers module
      • Module contents
    • harl.models package
      • Subpackages
      • Module contents
    • harl.runners package
      • Submodules
      • harl.runners.off_policy_base_runner module
      • harl.runners.off_policy_ha_runner module
      • harl.runners.off_policy_ma_runner module
      • harl.runners.on_policy_base_runner module
      • harl.runners.on_policy_ha_runner module
      • harl.runners.on_policy_ma_runner module
      • Module contents
    • harl.utils package
      • Submodules
      • harl.utils.configs_tools module
      • harl.utils.discrete_util module
      • harl.utils.envs_tools module
      • harl.utils.models_tools module
      • harl.utils.trans_tools module
      • harl.utils.trpo_util module
      • Module contents
  • Module contents

Environments (LINK)

• Environments
  • Submodules
  • envs.bat_env_fwd_view module
    • BatteryEnvFwd
      • BatteryEnvFwd.CO2_footprint()
      • BatteryEnvFwd.charging_rate_modifier()
      • BatteryEnvFwd.discharging_rate_modifier()
      • BatteryEnvFwd.reset()
      • BatteryEnvFwd.set_dcload()
      • BatteryEnvFwd.sigmoid()
      • BatteryEnvFwd.step()
      • BatteryEnvFwd.update_ci()
      • BatteryEnvFwd.update_state()
  • envs.battery_model module
    • Battery2
      • Battery2.c_lim
      • Battery2.calc_max_charge()
      • Battery2.calc_max_discharge()
      • Battery2.capacity
      • Battery2.charge()
      • Battery2.current_load
      • Battery2.d_lim
      • Battery2.discharge()
      • Battery2.eff_c
      • Battery2.eff_d
      • Battery2.find_and_init_capacity()
      • Battery2.is_full()
      • Battery2.lower_lim_u
      • Battery2.lower_lim_v
      • Battery2.reset()
      • Battery2.upper_lim_u
      • Battery2.upper_lim_v
  • envs.carbon_ls module
    • CarbonLoadEnv
      • CarbonLoadEnv.reset()
      • CarbonLoadEnv.step()
      • CarbonLoadEnv.update_workload()
  • envs.datacenter module
    • CPU
      • CPU.cpu_curve1()
      • CPU.itfan_curve2()
    • DataCenter_ITModel
      • DataCenter_ITModel.calculate_cooling_tower_water_usage()
      • DataCenter_ITModel.compute_datacenter_IT_load_outlet_temp()
      • DataCenter_ITModel.total_datacenter_full_load()
    • Rack
      • Rack.clamp_supply_approach_temp()
      • Rack.compute_instantaneous_pwr()
      • Rack.compute_instantaneous_pwr_vecd()
      • Rack.cpu_and_fan_init()
      • Rack.get_average_rack_fan_v()
      • Rack.get_current_rack_load()
      • Rack.get_total_rack_fan_v()
    • calculate_HVAC_power()
    • calculate_avg_CRAC_return_temp()
    • calculate_chiller_power()
    • chiller_sizing()
  • envs.dc_gym module
    • dc_gymenv
      • dc_gymenv.NormalizeObservation()
      • dc_gymenv.get_obs()
      • dc_gymenv.normalize()
      • dc_gymenv.reset()
      • dc_gymenv.set_ambient_temp()
      • dc_gymenv.set_bat_SoC()
      • dc_gymenv.set_shifted_wklds()
      • dc_gymenv.step()
  • Module contents

Utilities (LINK)

• Utilities
  • Submodules
  • utils.base_agents module
    • BaseBatteryAgent
      • BaseBatteryAgent.act()
      • BaseBatteryAgent.do_nothing_action()
    • BaseHVACAgent
      • BaseHVACAgent.do_nothing_action()
    • BaseLoadShiftingAgent
      • BaseLoadShiftingAgent.do_nothing_action()
  • utils.checkpoint_finder module
    • get_best_checkpoint()
  • utils.dc_config module
  • utils.dc_config_reader module
    • DC_Config
  • utils.helper_methods module
    • f2c()
    • pyeplus_callback
      • pyeplus_callback.on_episode_end()
      • pyeplus_callback.on_episode_start()
      • pyeplus_callback.on_episode_step()
  • utils.make_envs_pyenv module
    • make_bat_fwd_env()
    • make_dc_pyeplus_env()
    • make_ls_env()
  • utils.managers module
    • CI_Manager
      • CI_Manager.get_current_ci()
      • CI_Manager.get_forecast_ci()
      • CI_Manager.get_total_ci()
      • CI_Manager.reset()
      • CI_Manager.step()
    • CoherentNoise
      • CoherentNoise.generate()
    • Time_Manager
      • Time_Manager.isterminal()
      • Time_Manager.reset()
      • Time_Manager.step()
    • Weather_Manager
      • Weather_Manager.get_current_weather()
      • Weather_Manager.get_total_weather()
      • Weather_Manager.reset()
      • Weather_Manager.step()
    • Workload_Manager
      • Workload_Manager.get_current_workload()
      • Workload_Manager.get_total_wkl()
      • Workload_Manager.reset()
      • Workload_Manager.scale_array()
      • Workload_Manager.set_current_workload()
      • Workload_Manager.step()
    • normalize()
    • sc_obs()
    • standarize()
  • utils.rbc_agents module
    • RBCBatteryAgent
      • RBCBatteryAgent.act()
  • utils.reward_creator module
    • custom_agent_reward()
    • default_bat_reward()
    • default_dc_reward()
    • default_ls_reward()
    • energy_PUE_reward()
    • energy_efficiency_reward()
    • get_reward_method()
    • renewable_energy_reward()
    • temperature_efficiency_reward()
    • tou_reward()
    • water_usage_efficiency_reward()
  • utils.rllib_callbacks module
    • CustomCallbacks
      • CustomCallbacks.on_episode_end()
      • CustomCallbacks.on_episode_start()
      • CustomCallbacks.on_episode_step()
  • utils.trim_and_respond module
    • trim_and_respond_ctrl
      • trim_and_respond_ctrl.action()
      • trim_and_respond_ctrl.set_limit()
  • utils.utils_cf module
    • get_energy_variables()
    • get_init_day()
    • obtain_paths()
  • Module contents

Data Sources (LINK)

• Data Sources
  • Subpackages
    • data.CarbonIntensity package
      • Module contents
    • data.Weather package
      • Module contents
    • data.Workload package
      • Module contents
  • Module contents