Merge remote-tracking branch 'origin/develop' into spaceCompLoads

.github/workflows/build_wheels.yml

@@ -47,7 +47,7 @@ jobs:
         path: ./dist
 
     - name: Deploy on Test PyPi
-      uses: pypa/[email protected].2
+      uses: pypa/[email protected].3
       with:
         repository-url: https://test.pypi.org/legacy/
         user: __token__

LICENSE.txt

@@ -1,4 +1,4 @@
-EnergyPlus, Copyright (c) 1996-2024, The Board of Trustees of the University of Illinois, The Regents of the University of California, through Lawrence Berkeley National Laboratory (subject to receipt of any required approvals from the U.S. Dept. of Energy), Oak Ridge National Laboratory, managed by UT-Battelle, Alliance for Sustainable Energy, LLC, and other contributors. All rights reserved.
+EnergyPlus, Copyright (c) 1996-2025, The Board of Trustees of the University of Illinois, The Regents of the University of California, through Lawrence Berkeley National Laboratory (subject to receipt of any required approvals from the U.S. Dept. of Energy), Oak Ridge National Laboratory, managed by UT-Battelle, Alliance for Sustainable Energy, LLC, and other contributors. All rights reserved.
 
 NOTICE: This Software was developed under funding from the U.S. Department of Energy and the U.S. Government consequently retains certain rights. As such, the U.S. Government has been granted for itself and others acting on its behalf a paid-up, nonexclusive, irrevocable, worldwide license in the Software to reproduce, distribute copies to the public, prepare derivative works, and perform publicly and display publicly, and to permit others to do so.
 

cmake/PythonCopyStandardLib.py

@@ -1,4 +1,4 @@
-# EnergyPlus, Copyright (c) 1996-2024, The Board of Trustees of the University
+# EnergyPlus, Copyright (c) 1996-2025, The Board of Trustees of the University
 # of Illinois, The Regents of the University of California, through Lawrence
 # Berkeley National Laboratory (subject to receipt of any required approvals
 # from the U.S. Dept. of Energy), Oak Ridge National Laboratory, managed by UT-

cmake/PythonFixUpTclTk.py

@@ -1,4 +1,4 @@
-# EnergyPlus, Copyright (c) 1996-2024, The Board of Trustees of the University
+# EnergyPlus, Copyright (c) 1996-2025, The Board of Trustees of the University
 # of Illinois, The Regents of the University of California, through Lawrence
 # Berkeley National Laboratory (subject to receipt of any required approvals
 # from the U.S. Dept. of Energy), Oak Ridge National Laboratory, managed by UT-

cmake/PythonGetBitSize.py

@@ -1,4 +1,4 @@
-# EnergyPlus, Copyright (c) 1996-2024, The Board of Trustees of the University
+# EnergyPlus, Copyright (c) 1996-2025, The Board of Trustees of the University
 # of Illinois, The Regents of the University of California, through Lawrence
 # Berkeley National Laboratory (subject to receipt of any required approvals
 # from the U.S. Dept. of Energy), Oak Ridge National Laboratory, managed by UT-

cmake/ReverseDDPostProcess.py

@@ -1,4 +1,4 @@
-# EnergyPlus, Copyright (c) 1996-2024, The Board of Trustees of the University
+# EnergyPlus, Copyright (c) 1996-2025, The Board of Trustees of the University
 # of Illinois, The Regents of the University of California, through Lawrence
 # Berkeley National Laboratory (subject to receipt of any required approvals
 # from the U.S. Dept. of Energy), Oak Ridge National Laboratory, managed by UT-

cmake/codesign_doc/conf.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python3
-# EnergyPlus, Copyright (c) 1996-2024, The Board of Trustees of the University
+# EnergyPlus, Copyright (c) 1996-2025, The Board of Trustees of the University
 # of Illinois, The Regents of the University of California, through Lawrence
 # Berkeley National Laboratory (subject to receipt of any required approvals
 # from the U.S. Dept. of Energy), Oak Ridge National Laboratory, managed by UT-

design/FY2025/NFP-epJSON-Editor-Enhancements.md

