Fix issues with MeasureManager

.github/workflows/app_build.yml

@@ -66,7 +66,7 @@ jobs:
           BINARY_PKG_PATH: _CPack_Packages/Darwin/IFW
           COMPRESSED_PKG_PATH: _CPack_Packages/Darwin/TGZ
           MACOSX_DEPLOYMENT_TARGET: 11.0
-          SDKROOT: /Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk
+          SDKROOT: /Applications/Xcode_15.0.1.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk
           QT_OS_NAME: mac
           QT_ARCH: clang_64
         - os: macos-arm64
@@ -77,7 +77,7 @@ jobs:
           BINARY_PKG_PATH: _CPack_Packages/Darwin/IFW
           COMPRESSED_PKG_PATH: _CPack_Packages/Darwin/TGZ
           MACOSX_DEPLOYMENT_TARGET: 12.1
-          SDKROOT: /Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk
+          SDKROOT: /Applications/Xcode_15.0.1.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk
           QT_OS_NAME: mac
           QT_ARCH: arm_64
 
@@ -174,6 +174,9 @@ jobs:
             echo "Using previously installed ninja and IFW"
             echo "/Users/irvinemac/Qt/Tools/QtInstallerFramework/4.3/bin/" >> $GITHUB_PATH
           else
+            echo "Setting Xcode version"
+            sudo xcode-select -s "/Applications/Xcode_15.0.1.app/Contents/Developer/"
+
             echo "Using brew to install ninja"
             brew install ninja md5sha1sum ccache
 

src/openstudio_app/OpenStudioApp.cpp

@@ -221,6 +221,8 @@ OpenStudioApp::OpenStudioApp(int& argc, char** argv)
   waitDialog->show();
   emit resetWaitDialog();
 
+  measureManager().setResourcesPath(resourcesPath());
+
   // Non blocking
   startMeasureManagerProcess();
 
@@ -266,14 +268,11 @@ void OpenStudioApp::onMeasureManagerAndLibraryReady() {
         msgBox.setText(tr("Failed to start the Measure Manager. Would you like to keep waiting?"));
         msgBox.setStandardButtons(QMessageBox::Retry | QMessageBox::Close);
         if (msgBox.exec() == QMessageBox::Close) {
-          // this is a fatal error, application will close
-          showFailedMeasureManagerDialog();
-          QCoreApplication::exit();
-          return;
-        } else {
-          measureManager().waitForStarted(10000);
-          ++currentTry;
+          // user can cancel out of this quit, turns into retry
+          quit();
         }
+        measureManager().waitForStarted(10000);
+        ++currentTry;
       }
       LOG(Info, "Recovered from Measure Manager problem, managed to start it on try " << currentTry
                                                                                       << " at: " << toString(measureManager().url().toString()));
