ugr-sail · AlejandroCN7 · Feb 11, 2025 · Feb 10, 2025 · Feb 10, 2025 · Feb 10, 2025
diff --git a/docs/source/pages/modules/sinergym.envs.eplus_env.EplusEnv.rst b/docs/source/pages/modules/sinergym.envs.eplus_env.EplusEnv.rst
@@ -22,6 +22,7 @@
       ~EplusEnv.info
       ~EplusEnv.render
       ~EplusEnv.reset
+      ~EplusEnv.set_seed
       ~EplusEnv.set_wrapper_attr
       ~EplusEnv.step
       ~EplusEnv.update_context

diff --git a/docs/source/pages/modules/sinergym.utils.wrappers.BaseLoggerWrapper.rst b/docs/source/pages/modules/sinergym.utils.wrappers.BaseLoggerWrapper.rst
@@ -1,4 +1,4 @@
-sinergym.utils.wrappers.BaseLoggerWrapper
+sinergym.utils.wrappers.BaseLoggerWrapper
 =========================================
 
 .. currentmodule:: sinergym.utils.wrappers

diff --git a/docs/source/pages/modules/sinergym.utils.wrappers.CSVLogger.rst b/docs/source/pages/modules/sinergym.utils.wrappers.CSVLogger.rst
@@ -1,4 +1,4 @@
-sinergym.utils.wrappers.CSVLogger
+sinergym.utils.wrappers.CSVLogger
 =================================
 
 .. currentmodule:: sinergym.utils.wrappers

diff --git a/docs/source/pages/modules/sinergym.utils.wrappers.DatetimeWrapper.rst b/docs/source/pages/modules/sinergym.utils.wrappers.DatetimeWrapper.rst
@@ -1,4 +1,4 @@
-sinergym.utils.wrappers.DatetimeWrapper
+sinergym.utils.wrappers.DatetimeWrapper
 =======================================
 
 .. currentmodule:: sinergym.utils.wrappers

diff --git a/docs/source/pages/modules/sinergym.utils.wrappers.DeltaTempWrapper.rst b/docs/source/pages/modules/sinergym.utils.wrappers.DeltaTempWrapper.rst
@@ -1,4 +1,4 @@
-sinergym.utils.wrappers.DeltaTempWrapper
+sinergym.utils.wrappers.DeltaTempWrapper
 ========================================
 
 .. currentmodule:: sinergym.utils.wrappers

diff --git a/docs/source/pages/modules/sinergym.utils.wrappers.DiscreteIncrementalWrapper.rst b/docs/source/pages/modules/sinergym.utils.wrappers.DiscreteIncrementalWrapper.rst
@@ -1,4 +1,4 @@
-sinergym.utils.wrappers.DiscreteIncrementalWrapper
+sinergym.utils.wrappers.DiscreteIncrementalWrapper
 ==================================================
 
 .. currentmodule:: sinergym.utils.wrappers

diff --git a/docs/source/pages/modules/sinergym.utils.wrappers.DiscretizeEnv.rst b/docs/source/pages/modules/sinergym.utils.wrappers.DiscretizeEnv.rst
@@ -1,4 +1,4 @@
-sinergym.utils.wrappers.DiscretizeEnv
+sinergym.utils.wrappers.DiscretizeEnv
 =====================================
 
 .. currentmodule:: sinergym.utils.wrappers

diff --git a/docs/source/pages/modules/sinergym.utils.wrappers.EnergyCostWrapper.rst b/docs/source/pages/modules/sinergym.utils.wrappers.EnergyCostWrapper.rst
@@ -1,4 +1,4 @@
-sinergym.utils.wrappers.EnergyCostWrapper
+sinergym.utils.wrappers.EnergyCostWrapper
 =========================================
 
 .. currentmodule:: sinergym.utils.wrappers

diff --git a/docs/source/pages/modules/sinergym.utils.wrappers.IncrementalWrapper.rst b/docs/source/pages/modules/sinergym.utils.wrappers.IncrementalWrapper.rst
@@ -1,4 +1,4 @@
-sinergym.utils.wrappers.IncrementalWrapper
+sinergym.utils.wrappers.IncrementalWrapper
 ==========================================
 
 .. currentmodule:: sinergym.utils.wrappers

diff --git a/docs/source/pages/modules/sinergym.utils.wrappers.LoggerWrapper.rst b/docs/source/pages/modules/sinergym.utils.wrappers.LoggerWrapper.rst
@@ -1,4 +1,4 @@
-sinergym.utils.wrappers.LoggerWrapper
+sinergym.utils.wrappers.LoggerWrapper
 =====================================
 
 .. currentmodule:: sinergym.utils.wrappers