@@ -0,0 +1,135 @@
+CROSS PLATFORM epJSON EDITOR ENHANCEMENTS
+================
+
+**Jason Glazer, GARD Analytics**
+
+ - December 20, 2024
+
+
+## Justification for New Feature ##
+
+The cross-platform epJSON Editor developed in 2020-2021 used Python and the
+wxPython library, and was intended to be the replacement for the Windows-only IDF
+Editor that uses Visual Basic. Unfortunately, the wxPython library could not be
+effectively integrated with the EnergyPlus installer. Also, the existence of the
+epJSON Editor was not widely publicized, and currently most users still use the
+IDF format. For these reasons, few users have used epJSON Editor. To solve
+these problems, epJSON Editor will be refactored to use the Tkinter library 
+instead of wxPython, which is already part of the EnergyPlus installer. It will
+also support opening and saving the IDF format using convertInputFormat. These
+enhancements, along with some public notifications, should result in more users
+using epJSON Editor and, ultimately, the epJSON format.
+
+
+## E-mail and Conference Call Conclusions ##
+
+none
+
+## Overview ##
+
+A replacement for the popular Windows-only IDF Editor using a modern programming
+language was previously developed called "epJSON Editor." The epJSON Editor
+focused on use with the JSON-based epJSON format as an alternative to the IDF
+format and used Python and a cross-platform GUI library so that it could be used
+on Windows, MacOS, and Linux. It was developed but not widely tested or
+publicized, and few users of EnergyPus have tried it even though it includes 
+useful additional functionality compared to IDF Editor. GARD in conjunction with
+the NREL team, will update the epJSON Editor to use the EnergyPlus team's
+preferred GUI library called Tkinter instead of the wxPython library. To ease
+the transition to the new epJSON format, it is also expected that we will enable
+opening IDF files by using the existing convertInputFormat utility. Two small
+enhancements to convertInputFormat will be made to help facilitate user
+migration to that format and preserve object order and comments provided by the
+user, and to add field names. GARD will reach out to users for beta-testing, and
+the code will be updated in response to problems and suggestions provided by the
+testers, as well as known issues previously identified. A final version of the
+release will be included in the EnergyPlus installation packages for each
+platform.
+
+The current repository for the project is located here:
+
+https://github.com/ORNL-BTRIC/epJSON-Editor
+
+A list of feature suggestions is being maintained here:
+
+https://github.com/ORNL-BTRIC/epJSON-Editor/issues/15
+
+The origin for editor came from this issue:
+
+https://github.com/NREL/EnergyPlus/issues/7418
+
+That issue also includes a summary of a meeting with users of IDF Editor and what features they found most important.
+
+Two issues related to convertInputFormat are planned to be addressed as part of this work:
+
+Populate comments (!-) from IDD/schema when converting from epJSON to IDF
+
+https://github.com/NREL/EnergyPlus/issues/8987 
+
+Add ConvertInputFormat options to preserve object order and comments to facilitate round-tripping
+
+https://github.com/NREL/EnergyPlus/issues/8969 
+
+One widget that is not included in Tkinter that will be used is Tksheet
+
+https://pypi.org/project/tksheet/
+
+https://github.com/ragardner/tksheet
+
+
+## Approach ##
+
+The following steps are expected as part of this development effort:
+
+-	Update the repository to Python 3.12 (or later)
+- Create a mock-up of epJSON Editor using Tkinter widgets
+-	Refactor existing code to minimize non-GUI code in files using wxPython
+-	Remove wxPython and replace with Tkinter based on mock-up
+-	Allow multiple open files
+-	Possibly replace icons with better ones on hand
+-	Test to ensure features are consistent
+-	Fix known bugs
+-	Add additional unit test coverage
+-	Enable opening IDF file either by modifying convertInputFormat to save and use saved user comments and input 
+ object order and include field names or else create a new Python library to perform these functions
+-	Create installers for all types of user groups including part of EnergyPlus installer, pip, and Windows installer
+-	Encourage beta testing on all platforms
+-	Test by opening a variety of files including large user files
+-	Maybe use automated testing for GUI
+-	Fix issues found during beta testing
+-	Possibly add new features 
+-	Release testing and make final installers
+-	Publicize more widely
+-	Maybe add pop-up screen to IDF Editor to encourage the use of epJSON Editor
+
+
+## Testing/Validation/Data Sources ##
+
+Will add additional unit tests. May add GUI unit tests.
+
+## Input Output Reference Documentation ##
+
+None expected.
+
+## Input Description ##
+
+N/A
+
+## Outputs Description ##
+
+N/A
+
+## Engineering Reference ##
+
+None
+
+## Example File and Transition Changes ##
+
+N/A
+
+## References ##
+
+None.
+
+
+

