Sinergym
Start Here
1. Installation
2. Usage Example
sinergym
3. Buildings
4. Weathers
5. Architecture
6. Environments
7. Environments Configuration and Registration
8. Rewards
9. Controllers
10. Wrappers
11. Extra Configuration in Sinergym simulations
12. Output format
13. Deep Reinforcement Learning Integration
14. Sinergym with Google Cloud
15. Github Actions
16. Tests
Examples
17. Basic example
18. Getting information about Sinergym environments
19. Changing an environment registered in Sinergym
20. Default building control setting up an empty action interface
21. Wrappers example
22. Logger Wrapper personalization/configuration
23. Rule Controller example
24. 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.LoggerCallback 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.CSVLogger method)
(sinergym.utils.logger.CustomFormatter method)
(sinergym.utils.logger.Logger 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.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)
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)
activate_flag() (sinergym.utils.logger.CSVLogger method)
activate_logger() (sinergym.utils.wrappers.LoggerWrapper 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
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
check_env() (in module sinergym.utils.env_checker)
close() (sinergym.envs.eplus_env.EplusEnv method)
(sinergym.utils.wrappers.LoggerWrapper method)
convert_conf_to_env_parameters() (in module sinergym.utils.common)
CSVLogger (class in sinergym.utils.logger)
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_flag() (sinergym.utils.logger.CSVLogger method)
deactivate_logger() (sinergym.utils.wrappers.LoggerWrapper 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)
E
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)
evaluate_policy() (in module sinergym.utils.evaluation)
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_ids() (in module sinergym.utils.common)
get_record_keys() (in module sinergym.utils.common)
get_schedulers() (sinergym.config.modeling.ModelJSON method)
get_service_account_token() (in module sinergym.utils.gcloud)
getLogger() (sinergym.utils.logger.Logger 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)
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_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)
logger (sinergym.config.modeling.ModelJSON attribute)
(sinergym.envs.eplus_env.EplusEnv attribute)
(sinergym.simulators.eplus.EnergyPlus attribute)
(sinergym.utils.rewards.BaseReward 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)
LoggerCallback (class in sinergym.utils.callbacks)
LoggerEvalCallback (class in sinergym.utils.callbacks)
LoggerWrapper (class in sinergym.utils.wrappers)
M
make_eplus_args() (sinergym.simulators.eplus.EnergyPlus method)
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.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
normalize() (sinergym.utils.wrappers.NormalizeObservation method)
NormalizeAction (class in sinergym.utils.wrappers)
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)
OfficeGridStorageSmoothingActionConstraintsWrapper (class in sinergym.utils.wrappers)
P
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)
RBCIncrementalDatacenter (class in sinergym.utils.controllers)
read_from_bucket() (in module sinergym.utils.gcloud)
red (sinergym.utils.logger.CustomFormatter attribute)
render() (sinergym.envs.eplus_env.EplusEnv method)
reset (sinergym.utils.logger.CustomFormatter attribute)
reset() (sinergym.envs.eplus_env.EplusEnv method)
(sinergym.utils.wrappers.LoggerWrapper method)
(sinergym.utils.wrappers.MultiObsWrapper method)
(sinergym.utils.wrappers.NormalizeObservation method)
reverting_action() (sinergym.utils.wrappers.NormalizeAction method)
runperiod (sinergym.envs.eplus_env.EplusEnv property)
S
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_log_file() (sinergym.utils.logger.CSVLogger method)
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.evaluation
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.LoggerWrapper method)
(sinergym.utils.wrappers.MultiObjectiveReward method)
(sinergym.utils.wrappers.MultiObsWrapper method)
(sinergym.utils.wrappers.NormalizeObservation method)
step_size (sinergym.envs.eplus_env.EplusEnv property)
stop() (sinergym.simulators.eplus.EnergyPlus method)
T
timestep_per_episode (sinergym.envs.eplus_env.EplusEnv property)
U
unwrap_wrapper() (in module sinergym.utils.common)
update_child_locals() (sinergym.utils.callbacks.LoggerEvalCallback method)
update_weather_path() (sinergym.config.modeling.ModelJSON method)
upload_to_bucket() (in module sinergym.utils.gcloud)
V
var_handlers (sinergym.envs.eplus_env.EplusEnv property)
W
weather_path (sinergym.config.modeling.ModelJSON property)
(sinergym.envs.eplus_env.EplusEnv property)
workspace_path (sinergym.envs.eplus_env.EplusEnv property)
Y
yellow (sinergym.utils.logger.CustomFormatter attribute)
Z
zone_names (sinergym.envs.eplus_env.EplusEnv property)
Other Versions
v: v3.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