diff --git a/docs/source/pages/modules/sinergym.utils.wrappers.MultiObjectiveReward.rst b/docs/source/pages/modules/sinergym.utils.wrappers.MultiObjectiveReward.rst
@@ -1,4 +1,4 @@
-sinergym.utils.wrappers.MultiObjectiveReward
+sinergym.utils.wrappers.MultiObjectiveReward
 ============================================
 
 .. currentmodule:: sinergym.utils.wrappers

diff --git a/docs/source/pages/modules/sinergym.utils.wrappers.MultiObsWrapper.rst b/docs/source/pages/modules/sinergym.utils.wrappers.MultiObsWrapper.rst
@@ -1,4 +1,4 @@
-sinergym.utils.wrappers.MultiObsWrapper
+sinergym.utils.wrappers.MultiObsWrapper
 =======================================
 
 .. currentmodule:: sinergym.utils.wrappers

diff --git a/docs/source/pages/modules/sinergym.utils.wrappers.NormalizeAction.rst b/docs/source/pages/modules/sinergym.utils.wrappers.NormalizeAction.rst
@@ -1,4 +1,4 @@
-sinergym.utils.wrappers.NormalizeAction
+sinergym.utils.wrappers.NormalizeAction
 =======================================
 
 .. currentmodule:: sinergym.utils.wrappers

diff --git a/docs/source/pages/modules/sinergym.utils.wrappers.NormalizeObservation.rst b/docs/source/pages/modules/sinergym.utils.wrappers.NormalizeObservation.rst
@@ -1,4 +1,4 @@
-sinergym.utils.wrappers.NormalizeObservation
+sinergym.utils.wrappers.NormalizeObservation
 ============================================
 
 .. currentmodule:: sinergym.utils.wrappers

diff --git a/.../sinergym.utils.wrappers.OfficeGridStorageSmoothingActionConstraintsWrapper.rst b/.../sinergym.utils.wrappers.OfficeGridStorageSmoothingActionConstraintsWrapper.rst
@@ -1,4 +1,4 @@
-sinergym.utils.wrappers.OfficeGridStorageSmoothingActionConstraintsWrapper
+sinergym.utils.wrappers.OfficeGridStorageSmoothingActionConstraintsWrapper
 ==========================================================================
 
 .. currentmodule:: sinergym.utils.wrappers

diff --git a/docs/source/pages/modules/sinergym.utils.wrappers.PreviousObservationWrapper.rst b/docs/source/pages/modules/sinergym.utils.wrappers.PreviousObservationWrapper.rst
@@ -1,4 +1,4 @@
-sinergym.utils.wrappers.PreviousObservationWrapper
+sinergym.utils.wrappers.PreviousObservationWrapper
 ==================================================
 
 .. currentmodule:: sinergym.utils.wrappers

diff --git a/docs/source/pages/modules/sinergym.utils.wrappers.ReduceObservationWrapper.rst b/docs/source/pages/modules/sinergym.utils.wrappers.ReduceObservationWrapper.rst
@@ -1,4 +1,4 @@
-sinergym.utils.wrappers.ReduceObservationWrapper
+sinergym.utils.wrappers.ReduceObservationWrapper
 ================================================
 
 .. currentmodule:: sinergym.utils.wrappers

diff --git a/docs/source/pages/modules/sinergym.utils.wrappers.VariabilityContextWrapper.rst b/docs/source/pages/modules/sinergym.utils.wrappers.VariabilityContextWrapper.rst
@@ -0,0 +1,47 @@
+sinergym.utils.wrappers.VariabilityContextWrapper
+=================================================
+
+.. currentmodule:: sinergym.utils.wrappers
+
+.. autoclass:: VariabilityContextWrapper
+   :members:                                                           
+   :undoc-members:               
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~VariabilityContextWrapper.__init__
+      ~VariabilityContextWrapper.class_name
+      ~VariabilityContextWrapper.close
+      ~VariabilityContextWrapper.get_wrapper_attr
+      ~VariabilityContextWrapper.has_wrapper_attr
+      ~VariabilityContextWrapper.render
+      ~VariabilityContextWrapper.reset
+      ~VariabilityContextWrapper.set_wrapper_attr
+      ~VariabilityContextWrapper.step
+      ~VariabilityContextWrapper.wrapper_spec
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~VariabilityContextWrapper.action_space
+      ~VariabilityContextWrapper.logger
+      ~VariabilityContextWrapper.metadata
+      ~VariabilityContextWrapper.np_random
+      ~VariabilityContextWrapper.np_random_seed
+      ~VariabilityContextWrapper.observation_space
+      ~VariabilityContextWrapper.render_mode
+      ~VariabilityContextWrapper.spec
+      ~VariabilityContextWrapper.unwrapped
+
+
diff --git a/docs/source/pages/modules/sinergym.utils.wrappers.WandBLogger.rst b/docs/source/pages/modules/sinergym.utils.wrappers.WandBLogger.rst
@@ -1,4 +1,4 @@
-sinergym.utils.wrappers.WandBLogger
+sinergym.utils.wrappers.WandBLogger
 ===================================
 
 .. currentmodule:: sinergym.utils.wrappers

