Sinergym
Start Here
1. Installation
2. Usage example
sinergym
3. Buildings
4. Weathers
5. Environments
6. Rewards
7. Controllers
8. Wrappers
9. Extra Configuration in Sinergym simulations
10. Output format
11. Deep Reinforcement Learning Integration
12. Sinergym with Google Cloud
13. Github Actions
14. Tests
Examples
15. Basic example
16. Changing an environment registered in Sinergym
17. Default building control setting up an empty action interface
18. Wrappers example
19. Logger Wrapper personalization/configuration
20. Rule Controller example
21. DRL usage example
API
API reference
Sinergym
Index
Index
_
|
A
|
B
|
C
|
D
|
E
|
G
|
H
|
I
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
W
_
__init__() (sinergym.envs.eplus_env.EplusEnv method)
(sinergym.simulators.base.BaseSimulator method)
(sinergym.simulators.eplus.EnergyPlus method)
(sinergym.simulators.eplus_alpha.EnergyPlus method)
(sinergym.utils.callbacks.LoggerCallback method)
(sinergym.utils.callbacks.LoggerEvalCallback method)
(sinergym.utils.config.Config method)
(sinergym.utils.controllers.RandomController method)
(sinergym.utils.controllers.RBC5Zone method)
(sinergym.utils.controllers.RBCDatacenter method)
(sinergym.utils.logger.CSVLogger method)
(sinergym.utils.logger.Logger method)
(sinergym.utils.logger.WandBOutputFormat method)
(sinergym.utils.rewards.BaseReward method)
(sinergym.utils.rewards.ExpReward method)
(sinergym.utils.rewards.HourlyLinearReward method)
(sinergym.utils.rewards.LinearReward method)
(sinergym.utils.wrappers.DatetimeWrapper method)
(sinergym.utils.wrappers.DiscreteIncrementalWrapper method)
(sinergym.utils.wrappers.LoggerWrapper method)
(sinergym.utils.wrappers.MultiObjectiveReward method)
(sinergym.utils.wrappers.MultiObsWrapper method)
(sinergym.utils.wrappers.NormalizeObservation method)
(sinergym.utils.wrappers.OfficeGridStorageSmoothingActionConstraintsWrapper method)
(sinergym.utils.wrappers.PreviousObservationWrapper method)
A
act() (sinergym.utils.controllers.RandomController method)
(sinergym.utils.controllers.RBC5Zone method)
(sinergym.utils.controllers.RBCDatacenter method)
action() (sinergym.utils.wrappers.DiscreteIncrementalWrapper method)
(sinergym.utils.wrappers.OfficeGridStorageSmoothingActionConstraintsWrapper method)
action_space (sinergym.envs.eplus_env.EplusEnv property)
activate_flag() (sinergym.utils.logger.CSVLogger method)
activate_logger() (sinergym.utils.wrappers.LoggerWrapper method)
adapt_idf_to_action_definition() (sinergym.utils.config.Config method)
adapt_idf_to_epw() (sinergym.utils.config.Config method)
adapt_variables_to_cfg_and_idf() (sinergym.utils.config.Config method)
apply_extra_conf() (sinergym.utils.config.Config method)
apply_weather_variability() (sinergym.utils.config.Config method)
B
BaseReward (class in sinergym.utils.rewards)
BaseSimulator (class in sinergym.simulators.base)
C
check_env() (in module sinergym.utils.env_checker)
close() (sinergym.envs.eplus_env.EplusEnv method)
(sinergym.utils.wrappers.LoggerWrapper method)
Config (class in sinergym.utils.config)
create_variable_weather() (in module sinergym.utils.common)
CSVLogger (class in sinergym.utils.logger)
D
DatetimeWrapper (class in sinergym.utils.wrappers)
deactivate_flag() (sinergym.utils.logger.CSVLogger method)
deactivate_logger() (sinergym.utils.wrappers.LoggerWrapper method)
delete_instance_MIG_from_container() (in module sinergym.utils.gcloud)
DiscreteIncrementalWrapper (class in sinergym.utils.wrappers)
E
end_env() (sinergym.simulators.eplus.EnergyPlus method)
end_episode() (sinergym.simulators.eplus.EnergyPlus method)
end_simulation() (sinergym.simulators.eplus_alpha.EnergyPlus method)
EnergyPlus (class in sinergym.simulators.eplus)
(class in sinergym.simulators.eplus_alpha)
env_name (sinergym.simulators.eplus.EnergyPlus property)
EplusEnv (class in sinergym.envs.eplus_env)
evaluate_policy() (in module sinergym.utils.evaluation)
export_actuators_to_excel() (in module sinergym.utils.common)
ExpReward (class in sinergym.utils.rewards)
G
get_current_time_info() (in module sinergym.utils.common)
get_delta_seconds() (in module sinergym.utils.common)
get_is_eplus_running() (sinergym.simulators.eplus.EnergyPlus method)
get_record_keys() (in module sinergym.utils.common)
get_schedulers() (sinergym.envs.eplus_env.EplusEnv method)
(sinergym.utils.config.Config method)
get_season_comfort_range() (in module sinergym.utils.common)
get_service_account_token() (in module sinergym.utils.gcloud)
get_unwrapped_obs() (sinergym.utils.wrappers.NormalizeObservation method)
get_zones() (sinergym.envs.eplus_env.EplusEnv method)
getLogger() (sinergym.utils.logger.Logger method)
H
HourlyLinearReward (class in sinergym.utils.rewards)
I
init_storage_client() (in module sinergym.utils.gcloud)
is_wrapped() (in module sinergym.utils.common)
L
LinearReward (class in sinergym.utils.rewards)
log_episode() (sinergym.utils.logger.CSVLogger method)
log_step() (sinergym.utils.logger.CSVLogger method)
log_step_normalize() (sinergym.utils.logger.CSVLogger method)
Logger (class in sinergym.utils.logger)
LoggerCallback (class in sinergym.utils.callbacks)
LoggerEvalCallback (class in sinergym.utils.callbacks)
LoggerWrapper (class in sinergym.utils.wrappers)
M
metadata (sinergym.envs.eplus_env.EplusEnv attribute)
module
sinergym.envs
sinergym.envs.eplus_env
sinergym.simulators
sinergym.simulators.base
sinergym.simulators.eplus
sinergym.simulators.eplus_alpha
sinergym.utils
sinergym.utils.callbacks
sinergym.utils.common
sinergym.utils.config
sinergym.utils.constants
sinergym.utils.controllers
sinergym.utils.env_checker
sinergym.utils.evaluation
sinergym.utils.gcloud
sinergym.utils.logger
sinergym.utils.rewards
sinergym.utils.wrappers
MultiObjectiveReward (class in sinergym.utils.wrappers)
MultiObsWrapper (class in sinergym.utils.wrappers)
N
NormalizeObservation (class in sinergym.utils.wrappers)
O
observation() (sinergym.utils.wrappers.DatetimeWrapper method)
(sinergym.utils.wrappers.NormalizeObservation method)
(sinergym.utils.wrappers.PreviousObservationWrapper method)
observation_space (sinergym.envs.eplus_env.EplusEnv property)
OfficeGridStorageSmoothingActionConstraintsWrapper (class in sinergym.utils.wrappers)
on_training_end() (sinergym.utils.callbacks.LoggerCallback method)
P
prepare_batch_from_records() (in module sinergym.utils.common)
PreviousObservationWrapper (class in sinergym.utils.wrappers)
R
RandomController (class in sinergym.utils.controllers)
ranges_getter() (in module sinergym.utils.common)
RBC5Zone (class in sinergym.utils.controllers)
RBCDatacenter (class in sinergym.utils.controllers)
read_from_bucket() (in module sinergym.utils.gcloud)
receive_observation() (sinergym.simulators.base.BaseSimulator method)
(sinergym.simulators.eplus_alpha.EnergyPlus method)
render() (sinergym.envs.eplus_env.EplusEnv method)
reset() (sinergym.envs.eplus_env.EplusEnv method)
(sinergym.simulators.eplus.EnergyPlus method)
(sinergym.utils.wrappers.LoggerWrapper method)
(sinergym.utils.wrappers.MultiObsWrapper method)
S
save_building_model() (sinergym.utils.config.Config method)
save_variables_cfg() (sinergym.utils.config.Config method)
send_action() (sinergym.simulators.base.BaseSimulator method)
(sinergym.simulators.eplus_alpha.EnergyPlus method)
set_episode_working_dir() (sinergym.utils.config.Config method)
set_experiment_working_dir() (sinergym.utils.config.Config method)
set_external_interface() (sinergym.utils.config.Config method)
set_log_file() (sinergym.utils.logger.CSVLogger method)
sinergym.envs
module
sinergym.envs.eplus_env
module
sinergym.simulators
module
sinergym.simulators.base
module
sinergym.simulators.eplus
module
sinergym.simulators.eplus_alpha
module
sinergym.utils
module
sinergym.utils.callbacks
module
sinergym.utils.common
module
sinergym.utils.config
module
sinergym.utils.constants
module
sinergym.utils.controllers
module
sinergym.utils.env_checker
module
sinergym.utils.evaluation
module
sinergym.utils.gcloud
module
sinergym.utils.logger
module
sinergym.utils.rewards
module
sinergym.utils.wrappers
module
start_day (sinergym.simulators.eplus.EnergyPlus property)
start_mon (sinergym.simulators.eplus.EnergyPlus property)
start_simulation() (sinergym.simulators.base.BaseSimulator method)
(sinergym.simulators.eplus_alpha.EnergyPlus method)
start_weekday (sinergym.simulators.eplus.EnergyPlus property)
start_year (sinergym.simulators.eplus.EnergyPlus property)
(sinergym.utils.config.Config property)
step() (sinergym.envs.eplus_env.EplusEnv method)
(sinergym.simulators.eplus.EnergyPlus method)
(sinergym.utils.wrappers.LoggerWrapper method)
(sinergym.utils.wrappers.MultiObjectiveReward method)
(sinergym.utils.wrappers.MultiObsWrapper method)
stop_simulation() (sinergym.simulators.base.BaseSimulator method)
T
to_idf() (in module sinergym.utils.common)
U
unwrap_wrapper() (in module sinergym.utils.common)
update_weather_path() (sinergym.utils.config.Config method)
upload_to_bucket() (in module sinergym.utils.gcloud)
W
WandBOutputFormat (class in sinergym.utils.logger)
write() (sinergym.utils.logger.WandBOutputFormat method)
Other Versions
v: v2.3.0
Tags
v1.4.0
v1.6.0
v1.7.0
v2.0.0
v2.1.0
v2.2.0
v2.3.0
v2.5.0
v3.1.0
v3.2.0
v3.3.0
v3.4.0
v3.5.0
v3.6.0
Branches
main