Sinergym
Start Here
1. Installation
2. Usage Example
sinergym
3. Buildings
4. Weathers
5. Architecture
6. Environments
7. Environments Configuration and Registration
8. Logging System Overview
9. Output format
10. Rewards
11. Controllers
12. Wrappers
13. Extra Configuration in Sinergym simulations
14. Deep Reinforcement Learning Integration
15. Sinergym with Google Cloud
16. Github Actions
17. Tests
Examples
18. Basic example
19. Getting information about Sinergym environments
20. Sinergym package information
21. Changing an environment registered in Sinergym
22. Default building control setting up an empty action interface
23. Wrappers example
24. Logger Wrapper personalization/configuration
25. Logging unused variables
26. Rule Controller example
27. DRL usage example
API
API reference
Sinergym
Index
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
|
Y
|
Z
_
__init__() (sinergym.config.modeling.ModelJSON method)
(sinergym.envs.eplus_env.EplusEnv method)
(sinergym.simulators.eplus.EnergyPlus method)
(sinergym.utils.callbacks.LoggerEvalCallback method)
(sinergym.utils.controllers.RandomController method)
(sinergym.utils.controllers.RBC5Zone method)
(sinergym.utils.controllers.RBCDatacenter method)
(sinergym.utils.controllers.RBCIncrementalDatacenter method)
(sinergym.utils.logger.CustomFormatter method)
(sinergym.utils.logger.LoggerStorage method)
(sinergym.utils.logger.SimpleLogger method)
(sinergym.utils.logger.TerminalLogger method)
(sinergym.utils.logger.TqdmLoggingHandler 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.rewards.NormalizedLinearReward method)
(sinergym.utils.wrappers.BaseLoggerWrapper method)
(sinergym.utils.wrappers.CSVLogger method)
(sinergym.utils.wrappers.DatetimeWrapper method)
(sinergym.utils.wrappers.DiscreteIncrementalWrapper method)
(sinergym.utils.wrappers.DiscretizeEnv method)
(sinergym.utils.wrappers.IncrementalWrapper method)
(sinergym.utils.wrappers.LoggerWrapper method)
(sinergym.utils.wrappers.MultiObjectiveReward method)
(sinergym.utils.wrappers.MultiObsWrapper method)
(sinergym.utils.wrappers.NormalizeAction method)
(sinergym.utils.wrappers.NormalizeObservation method)
(sinergym.utils.wrappers.OfficeGridStorageSmoothingActionConstraintsWrapper method)
(sinergym.utils.wrappers.PreviousObservationWrapper method)
(sinergym.utils.wrappers.ReduceObservationWrapper method)
(sinergym.utils.wrappers.WandBLogger method)
A
act() (sinergym.utils.controllers.RandomController method)
(sinergym.utils.controllers.RBC5Zone method)
(sinergym.utils.controllers.RBCDatacenter method)
(sinergym.utils.controllers.RBCIncrementalDatacenter method)
action() (sinergym.utils.wrappers.DiscreteIncrementalWrapper method)
(sinergym.utils.wrappers.DiscretizeEnv method)
(sinergym.utils.wrappers.IncrementalWrapper method)
(sinergym.utils.wrappers.NormalizeAction method)
(sinergym.utils.wrappers.OfficeGridStorageSmoothingActionConstraintsWrapper method)
action_mapping() (sinergym.utils.wrappers.DiscreteIncrementalWrapper method)
action_space (sinergym.envs.eplus_env.EplusEnv property)
actions (sinergym.utils.logger.LoggerStorage attribute)
activate_update() (sinergym.utils.wrappers.NormalizeObservation method)
actuator_handlers (sinergym.envs.eplus_env.EplusEnv property)
adapt_building_to_config() (sinergym.config.modeling.ModelJSON method)
adapt_building_to_epw() (sinergym.config.modeling.ModelJSON method)
adapt_building_to_meters() (sinergym.config.modeling.ModelJSON method)
adapt_building_to_variables() (sinergym.config.modeling.ModelJSON method)
apply_weather_variability() (sinergym.config.modeling.ModelJSON method)
available_handlers (sinergym.envs.eplus_env.EplusEnv property)
B
BaseLoggerWrapper (class in sinergym.utils.wrappers)
BaseReward (class in sinergym.utils.rewards)
bold_red (sinergym.utils.logger.CustomFormatter attribute)
building_path (sinergym.config.modeling.ModelJSON property)
(sinergym.envs.eplus_env.EplusEnv property)
C
calculate_custom_metrics() (sinergym.utils.wrappers.BaseLoggerWrapper method)
(sinergym.utils.wrappers.LoggerWrapper method)
check_env() (in module sinergym.utils.env_checker)
close() (sinergym.envs.eplus_env.EplusEnv method)
(sinergym.utils.wrappers.BaseLoggerWrapper method)
(sinergym.utils.wrappers.CSVLogger method)
(sinergym.utils.wrappers.NormalizeObservation method)
(sinergym.utils.wrappers.WandBLogger method)
convert_conf_to_env_parameters() (in module sinergym.utils.common)
CSVLogger (class in sinergym.utils.wrappers)
CustomFormatter (class in sinergym.utils.logger)
D
DatetimeWrapper (class in sinergym.utils.wrappers)
ddy_path (sinergym.config.modeling.ModelJSON property)
(sinergym.envs.eplus_env.EplusEnv property)
deactivate_update() (sinergym.utils.wrappers.NormalizeObservation method)
DEFAULT_5ZONE_DISCRETE_FUNCTION() (in module sinergym.utils.constants)
DEFAULT_DATACENTER_DISCRETE_FUNCTION() (in module sinergym.utils.constants)
DEFAULT_OFFICE_DISCRETE_FUNCTION() (in module sinergym.utils.constants)
DEFAULT_OFFICEGRID_DISCRETE_FUNCTION() (in module sinergym.utils.constants)
DEFAULT_RADIANT_DISCRETE_FUNCTION() (in module sinergym.utils.constants)
DEFAULT_SHOP_DISCRETE_FUNCTION() (in module sinergym.utils.constants)
DEFAULT_WAREHOUSE_DISCRETE_FUNCTION() (in module sinergym.utils.constants)
delete_instance_MIG_from_container() (in module sinergym.utils.gcloud)
DiscreteIncrementalWrapper (class in sinergym.utils.wrappers)
DiscretizeEnv (class in sinergym.utils.wrappers)
dump_log_files() (sinergym.utils.wrappers.CSVLogger method)
E
emit() (sinergym.utils.logger.TqdmLoggingHandler method)
EnergyPlus (class in sinergym.simulators.eplus)
episode_length (sinergym.envs.eplus_env.EplusEnv property)
episode_path (sinergym.envs.eplus_env.EplusEnv property)
EplusEnv (class in sinergym.envs.eplus_env)
eppy_element_to_dict() (in module sinergym.utils.common)
export_schedulers_to_excel() (in module sinergym.utils.common)
ExpReward (class in sinergym.utils.rewards)
F
failed() (sinergym.simulators.eplus.EnergyPlus method)
format() (sinergym.utils.logger.CustomFormatter method)
FORMATS (sinergym.utils.logger.CustomFormatter attribute)
G
get_delta_seconds() (in module sinergym.utils.common)
get_episode_summary() (sinergym.utils.wrappers.BaseLoggerWrapper method)
(sinergym.utils.wrappers.LoggerWrapper method)
get_schedulers() (sinergym.config.modeling.ModelJSON method)
get_service_account_token() (in module sinergym.utils.gcloud)
getLogger() (sinergym.utils.logger.SimpleLogger method)
(sinergym.utils.logger.TerminalLogger method)
grey (sinergym.utils.logger.CustomFormatter attribute)
H
HourlyLinearReward (class in sinergym.utils.rewards)
I
idd_path (sinergym.config.modeling.ModelJSON property)
(sinergym.envs.eplus_env.EplusEnv property)
IncrementalWrapper (class in sinergym.utils.wrappers)
info() (sinergym.envs.eplus_env.EplusEnv method)
infos (sinergym.utils.logger.LoggerStorage attribute)
init_storage_client() (in module sinergym.utils.gcloud)
is_discrete (sinergym.envs.eplus_env.EplusEnv property)
(sinergym.utils.wrappers.DiscreteIncrementalWrapper property)
(sinergym.utils.wrappers.DiscretizeEnv property)
is_running (sinergym.envs.eplus_env.EplusEnv property)
(sinergym.simulators.eplus.EnergyPlus property)
is_wrapped() (in module sinergym.utils.common)
J
json_to_actuators() (in module sinergym.utils.common)
json_to_meters() (in module sinergym.utils.common)
json_to_variables() (in module sinergym.utils.common)
L
LinearReward (class in sinergym.utils.rewards)
log_info() (sinergym.utils.logger.LoggerStorage method)
log_interaction() (sinergym.utils.logger.LoggerStorage method)
log_norm_obs() (sinergym.utils.logger.LoggerStorage method)
log_obs() (sinergym.utils.logger.LoggerStorage method)
logger (sinergym.config.modeling.ModelJSON attribute)
(sinergym.envs.eplus_env.EplusEnv attribute)
(sinergym.simulators.eplus.EnergyPlus attribute)
(sinergym.utils.callbacks.LoggerEvalCallback attribute)
(sinergym.utils.rewards.BaseReward attribute)
(sinergym.utils.wrappers.CSVLogger attribute)
(sinergym.utils.wrappers.DatetimeWrapper attribute)
(sinergym.utils.wrappers.DiscreteIncrementalWrapper attribute)
(sinergym.utils.wrappers.DiscretizeEnv attribute)
(sinergym.utils.wrappers.IncrementalWrapper attribute)
(sinergym.utils.wrappers.LoggerWrapper attribute)
(sinergym.utils.wrappers.MultiObjectiveReward attribute)
(sinergym.utils.wrappers.MultiObsWrapper attribute)
(sinergym.utils.wrappers.NormalizeAction attribute)
(sinergym.utils.wrappers.NormalizeObservation attribute)
(sinergym.utils.wrappers.PreviousObservationWrapper attribute)
(sinergym.utils.wrappers.ReduceObservationWrapper attribute)
(sinergym.utils.wrappers.WandBLogger attribute)
LoggerEvalCallback (class in sinergym.utils.callbacks)
LoggerStorage (class in sinergym.utils.logger)
LoggerWrapper (class in sinergym.utils.wrappers)
M
make_eplus_args() (sinergym.simulators.eplus.EnergyPlus method)
mean (sinergym.utils.wrappers.NormalizeObservation property)
metadata (sinergym.envs.eplus_env.EplusEnv attribute)
meter_handlers (sinergym.envs.eplus_env.EplusEnv property)
ModelJSON (class in sinergym.config.modeling)
module
sinergym.config
sinergym.config.modeling
sinergym.envs
sinergym.envs.eplus_env
sinergym.simulators
sinergym.simulators.eplus
sinergym.utils
sinergym.utils.callbacks
sinergym.utils.common
sinergym.utils.constants
sinergym.utils.controllers
sinergym.utils.env_checker
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
normalize() (sinergym.utils.wrappers.NormalizeObservation method)
NormalizeAction (class in sinergym.utils.wrappers)
normalized_observations (sinergym.utils.logger.LoggerStorage attribute)
NormalizedLinearReward (class in sinergym.utils.rewards)
NormalizeObservation (class in sinergym.utils.wrappers)
O
observation() (sinergym.utils.wrappers.DatetimeWrapper method)
(sinergym.utils.wrappers.PreviousObservationWrapper method)
observation_space (sinergym.envs.eplus_env.EplusEnv property)
observations (sinergym.utils.logger.LoggerStorage attribute)
OfficeGridStorageSmoothingActionConstraintsWrapper (class in sinergym.utils.wrappers)
P
PreviousObservationWrapper (class in sinergym.utils.wrappers)
R
RandomController (class in sinergym.utils.controllers)
RBC5Zone (class in sinergym.utils.controllers)
RBCDatacenter (class in sinergym.utils.controllers)
RBCIncrementalDatacenter (class in sinergym.utils.controllers)
read_from_bucket() (in module sinergym.utils.gcloud)
red (sinergym.utils.logger.CustomFormatter attribute)
ReduceObservationWrapper (class in sinergym.utils.wrappers)
render() (sinergym.envs.eplus_env.EplusEnv method)
reset (sinergym.utils.logger.CustomFormatter attribute)
reset() (sinergym.envs.eplus_env.EplusEnv method)
(sinergym.utils.wrappers.BaseLoggerWrapper method)
(sinergym.utils.wrappers.CSVLogger method)
(sinergym.utils.wrappers.MultiObsWrapper method)
(sinergym.utils.wrappers.NormalizeObservation method)
(sinergym.utils.wrappers.ReduceObservationWrapper method)
(sinergym.utils.wrappers.WandBLogger method)
reset_data() (sinergym.utils.logger.LoggerStorage method)
reverting_action() (sinergym.utils.wrappers.NormalizeAction method)
rewards (sinergym.utils.logger.LoggerStorage attribute)
runperiod (sinergym.envs.eplus_env.EplusEnv property)
S
save_artifact() (sinergym.utils.wrappers.WandBLogger method)
save_building_model() (sinergym.config.modeling.ModelJSON method)
schedulers (sinergym.envs.eplus_env.EplusEnv property)
set_episode_working_dir() (sinergym.config.modeling.ModelJSON method)
set_mean() (sinergym.utils.wrappers.NormalizeObservation method)
set_var() (sinergym.utils.wrappers.NormalizeObservation method)
set_wandb_finish() (sinergym.utils.wrappers.WandBLogger method)
simple_printer (sinergym.envs.eplus_env.EplusEnv attribute)
SimpleLogger (class in sinergym.utils.logger)
sinergym.config
module
sinergym.config.modeling
module
sinergym.envs
module
sinergym.envs.eplus_env
module
sinergym.simulators
module
sinergym.simulators.eplus
module
sinergym.utils
module
sinergym.utils.callbacks
module
sinergym.utils.common
module
sinergym.utils.constants
module
sinergym.utils.controllers
module
sinergym.utils.env_checker
module
sinergym.utils.gcloud
module
sinergym.utils.logger
module
sinergym.utils.rewards
module
sinergym.utils.wrappers
module
start() (sinergym.simulators.eplus.EnergyPlus method)
step() (sinergym.envs.eplus_env.EplusEnv method)
(sinergym.utils.wrappers.BaseLoggerWrapper method)
(sinergym.utils.wrappers.MultiObjectiveReward method)
(sinergym.utils.wrappers.MultiObsWrapper method)
(sinergym.utils.wrappers.NormalizeObservation method)
(sinergym.utils.wrappers.ReduceObservationWrapper method)
(sinergym.utils.wrappers.WandBLogger method)
step_size (sinergym.envs.eplus_env.EplusEnv property)
stop() (sinergym.simulators.eplus.EnergyPlus method)
T
TerminalLogger (class in sinergym.utils.logger)
terminateds (sinergym.utils.logger.LoggerStorage attribute)
timestep_per_episode (sinergym.envs.eplus_env.EplusEnv property)
TqdmLoggingHandler (class in sinergym.utils.logger)
truncateds (sinergym.utils.logger.LoggerStorage attribute)
U
unwrap_wrapper() (in module sinergym.utils.common)
update_weather_path() (sinergym.config.modeling.ModelJSON method)
upload_to_bucket() (in module sinergym.utils.gcloud)
V
var (sinergym.utils.wrappers.NormalizeObservation property)
var_handlers (sinergym.envs.eplus_env.EplusEnv property)
W
wandb_log() (sinergym.utils.wrappers.WandBLogger method)
wandb_log_summary() (sinergym.utils.wrappers.WandBLogger method)
WandBLogger (class in sinergym.utils.wrappers)
WandBOutputFormat (class in sinergym.utils.logger)
weather_path (sinergym.config.modeling.ModelJSON property)
(sinergym.envs.eplus_env.EplusEnv property)
workspace_path (sinergym.envs.eplus_env.EplusEnv property)
write() (sinergym.utils.logger.WandBOutputFormat method)
Y
yellow (sinergym.utils.logger.CustomFormatter attribute)
Z
zone_names (sinergym.envs.eplus_env.EplusEnv property)
Other Versions
v: v3.6.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