@@ -1174,8 +1173,9 @@ void OpenStudioApp::readSettings() {
   setLastPath(settings.value("lastPath", QDir::homePath()).toString());
   setDviewPath(openstudio::toPath(settings.value("dviewPath", "").toString()));
   m_currLang = settings.value("language", "en").toString();
-  m_useClassicCLI = settings.value("useClassicCLI", false).toBool();
-  LOG_FREE(Debug, "OpenStudioApp", "\n\n\nm_currLang=[" << m_currLang.toStdString() << "], m_useClassicCLI=" << m_useClassicCLI << "\n\n\n");
+  LOG_FREE(Debug, "OpenStudioApp",
+           "\n\n\nm_currLang=[" << m_currLang.toStdString() << "]"
+                                << "\n\n\n");
   if (m_currLang.isEmpty()) {
     m_currLang = "en";
   }
@@ -1246,6 +1246,7 @@ void OpenStudioApp::connectOSDocumentSignals() {
   connect(m_osDocument.get(), &OSDocument::changeLanguageClicked, this, &OpenStudioApp::changeLanguage);
   connect(m_osDocument.get(), &OSDocument::loadLibraryClicked, this, &OpenStudioApp::loadLibrary);
   connect(m_osDocument.get(), &OSDocument::loadExampleModelClicked, this, &OpenStudioApp::loadExampleModel);
+  connect(m_osDocument.get(), &OSDocument::loadShoeboxModelClicked, this, &OpenStudioApp::loadShoeboxModel);
   connect(m_osDocument.get(), &OSDocument::newClicked, this, &OpenStudioApp::newModel);
   connect(m_osDocument.get(), &OSDocument::helpClicked, this, &OpenStudioApp::showHelp);
   connect(m_osDocument.get(), &OSDocument::checkForUpdateClicked, this, &OpenStudioApp::checkForUpdate);
@@ -1267,6 +1268,7 @@ void OpenStudioApp::disconnectOSDocumentSignals() {
     disconnect(m_osDocument.get(), &OSDocument::configureExternalToolsClicked, this, &OpenStudioApp::configureExternalTools);
     disconnect(m_osDocument.get(), &OSDocument::loadLibraryClicked, this, &OpenStudioApp::loadLibrary);
     disconnect(m_osDocument.get(), &OSDocument::loadExampleModelClicked, this, &OpenStudioApp::loadExampleModel);
+    disconnect(m_osDocument.get(), &OSDocument::loadShoeboxModelClicked, this, &OpenStudioApp::loadShoeboxModel);
     disconnect(m_osDocument.get(), &OSDocument::newClicked, this, &OpenStudioApp::newModel);
     disconnect(m_osDocument.get(), &OSDocument::helpClicked, this, &OpenStudioApp::showHelp);
     disconnect(m_osDocument.get(), &OSDocument::checkForUpdateClicked, this, &OpenStudioApp::checkForUpdate);
@@ -1286,19 +1288,18 @@ void OpenStudioApp::measureManagerProcessFinished() {
   QByteArray stdErr = m_measureManagerProcess->readAllStandardError();
   QByteArray stdOut = m_measureManagerProcess->readAllStandardOutput();
 
-  QString text = tr("Measure Manager has crashed, attempting to restart. Do you want to reset Measure Manager settings?");
+  QString text = tr("Measure Manager has crashed. Do you want to retry?");
   QString detailedText;
   detailedText += stdErr;
   detailedText += stdOut;
 
-  QMessageBox messageBox(QMessageBox::Warning, tr("Measure Manager Crashed"), text, QMessageBox::RestoreDefaults | QMessageBox::Close, mainWidget(),
+  QMessageBox messageBox(QMessageBox::Critical, tr("Measure Manager Crashed"), text, QMessageBox::Retry | QMessageBox::Close, mainWidget(),
                          Qt::Dialog | Qt::MSWindowsFixedSizeDialogHint);
   messageBox.setDetailedText(detailedText);
 
-  if (messageBox.exec() == QMessageBox::RestoreDefaults) {
-    QSettings settings(QCoreApplication::organizationName(), QCoreApplication::applicationName());
-    settings.setValue("useClassicCLI", true);
-    m_useClassicCLI = true;
+  if (messageBox.exec() == QMessageBox::Close) {
+    // user can cancel out of quit, turns into retry
+    quit();
   }
 
   startMeasureManagerProcess();
@@ -1351,9 +1352,7 @@ void OpenStudioApp::startMeasureManagerProcess() {
   const QString program = toQString(openstudioCLIPath());
   QStringList arguments;
 
-  if (m_useClassicCLI) {
-    arguments << "classic";
-  }
+  // MeasureManager does not work in classic CLI https://github.com/NREL/OpenStudio/issues/5212
   arguments << "measure";
   arguments << "-s";
   arguments << portString;
@@ -1561,6 +1560,37 @@ void OpenStudioApp::loadExampleModel() {
   OpenStudioApp::setQuitOnLastWindowClosed(wasQuitOnLastWindowClosed);
 }
 
+void OpenStudioApp::loadShoeboxModel() {
+
+  bool wasQuitOnLastWindowClosed = OpenStudioApp::quitOnLastWindowClosed();
+  OpenStudioApp::setQuitOnLastWindowClosed(false);
+
+  if (m_osDocument) {
+    if (!closeDocument()) {
+      OpenStudioApp::setQuitOnLastWindowClosed(wasQuitOnLastWindowClosed);
+      return;
+    }
+    processEvents();
+  }
+
+  osversion::VersionTranslator versionTranslator;
+  versionTranslator.setAllowNewerVersions(false);
+
+  auto filePath = resourcesPath() / toPath("ShoeboxModel/ShoeboxExample.osm");
+  boost::optional<openstudio::model::Model> model = versionTranslator.loadModel(filePath);
+  if (model) {
+    m_osDocument = std::make_shared<OSDocument>(componentLibrary(), resourcesPath(), model, toQString(filePath), false, startTabIndex());
+    m_osDocument->setSavePath("");
+    connectOSDocumentSignals();
+
+    QTimer::singleShot(0, m_osDocument.get(), &OSDocument::markAsModified);
+  }
+
+  waitDialog()->hide();
+
+  OpenStudioApp::setQuitOnLastWindowClosed(wasQuitOnLastWindowClosed);
+}
+
 void OpenStudioApp::changeDefaultLibraries() {
   auto defaultPaths = defaultLibraryPaths();
   auto paths = libraryPaths();
@@ -1590,18 +1620,6 @@ void OpenStudioApp::removeLibraryFromsSettings(const openstudio::path& path) {
   writeLibraryPaths(paths);
 }
 
-void OpenStudioApp::showFailedMeasureManagerDialog() {
-
-  QString text = tr("The OpenStudio Application must close. Do you want to reset Measure Manager settings?\n\n");
-  QMessageBox::StandardButton reply = QMessageBox::critical(mainWidget(), QString("Failed to connect to Measure Manager"), text,
-                                                            QMessageBox::RestoreDefaults | QMessageBox::Close, QMessageBox::RestoreDefaults);
-  if (reply == QMessageBox::RestoreDefaults) {
-    QSettings settings(QCoreApplication::organizationName(), QCoreApplication::applicationName());
-    settings.setValue("useClassicCLI", true);
-    settings.sync();
-  }
-}
-
 void OpenStudioApp::showFailedLibraryDialog(const std::vector<std::string>& failedPaths) {
   if (!failedPaths.empty()) {
     QString text = tr("Failed to load the following libraries...\n\n");

src/openstudio_app/OpenStudioApp.hpp

@@ -169,6 +169,9 @@ class OpenStudioApp : public OSAppBase
   // Loads the result of openstudio::model::exampleModel()
   void loadExampleModel();
 
+  // Creates a skeleton measure based model
+  void loadShoeboxModel();
+
   // Checks what happened in the LibraryDialog preference panes, and calls writeLibraryPaths to set the user settings
   void changeDefaultLibraries();
 
@@ -225,8 +228,6 @@ class OpenStudioApp : public OSAppBase
     GBXML
   };
 
-  void showFailedMeasureManagerDialog();
-
   void showFailedLibraryDialog(const std::vector<std::string>& failedPaths);
 
   void import(fileType type);
@@ -275,7 +276,6 @@ class OpenStudioApp : public OSAppBase
   QTranslator m_qtTranslator;
   QTranslator m_qtBaseTranslator;
   QString m_currLang;
-  bool m_useClassicCLI;
 
   // Try to find DView (or DView.exe) inside the PATH env variable. Will return an *empty* path if couldn't infer it
   openstudio::path inferredDViewPath() const;

src/openstudio_app/Resources/ShoeboxModel/.gitignore

@@ -0,0 +1,5 @@
+stdout
+stderr
+out.osw
+run/
+reports/

src/openstudio_app/Resources/ShoeboxModel/README.md

@@ -0,0 +1,16 @@
+# OpenStudio Coalition Example Models
+
+Collection of OpenStudio Coalition Example Models
+
+## ShoeboxExample
+
+A simple model that creates a test building. The OSM only has the weather file and design days, the model is created via a collection of measures.
+
+Third party measures:
+
+- Model Articulation Measures:
+    - create_bar_from_space_type_ratios - https://github.com/NREL/openstudio-model-articulation-gem
+    - create_typical_building_from_model - https://github.com/NREL/openstudio-model-articulation-gem
+- Reporting Measures:
+    - openstudio_results - https://github.com/NREL/openstudio-common-measures-gem
+    - view_data - https://github.com/NREL/openstudio-common-measures-gem