doc/auxiliary-programs/src/weather-converter-program/epw-csv-format-in-out.tex

@@ -98,12 +98,12 @@ \subsection{Data Records (CSV)}\label{data-records-csv}
 \caption{EnergyPlus EPW CSV file (spreadsheet view) \protect \label{fig:energyplus-epw-csv-file-spreadsheet-view}}
 \end{figure}
 
-The figure above shows how the EnergyPlus EPW CSV file (initial header records) looks when opened in a spreadsheet. Each header record is shown in bold with data following the headers..
+Figure \ref{fig:energyplus-epw-csv-file-spreadsheet-view} shows how the EnergyPlus EPW CSV file (initial header records) looks when opened in a spreadsheet. Each header record is shown in bold with data following the headers..
 
 \begin{figure}[hbtp] % fig 18
 \centering
 \includegraphics[width=0.9\textwidth, height=0.9\textheight, keepaspectratio=true]{media/image016.png}
 \caption{EnergyPlus EPW CSV Data Records (spreadsheet view) \protect \label{fig:energyplus-epw-csv-data-records-spreadsheet}}
 \end{figure}
 
-The above figure shows how the data periods header record and the individual data records look when opened in a spread sheet. Again, the headers are shown in bold. Note that there are two header records for the data records - one with short names - one with longer more descriptive names.
+Figure \ref{fig:energyplus-epw-csv-data-records-spreadsheet} shows how the data periods header record and the individual data records look when opened in a spread sheet. Again, the headers are shown in bold. Note that there are two header records for the data records - one with short names - one with longer more descriptive names.

doc/tools/create_changelog.py

@@ -1,5 +1,5 @@
 #!/usr/bin/python
-# EnergyPlus, Copyright (c) 1996-2024, The Board of Trustees of the University
+# EnergyPlus, Copyright (c) 1996-2025, The Board of Trustees of the University
 # of Illinois, The Regents of the University of California, through Lawrence
 # Berkeley National Laboratory (subject to receipt of any required approvals
 # from the U.S. Dept. of Energy), Oak Ridge National Laboratory, managed by UT-

doc/tools/example_file_objects.py

@@ -1,5 +1,5 @@
 #!/usr/bin/python
-# EnergyPlus, Copyright (c) 1996-2024, The Board of Trustees of the University
+# EnergyPlus, Copyright (c) 1996-2025, The Board of Trustees of the University
 # of Illinois, The Regents of the University of California, through Lawrence
 # Berkeley National Laboratory (subject to receipt of any required approvals
 # from the U.S. Dept. of Energy), Oak Ridge National Laboratory, managed by UT-

doc/tools/example_file_summary.py

@@ -1,5 +1,5 @@
 #!/usr/bin/python
-# EnergyPlus, Copyright (c) 1996-2024, The Board of Trustees of the University
+# EnergyPlus, Copyright (c) 1996-2025, The Board of Trustees of the University
 # of Illinois, The Regents of the University of California, through Lawrence
 # Berkeley National Laboratory (subject to receipt of any required approvals
 # from the U.S. Dept. of Energy), Oak Ridge National Laboratory, managed by UT-

doc/tools/idd_parser_library.py

@@ -1,4 +1,4 @@
-# EnergyPlus, Copyright (c) 1996-2024, The Board of Trustees of the University
+# EnergyPlus, Copyright (c) 1996-2025, The Board of Trustees of the University
 # of Illinois, The Regents of the University of California, through Lawrence
 # Berkeley National Laboratory (subject to receipt of any required approvals
 # from the U.S. Dept. of Energy), Oak Ridge National Laboratory, managed by UT-

doc/tools/idf_parser_library.py

@@ -1,4 +1,4 @@
-# EnergyPlus, Copyright (c) 1996-2024, The Board of Trustees of the University
+# EnergyPlus, Copyright (c) 1996-2025, The Board of Trustees of the University
 # of Illinois, The Regents of the University of California, through Lawrence
 # Berkeley National Laboratory (subject to receipt of any required approvals
 # from the U.S. Dept. of Energy), Oak Ridge National Laboratory, managed by UT-

doc/tools/idf_summary_class.py

@@ -1,5 +1,5 @@
 #!/usr/bin/python
