CityLearn 2.4.2__tar.gz → 2.5.0__tar.gz

{CityLearn-2.4.2/CityLearn.egg-info → citylearn-2.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
-Name: CityLearn
-Version: 2.4.2
+Name: citylearn
+Version: 2.5.0
 Summary: An open source Farama Foundation Gymnasium environment for benchmarking distributed energy resource control algorithms to provide energy flexibility in a district of buildings.
 Home-page: https://github.com/intelligent-environments-lab/CityLearn
 Author: Jose Ramon Vazquez-Canteli, Kingsley Nweye, Zoltan Nagy
@@ -31,3 +31,18 @@ pip install CityLearn
 
 ## Documentation
 Refer to the [docs](https://intelligent-environments-lab.github.io/CityLearn/).
+
+## CityLearn UI
+
+CityLearn UI is a visual dashboard for exploring simulation data generated by the CityLearn framework. It was developed to simplify the analysis of results from smart energy communities, district energy coordination, demand response (among other applications), allowing users to visually inspect building-level components, compare simulation KPIs, and create simulation schemas with ease.
+
+The interface is available in two options:
+
+* Web app: https://citylearnui.netlify.app/ (free hosted version — not recommended for sensitive/personal data)
+* Open-source code: https://github.com/Soft-CPS-Research-Group/citylearn-ui
+
+You can check a tutorial at the official CityLearn [website](https://intelligent-environments-lab.github.io/CityLearn/ui.html), in the CityLearn UI repository [README](https://github.com/Soft-CPS-Research-Group/citylearn-ui), or at the help [tooltip of the oficial webapp](https://citylearn-ui.netlify.app/admin/help).
+
+**Compatibility:** This version of the UI currently supports CityLearn v2.5.0 simulation data.
+
+**Developed by:** José, a member of the [SoftCPS](https://www2.isep.ipp.pt/softcps/), Software for Cyber-Physical Systems research group (ISEP, Portugal) in collaboration with the Intelligent Environments Lab, University of Texas at Austin.

{CityLearn-2.4.2 → citylearn-2.5.0}/README.md

@@ -16,4 +16,19 @@ pip install CityLearn
 ```
 
 ## Documentation
-Refer to the [docs](https://intelligent-environments-lab.github.io/CityLearn/).
+Refer to the [docs](https://intelligent-environments-lab.github.io/CityLearn/).
+
+## CityLearn UI
+
+CityLearn UI is a visual dashboard for exploring simulation data generated by the CityLearn framework. It was developed to simplify the analysis of results from smart energy communities, district energy coordination, demand response (among other applications), allowing users to visually inspect building-level components, compare simulation KPIs, and create simulation schemas with ease.
+
+The interface is available in two options:
+
+* Web app: https://citylearnui.netlify.app/ (free hosted version — not recommended for sensitive/personal data)
+* Open-source code: https://github.com/Soft-CPS-Research-Group/citylearn-ui
+
+You can check a tutorial at the official CityLearn [website](https://intelligent-environments-lab.github.io/CityLearn/ui.html), in the CityLearn UI repository [README](https://github.com/Soft-CPS-Research-Group/citylearn-ui), or at the help [tooltip of the oficial webapp](https://citylearn-ui.netlify.app/admin/help).
+
+**Compatibility:** This version of the UI currently supports CityLearn v2.5.0 simulation data.
+
+**Developed by:** José, a member of the [SoftCPS](https://www2.isep.ipp.pt/softcps/), Software for Cyber-Physical Systems research group (ISEP, Portugal) in collaboration with the Intelligent Environments Lab, University of Texas at Austin.

citylearn-2.5.0/citylearn/__init__.py

@@ -0,0 +1 @@
+__version__ = '2.5.0'

{CityLearn-2.4.2 → citylearn-2.5.0}/citylearn/agents/rbc.py

@@ -100,11 +100,26 @@ class HourRBC(RBC):
         
         else:
             for m, a, n, o in zip(self.action_map, self.action_names, self.observation_names, observations):
-                hour = o[n.index('hour')]
+                hour_observation = o[n.index('hour')]
+                hour = int(round(hour_observation))
+                # Support both 0-23 and 1-24 hour encodings.
+                hour_candidates = []
+
+                for candidate in (hour, hour % 24, ((hour - 1) % 24) + 1):
+                    if candidate not in hour_candidates:
+                        hour_candidates.append(candidate)
+
                 actions_ = []
 
                 for a_ in a:
-                    actions_.append(m[a_][hour]) 
+                    for candidate in hour_candidates:
+                        hour_map = m[a_]
+
+                        if candidate in hour_map:
+                            actions_.append(hour_map[candidate])
+                            break
+                    else:
+                        raise KeyError(f'Hour {hour_observation} not defined in action map for action {a_}.')
                 
                 actions.append(actions_)
 
@@ -467,7 +482,21 @@ class BasicElectricVehicleRBC_ReferenceController(BasicRBC): #change the name
 
                 elif "electric_vehicle" in n:
                     for hour in Building.get_periodic_observation_metadata()['hour']:
-                        value = 1
+                        if hour < 7:
+                            value = 0.4
+
+                        elif hour < 10:
+                            value = 1
+
+                        elif hour < 15:
+                            value = -1
+
+                        elif hour < 20:
+                            value = -0.6
+
+                        else:
+                            value = 0.8
+                            
                         action_map[n][hour] = value
 
                 elif "dhw_storage" in n: