Merge branch 'develop' into 168168673_Issue7476

.decent_ci-Linux.yaml

@@ -24,6 +24,8 @@ compilers:
       - ./scripts/dev/verify_file_encodings.py
       - ./scripts/dev/validate_idd_units.py
       - ./scripts/dev/find_byref_bool_override.py
+      - ./scripts/dev/check_for_tabs_in_idfs.py
+      - ./scripts/dev/check_for_bom_in_idfs.py
 
   - name: "gcc"
     version: "7.4"

.github/pull_request_template.md

@@ -1,34 +1,32 @@
 Pull request overview
 ---------------------
-Please change this line to a description of the pull request, with useful supporting information including whether it is a new feature, or fixes a defect, a cross reference to any defects addressed in this PR, the type of changes to be made, and whether diffs are expected/justified based on this change.
+ - Fixes #ISSUENUMBERHERE (IF THIS IS A DEFECT)
+ - DESCRIBE PURPOSE OF THIS PULL REQUEST
 
-### Work Checklist
+**NOTE: ENHANCEMENTS MUST FOLLOW A SUBMISSION PROCESS INCLUDING A FEATURE PROPOSAL AND DESIGN DOCUMENT PRIOR TO SUBMITTING CODE**
+
+### Pull Request Author
 Add to this list or remove from it as applicable.  This is a simple templated set of guidelines.
  - [ ] Title of PR should be user-synopsis style (clearly understandable in a standalone changelog context)
- - [ ] At least one of the following appropriate labels must be added to this PR to be consumed into the changelog:
-   - Defect: This pull request repairs a github defect issue.  The github issue should be referenced in the PR description
-   - Refactoring: This pull request includes code changes that don't change the functionality of the program, just perform refactoring
-   - NewFeature: This pull request includes code to add a new feature to EnergyPlus
-   - Performance: This pull request includes code changes that are directed at improving the runtime performance of EnergyPlus
-   - DoNoPublish: This pull request includes changes that shouldn't be included in the changelog
+ - [ ] Label the PR with at least one of: Defect, Refactoring, NewFeature, Performance, and/or DoNoPublish
+ - [ ] Pull requests that impact EnergyPlus code must also include unit tests to cover enhancement or defect repair
+ - [ ] Author should provide a "walkthrough" of relevant code changes using a GitHub code review comment process
+ - [ ] If any diffs are expected, author must demonstrate they are justified using plots and descriptions
+ - [ ] If changes fix a defect, the fix should be demonstrated in plots and descriptions
+ - [ ] If any defect files are updated to a more recent version, upload new versions here or on DevSupport
+ - [ ] If IDD requires transition, transition source, rules, ExpandObjects, and IDFs must be updated, and add IDDChange label
+ - [ ] If structural output changes, add to output rules file and add OutputChange label
+ - [ ] If adding/removing any LaTeX docs or figures, update that document's CMakeLists file dependencies
 
-### Review Checklist
+### Reviewer
 This will not be exhaustively relevant to every PR.
- - [ ] Functional code review (it has to work!)
- - [ ] If defect, results of running current develop vs this branch should exhibit the fix
+ - [ ] Perform a Code Review on GitHub
+ - [ ] If branch is behind develop, merge develop and build locally to check for side effects of the merge
+ - [ ] If defect, verify by running develop branch and reproducing defect, then running PR and reproducing fix
+ - [ ] If feature, test running new feature, try creative ways to break it
  - [ ] CI status: all green or justified
- - [ ] Performance: CI Linux results include performance check
- - [ ] Unit Test(s)
- - C++ checks:
-   - [ ] Argument types
-   - [ ] If any virtual classes, ensure virtual destructor included, other things
- - IDD changes:
-   - [ ] Verify naming conventions and styles, memos and notes and defaults
-   - [ ] Open windows IDF Editor with modified IDD to check for errors
-   - [ ] If transition, add to input rules file for interfaces
-   - [ ] If transition, add transition source
-   - [ ] If transition, update idfs
+ - [ ] Check that performance is not impacted (CI Linux results include performance check)
+ - [ ] Run Unit Test(s) locally
+ - [ ] Check any new function arguments for performance impacts
+ - [ ] Verify IDF naming conventions and styles, memos and notes and defaults
  - [ ] If new idf included, locally check the err file and other outputs
- - [ ] Required documentation updates?
- - [ ] ExpandObjects changes?
- - [ ] If output changes, including tabular output structure, add to output rules file for interfaces

CMakeLists.txt

@@ -7,7 +7,7 @@ endif()
 
 Project(EnergyPlus)
 
-CMAKE_MINIMUM_REQUIRED(VERSION 2.8)
+cmake_minimum_required(VERSION 3.5.1)
 
 if(${CMAKE_MAJOR_VERSION}.${CMAKE_MINOR_VERSION} VERSION_GREATER "3.0")
   CMAKE_POLICY(SET CMP0054 NEW) # CMake 3.1 added this policy
@@ -151,7 +151,6 @@ INCLUDE_DIRECTORIES( ${CMAKE_SOURCE_DIR}/third_party/Windows-CalcEngine/src/Sing
 INCLUDE_DIRECTORIES( ${CMAKE_SOURCE_DIR}/third_party/Windows-CalcEngine/src/SpectralAveraging/include)
 INCLUDE_DIRECTORIES( ${CMAKE_SOURCE_DIR}/third_party/Windows-CalcEngine/src/Tarcog/include)
 INCLUDE_DIRECTORIES( ${CMAKE_SOURCE_DIR}/third_party/Windows-CalcEngine/src/Viewer/include)
-INCLUDE_DIRECTORIES( ${CMAKE_BINARY_DIR}/src/EnergyPlus)  # so that any source can #include <ConfiguredFunctions.hh>
 
 #### Create interface for JSON for Modern C++ so we can include it in targets
 # add_library( ModernJSON INTERFACE )

cmake/Install.cmake

@@ -288,7 +288,7 @@ INSTALL( DIRECTORY testfiles/ DESTINATION ExampleFiles/
 # These files names are stored in variables because they also appear as start menu shortcuts later.
 set( RULES_XLS Rules9-1-0-to-9-2-0.md )
 install(FILES "${CMAKE_SOURCE_DIR}/release/Bugreprt.txt" DESTINATION "./")
-install(FILES "${CMAKE_SOURCE_DIR}/release/ep.gif" DESTINATION "./")
+install(FILES "${CMAKE_SOURCE_DIR}/release/favicon.png" DESTINATION "./")
 install(FILES "${CMAKE_SOURCE_DIR}/release/readme.html" DESTINATION "./")
 set(CPACK_RESOURCE_FILE_README "${CMAKE_SOURCE_DIR}/release/readme.html")
 
@@ -540,11 +540,11 @@ endif ()
 
 ##########################################################   S Y S T E M    L I B R A R I E S   ######################################################
 
-# TODO: is this unecessary now? I had forgotten to actually create a Libraries via cpack_add_component but everything seemed fined
-# At worse, try not to uncomment this as is, but place it inside an if(PLATFORM) statement
-#SET(CMAKE_INSTALL_UCRT_LIBRARIES TRUE)
-#INCLUDE(InstallRequiredSystemLibraries)
-#INSTALL(FILES ${CMAKE_INSTALL_SYSTEM_RUNTIME_LIBS} DESTINATION "./" COMPONENT Libraries)
+# Set to TRUE to install the Windows Universal CRT libraries for app-local deployment (e.g. to Windows XP).
+# This is meaningful only with MSVC from Visual Studio 2015 or higher, which is our case
+SET(CMAKE_INSTALL_UCRT_LIBRARIES TRUE)
+INCLUDE(InstallRequiredSystemLibraries)
+INSTALL(FILES ${CMAKE_INSTALL_SYSTEM_RUNTIME_LIBS} DESTINATION "./" COMPONENT Libraries)
 
 ######################################################################################################################################################
 #                                                    P A C K A G I N G   &   C O M P O N E N T S                                                     #
@@ -555,6 +555,10 @@ include(CPack)
 include(CPackIFW)
 # include(CPackComponent)
 
+# Note: If you ever need to debug a CPack Package Error in MSVC, right-click on "PACKAGE" target, click Properties
+# and in the Build Events > Post Build Event, edit the command that calls cpack to add `--verbose --debug`:
+# eg: `"C:\Program Files\CMake\bin\cpack.exe" -C $(Configuration) --config ./CPackConfig.cmake --verbose --debug`
+
 #cpack_add_component(EnergyPlus
   #DISPLAY_NAME "EnergyPlus"
   #DESCRIPTION "The EnergyPlus program itself"
@@ -597,7 +601,8 @@ cpack_add_component(Symlinks
 cpack_add_component(Licenses
   DISPLAY_NAME "Licenses"
   DESCRIPTION "License files for EnergyPlus"
-  REQUIRED)
+  REQUIRED
+  HIDDEN)
 
 # No need for system privileges for this
 cpack_add_component(CreateStartMenu
@@ -614,6 +619,7 @@ cpack_add_component(CopyAndRegisterSystemDLLs
   DISPLAY_NAME "Copy and Register DLLs"
   DESCRIPTION "This will copy and register system DLLs such as Fortran if they don't already exist"
   REQUIRED
+  HIDDEN
 )
 
 #cpack_add_component(Libraries

cmake/qtifw/install_operations.qs

@@ -60,8 +60,11 @@ function Component()
       component.addOperation("Execute", reg, "ADD", keyName, "/v", valueName, "/d", data, "/f");
 
       // Delete the entire keyName upon uninstallation
-      var keyName = "HKEY_CURRENT_USER\\Software\\VB and VBA Program Settings\\EP-Launch";
-      component.addOperation("Execute", "cmd", "/C", "echo Set up uninstall operation to delete EP-Launch registry keys", "UNDOEXECUTE", reg, "DELETE", keyName, "/f");
+      // Upon discussion, we do not want to delete this key where EP-Launch
+      // stores its settings (Options) such as text editor of choice etc
+      // So they remain available for other installations or next installation
+      // var keyName = "HKEY_CURRENT_USER\\Software\\VB and VBA Program Settings\\EP-Launch";
+      // component.addOperation("Execute", "cmd", "/C", "echo Set up uninstall operation to delete EP-Launch registry keys", "UNDOEXECUTE", reg, "DELETE", keyName, "/f");
 
       // And weirder still, to copy and register DLLs: done separately
     }