-# EnergyPlus, Copyright (c) 1996-2024, The Board of Trustees of the University
+# EnergyPlus, Copyright (c) 1996-2025, The Board of Trustees of the University
 # of Illinois, The Regents of the University of California, through Lawrence
 # Berkeley National Laboratory (subject to receipt of any required approvals
 # from the U.S. Dept. of Energy), Oak Ridge National Laboratory, managed by UT-

doc/tools/parse_ems_actuators.py

@@ -1,4 +1,4 @@
-# EnergyPlus, Copyright (c) 1996-2024, The Board of Trustees of the University
+# EnergyPlus, Copyright (c) 1996-2025, The Board of Trustees of the University
 # of Illinois, The Regents of the University of California, through Lawrence
 # Berkeley National Laboratory (subject to receipt of any required approvals
 # from the U.S. Dept. of Energy), Oak Ridge National Laboratory, managed by UT-

doc/tools/parse_latex_log.py

@@ -1,4 +1,4 @@
-# EnergyPlus, Copyright (c) 1996-2024, The Board of Trustees of the University
+# EnergyPlus, Copyright (c) 1996-2025, The Board of Trustees of the University
 # of Illinois, The Regents of the University of California, through Lawrence
 # Berkeley National Laboratory (subject to receipt of any required approvals
 # from the U.S. Dept. of Energy), Oak Ridge National Laboratory, managed by UT-

doc/tools/parse_output_variables.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-# EnergyPlus, Copyright (c) 1996-2024, The Board of Trustees of the University
+# EnergyPlus, Copyright (c) 1996-2025, The Board of Trustees of the University
 # of Illinois, The Regents of the University of California, through Lawrence
 # Berkeley National Laboratory (subject to receipt of any required approvals
 # from the U.S. Dept. of Energy), Oak Ridge National Laboratory, managed by UT-

idd/schema/generate_epJSON_schema.py

@@ -1,4 +1,4 @@
-# EnergyPlus, Copyright (c) 1996-2024, The Board of Trustees of the University
+# EnergyPlus, Copyright (c) 1996-2025, The Board of Trustees of the University
 # of Illinois, The Regents of the University of California, through Lawrence
 # Berkeley National Laboratory (subject to receipt of any required approvals
 # from the U.S. Dept. of Energy), Oak Ridge National Laboratory, managed by UT-

idd/schema/idd_parser.py

@@ -1,4 +1,4 @@
-# EnergyPlus, Copyright (c) 1996-2024, The Board of Trustees of the University
+# EnergyPlus, Copyright (c) 1996-2025, The Board of Trustees of the University
 # of Illinois, The Regents of the University of California, through Lawrence
 # Berkeley National Laboratory (subject to receipt of any required approvals
 # from the U.S. Dept. of Energy), Oak Ridge National Laboratory, managed by UT-

idd/schema/modify_schema.py

@@ -1,4 +1,4 @@
-# EnergyPlus, Copyright (c) 1996-2024, The Board of Trustees of the University
+# EnergyPlus, Copyright (c) 1996-2025, The Board of Trustees of the University
 # of Illinois, The Regents of the University of California, through Lawrence
 # Berkeley National Laboratory (subject to receipt of any required approvals
 # from the U.S. Dept. of Energy), Oak Ridge National Laboratory, managed by UT-

idd/schema/test_idd_parser.py

@@ -1,4 +1,4 @@
-# EnergyPlus, Copyright (c) 1996-2024, The Board of Trustees of the University
+# EnergyPlus, Copyright (c) 1996-2025, The Board of Trustees of the University
 # of Illinois, The Regents of the University of California, through Lawrence
 # Berkeley National Laboratory (subject to receipt of any required approvals
 # from the U.S. Dept. of Energy), Oak Ridge National Laboratory, managed by UT-

scripts/dev/analyze_state.py

@@ -1,4 +1,4 @@
-# EnergyPlus, Copyright (c) 1996-2024, The Board of Trustees of the University
+# EnergyPlus, Copyright (c) 1996-2025, The Board of Trustees of the University
 # of Illinois, The Regents of the University of California, through Lawrence
 # Berkeley National Laboratory (subject to receipt of any required approvals
 # from the U.S. Dept. of Energy), Oak Ridge National Laboratory, managed by UT-

scripts/dev/api_debug_helper.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python3
-# EnergyPlus, Copyright (c) 1996-2024, The Board of Trustees of the University
+# EnergyPlus, Copyright (c) 1996-2025, The Board of Trustees of the University
 # of Illinois, The Regents of the University of California, through Lawrence
 # Berkeley National Laboratory (subject to receipt of any required approvals
 # from the U.S. Dept. of Energy), Oak Ridge National Laboratory, managed by UT-