diff --git a/docs/source/pages/modules/sinergym.utils.wrappers.WeatherForecastingWrapper.rst b/docs/source/pages/modules/sinergym.utils.wrappers.WeatherForecastingWrapper.rst
@@ -1,4 +1,4 @@
-sinergym.utils.wrappers.WeatherForecastingWrapper
+sinergym.utils.wrappers.WeatherForecastingWrapper
 =================================================
 
 .. currentmodule:: sinergym.utils.wrappers

diff --git a/docs/source/pages/modules/sinergym.utils.wrappers.rst b/docs/source/pages/modules/sinergym.utils.wrappers.rst
@@ -35,6 +35,7 @@
       OfficeGridStorageSmoothingActionConstraintsWrapper
       PreviousObservationWrapper
       ReduceObservationWrapper
+      VariabilityContextWrapper
       WandBLogger
       WeatherForecastingWrapper
 

diff --git a/docs/source/pages/wrappers.rst b/docs/source/pages/wrappers.rst
@@ -233,4 +233,19 @@ It requires that the air temperature and setpoints variables are defined in the
 
 If the environment has a unique setpoint variable for all zones, you can specify a single setpoint variable. Otherwise, you can specify a list of variables, one for each zone.
 
-.. important:: The air temperature variables and setpoints variables should be specified in the same order. The length of these lists should be the same, in case you are not using the same setpoint for all zones.
+.. important:: The air temperature variables and setpoints variables should be specified in the same order. The length of these lists should be the same, in case you are not using the same setpoint for all zones.
+
+**************************
+VariabilityContextWrapper
+**************************
+
+This wrapper introduces context changes (see :ref:`Context`) at specific steps based on a uniform distribution.
+
+When the event is triggered, delta values for the context variables and a time (in steps) for the change to occur are randomly determined based on the specified arguments.
+
+The configurable arguments include the space of the context variables, the range of possible delta values, and the range of steps in which the event can take place.
+
+If applying the deltas results in values outside the defined space, they will be clipped to remain within bounds before being applied.
+
+.. important:: If initial context values were not provided in environment initialization, initial context values will be selected randomly for this wrapper.
+
diff --git a/pyproject.toml b/pyproject.toml
@@ -6,7 +6,7 @@
 package-mode = true
 name = "sinergym"
 
-version = "3.7.8"
+version = "3.7.9"
 description = "Sinergym provides a Gymnasium-based interface to interact with building simulations. This allows control in simulation time through custom controllers, including reinforcement learning agents"
 license = "MIT"
 

diff --git a/sinergym/envs/eplus_env.py b/sinergym/envs/eplus_env.py
@@ -113,6 +113,7 @@ def __init__(
         self.meters = meters
         self.actuators = actuators
         self.context = context
+        self.initial_context = initial_context
 
         # ---------------------------------------------------------------------------- #
         #                    Define observation and action variables                   #
@@ -160,8 +161,8 @@ def __init__(
         # ---------------------------------------------------------------------------- #
 
         # Set initial context if exists
-        if initial_context is not None:
-            self.update_context(initial_context)
+        if self.initial_context is not None:
+            self.update_context(self.initial_context)
 
         # EnergyPlus simulator
         self.energyplus_simulator = EnergyPlus(
@@ -399,9 +400,9 @@ def step(self,
         reward, rw_terms = self.reward_fn(obs)
 
         # Update info with
-        info.update({'action': action})
-        info.update({'timestep': self.timestep,
-                    'reward': reward})
+        info.update({'action': action,
+                     'timestep': self.timestep,
+                     'reward': reward})
         info.update(rw_terms)
         self.last_info = info
 

diff --git a/sinergym/utils/rewards.py b/sinergym/utils/rewards.py
@@ -676,14 +676,6 @@ def __call__(self, obs_dict: Dict[str, Any]
             'comfort_threshold': self.comfort_threshold
         }
 
-        # Add temp_violations per zone
-        reward_terms.update(
-            {
-                f'{temperature_variable}_violation': temp_violation for temperature_variable,
-                temp_violation in zip(
-                    self.comfort_configuration.keys(),
-                    temp_violations)})
-
         return reward, reward_terms
 
     def _get_energy_consumed(self, obs_dict: Dict[str,