Package Improvements (#120)

Addresses #100, #102
- [x] Reference the issue your PR is fixing
- [x] Assign at least 1 reviewer for your PR
- [x] Test with run_dwelling.py or other script
- [x] Update documentation as appropriate
- [x] Update changelog as appropriate

README.md

@@ -10,7 +10,7 @@ Contact: jeff.maguire@nrel.gov, michael.blonsky@nrel.gov, killian.mckenna@nrel.g
 
 ## Installation
 
-Note that OCHRE requires Python version 3.9 or higher
+Note that OCHRE requires Python version >=3.9 and <3.12
 
 ### Stand-alone Installation
 

changelog.md

@@ -13,6 +13,8 @@
 - Added EV max power and max SOC controls
 - Added OCHREException class to handle errors
 - Added warnings for HVAC and WH heat pumps with low COP
+- Moved default input file path for package installation
+- Replaced setup.py with pyproject.toml
 - Fixed bug with schedule file import using Pandas v2.2
 - Fixed bug with accounting for HVAC delivered heat for standalone HVAC runs 
 - Fixed bug with ASHP backup heater units
@@ -23,6 +25,7 @@
 - Fixed bug with battery/generator self-consumption controls
 - Fixed bug with WH and battery islanding time metrics
 - Fixed bug with state space model reduction algorithm
+- Fixed syntax warning for Python 3.12
 
 ### OCHRE v0.8.4-beta
 

ochre/CreateFigures.py

@@ -519,7 +519,7 @@ def plot_wh(dfs_to_plot, **kwargs):
     if ax1 is not None:
         ax1[0].set_ylabel('Hot Water Delivered (W)')
         ax2[0].set_ylabel('Hot Water Delivered (L/min)')
-        ax1[1].set_ylabel('Temperature ($^\circ$C)')
+        ax1[1].set_ylabel('Temperature ($^\\circ$C)')
 
     # plot water heater power and COP
     plot_info = [('Water Heating Electric Power (kW)', 'Electric Power', 'm'),

ochre/Simulator.py

@@ -327,7 +327,7 @@ def finalize(self, failed=False):
 
         elif self.output_to_parquet:
             output_files = [os.path.join(self.output_path, f) for f in os.listdir(self.output_path)
-                            if re.match(f'{self.name}.*\.parquet', f) and '_schedule.parquet' not in f]
+                            if re.match(f'{self.name}.*\\.parquet', f) and '_schedule.parquet' not in f]
             dfs = [pd.read_parquet(f) for f in sorted(output_files)]
             if self.results:
                 # add recent results that haven't been saved to a parquet file