scripts/dev/build_regression_summary.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-# EnergyPlus, Copyright (c) 1996-2024, The Board of Trustees of the University
+# EnergyPlus, Copyright (c) 1996-2025, The Board of Trustees of the University
 # of Illinois, The Regents of the University of California, through Lawrence
 # Berkeley National Laboratory (subject to receipt of any required approvals
 # from the U.S. Dept. of Energy), Oak Ridge National Laboratory, managed by UT-

scripts/dev/change_version.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python3
-# EnergyPlus, Copyright (c) 1996-2024, The Board of Trustees of the University
+# EnergyPlus, Copyright (c) 1996-2025, The Board of Trustees of the University
 # of Illinois, The Regents of the University of California, through Lawrence
 # Berkeley National Laboratory (subject to receipt of any required approvals
 # from the U.S. Dept. of Energy), Oak Ridge National Laboratory, managed by UT-

scripts/dev/check_constexpr.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-# EnergyPlus, Copyright (c) 1996-2024, The Board of Trustees of the University
+# EnergyPlus, Copyright (c) 1996-2025, The Board of Trustees of the University
 # of Illinois, The Regents of the University of California, through Lawrence
 # Berkeley National Laboratory (subject to receipt of any required approvals
 # from the U.S. Dept. of Energy), Oak Ridge National Laboratory, managed by UT-

scripts/dev/check_for_bom_in_idfs.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-# EnergyPlus, Copyright (c) 1996-2024, The Board of Trustees of the University
+# EnergyPlus, Copyright (c) 1996-2025, The Board of Trustees of the University
 # of Illinois, The Regents of the University of California, through Lawrence
 # Berkeley National Laboratory (subject to receipt of any required approvals
 # from the U.S. Dept. of Energy), Oak Ridge National Laboratory, managed by UT-

scripts/dev/check_for_c_style_comments.py

@@ -1,4 +1,4 @@
-# EnergyPlus, Copyright (c) 1996-2024, The Board of Trustees of the University
+# EnergyPlus, Copyright (c) 1996-2025, The Board of Trustees of the University
 # of Illinois, The Regents of the University of California, through Lawrence
 # Berkeley National Laboratory (subject to receipt of any required approvals
 # from the U.S. Dept. of Energy), Oak Ridge National Laboratory, managed by UT-

scripts/dev/check_for_enum_scope_usage.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-# EnergyPlus, Copyright (c) 1996-2024, The Board of Trustees of the University
+# EnergyPlus, Copyright (c) 1996-2025, The Board of Trustees of the University
 # of Illinois, The Regents of the University of California, through Lawrence
 # Berkeley National Laboratory (subject to receipt of any required approvals
 # from the U.S. Dept. of Energy), Oak Ridge National Laboratory, managed by UT-

scripts/dev/check_for_malformed_enums.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-# EnergyPlus, Copyright (c) 1996-2024, The Board of Trustees of the University
+# EnergyPlus, Copyright (c) 1996-2025, The Board of Trustees of the University
 # of Illinois, The Regents of the University of California, through Lawrence
 # Berkeley National Laboratory (subject to receipt of any required approvals
 # from the U.S. Dept. of Energy), Oak Ridge National Laboratory, managed by UT-

scripts/dev/check_for_switch_case_parentheses.py

@@ -1,4 +1,4 @@
-# EnergyPlus, Copyright (c) 1996-2024, The Board of Trustees of the University
+# EnergyPlus, Copyright (c) 1996-2025, The Board of Trustees of the University
 # of Illinois, The Regents of the University of California, through Lawrence
 # Berkeley National Laboratory (subject to receipt of any required approvals
 # from the U.S. Dept. of Energy), Oak Ridge National Laboratory, managed by UT-

scripts/dev/check_for_tabs.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-# EnergyPlus, Copyright (c) 1996-2024, The Board of Trustees of the University
+# EnergyPlus, Copyright (c) 1996-2025, The Board of Trustees of the University
 # of Illinois, The Regents of the University of California, through Lawrence
 # Berkeley National Laboratory (subject to receipt of any required approvals
 # from the U.S. Dept. of Energy), Oak Ridge National Laboratory, managed by UT-