Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v1.7.0-rc1 Testing: Call for help from the community #653

Closed
macumber opened this issue Dec 25, 2023 · 14 comments
Closed

v1.7.0-rc1 Testing: Call for help from the community #653

macumber opened this issue Dec 25, 2023 · 14 comments
Labels
Enhancement Request New feature or request

Comments

@macumber
Copy link
Collaborator

macumber commented Dec 25, 2023

Testing Instructions

The first release candidate of the 1.7.0 release has been posted. The 1.7.0 is a major release. It updates the OpenStudio SDK from 3.6.1 to 3.7.0.

Are you willing to test it out to help us make a great product? This will only take a few minutes of your time, yet it is absolutely critical for us to be aware of bugs.

Ready? You're awesome, thank you!

Go and download the executable from the v1.7.0-rc1 release. Please take a look at the release notes as they showcase the new features and bug fixes, so you know what to look for

Then try it out. You'll find a checklist below of things to try out, but please do feel free to go off-script, and if you can even try it out with your real world models that's even better.

When you're done, please report back by posting on this issue, with the following template filled out.

## Checklist

### Platform and version: <!--  eg: Ubuntu 20.04, macOS 10.15 x64, macOS 11.4 x64, macOS 12.3 arm64 (M1), Windows 10 20H2-->

* [ ] I could install the OpenStudioApp installer
* [ ] I could launch the OpenStudioApp.exe
* [ ] I can load File > Example > Example Model
* [ ] I can go to Geometry Preview and see the example model
* [ ] I can go to all tabs and see stuff loading
* [ ] I can create HVAC loops and assign a thermal zone
* [ ] I can search for Measures on the BCL
* [ ] I can put a measure in my workflow
* [ ] I can run a simulation
* [ ] I can see the simulation results (EnergyPlus Outputs, OpenStudio Results)
* [ ] I have tried enabling (and disabling) the Classic CLI
* [ ] I have tried creating and running a Python measure in the new CLI

## Problems found:

<!-- please describe -->

Thank you!

@macumber macumber added Enhancement Request New feature or request Triage Issue needs to be assessed and labeled, further information on reported might be needed and removed Triage Issue needs to be assessed and labeled, further information on reported might be needed labels Dec 25, 2023
@macumber
Copy link
Collaborator Author

I did notice that the default installer options do not include the Python bindings. If you attempt to drag a Python measure into a workflow and do not have the Python bindings installed the app will crash, I filed #656 for this issue.

My plan is to make the installer install the Python bindings by default. We should also better handle the error when arguments can't be computed.

@craig-simmons
Copy link

Checklist

Platform and version:

  • I could install the OpenStudioApp installer
  • I could launch the OpenStudioApp.exe (see notes)
  • I can load File > Example > Example Model
  • I can go to Geometry Preview and see the example model
  • I can go to all tabs and see stuff loading
  • I can create HVAC loops and assign a thermal zone
  • I can search for Measures on the BCL
  • I can put a measure in my workflow
  • I can run a simulation
  • I can see the simulation results (EnergyPlus Outputs, OpenStudio Results)
  • I have tried enabling (and disabling) the Classic CLI
  • I have tried creating and running a Python measure in the new CLI (sorry haven't written one yet)

Problems found:

Using Windows 11 Enterprise

  • Running EXE: I got a Windows Defender block, which can be bypassed but might be discouraging to some (doesn't happen with other recent OS App versions)
  • Classic CLI: Requires a restart. I'm also not sure what this does and it's not called out in the updates. Maybe add an explanation int he release notes?
  • Geometry Preview: The screen starts blank but as soon as I click and drag a little the image appears.

@macumber
Copy link
Collaborator Author

Thanks @craig-simmons! The Windows Defender block should go away when code signing is re-enabled (our subscription lapsed). A reboot is needed to restart the measure manager when changing between CLI versions, we can add a note in the release notes about why it is needed. My hope was that the dialog would be enough to make people know they need to restart at least.

@brgix
Copy link

brgix commented Dec 31, 2023

Checklist

Platform and version: macOS 14.2.1 (23C71), x64

  • I could install the OpenStudioApp installer
  • I could launch the OpenStudioApp.exe
  • I can load File > Example > Example Model
  • I can go to Geometry Preview and see the example model
  • I can go to all tabs and see stuff loading
  • I can search for Measures on the BCL
  • I can put a measure in my workflow
  • I can run a simulation
  • I can see the simulation results (EnergyPlus Outputs, OpenStudio Results)

Measures & Crashes

1. Measures + CLI

Ran an Example Model test with the TBD Measure. TBD/OpenStudioApplication v3.7.0rc1 ran successfully, modifying opaque building envelope surfaces before simulations. The classic CLI feedback provides (useful) Measure feedback, e.g.:

classic370rc1

... which I see no trace of with the revised CLI:

new370rc1

Am I missing something? Any plans to better support Measure feedback? Side note: a successful "stderr: EnergyPlus Completed Successfully" could be in green?

2. Crashes

OpenStudioApplication v3.7.0rc1 systematically crashes when opening/importing older .osm files (accessible here), specifically those generated by "Create DOE Prototype Building" Measure (circa OpenStudioApplication v2.9.1):

  • US DOE Prototype Warehouse (warehouse.osm)
  • US DOE Prototype SmallOffice (smalloffice.osm)
  • US DOE Prototype MidriseAppartment (midrise.osm)

Have not encountered such issues with previous OpenStudioApplication (or SDK) releases (>= v2.9.1). Have been regularly testing the same files when interacting with the SDK - no issues. In addition, OpenStudioApplication v3.7.0rc1 has no issue opening/visualizing/running the following models (see previous TBD repo link):

  • 5ZoneNoHVAC.osm v2.2.1
  • 5Zone_2.osm v2.9.1
  • seb.osm v1.11.5
  • resto2.osm v3.2.1
  • loscrigno.osm v2.9.1 (+ TBD)

Same for the provided Example Model (see listed tests above) - no issue.

Steps to reproduce crash:

  • Open any of the listed problem files, the 2 usual messages pop up:
  • ... "Model updated from 2.9.1 to 3.7.1"
  • ... "Invalid weather file object …"
  • Close both pop-ups (click on "OK")
  • App then becomes completely inactive (can't interact with any menu options)
  • Can't quit by selecting 'OpenStudioApplication > Quit OpenStudioApplication'
  • Command "Quit" (i.e. CMD-Q)
  • Select "Don't Save" when prompted "The document has been modified. Do you want to save changes?"
  • macOS crash report pops up ("OpenStudioApplication quit unexpectedly")
  • can send "longish" Apple crash report to App dev team (not sure I should share this publicly …)

I will pursue additional tests (deeper dives) later on .osm files that do not generate crashes ...


EDIT: KusudaAchenbach

Attempted to reproduce the issue raised here, linked to a missing OS:Site:GroundTemperature:Undisturbed:KusudaAchenbach entry when dragging/dropping a OS:GroundHeatExchanger:HorizontalTrench in a water loop. At the time, I couldn't reproduce the issue using OpenStudioApplication v1.6.0. I then tested what would happen if I manually deleted the trench's "Undisturbed Ground Temperature Model" entry, Indeed, in some circumstances blank entries are autofilled during forward translation. And in any case, the OS:Site:GroundTemperature:Undisturbed:KusudaAchenbach object is not something one can edit using the App. The missing entry generated the crash Ruth Urban described.

Now testing against OpenStudioApplication v1.7.0rc1, I can reproduce the exact issue without having to delete any entries by hand. The dragged/dropped OS:GroundHeatExchanger:HorizontalTrench has a blank entry for its "Undisturbed Ground Temperature Model" (it shouldn't). This generates the following:

trench370rc1

@macumber
Copy link
Collaborator Author

macumber commented Dec 31, 2023

Thanks @brgix! Better output of measures might be supported already, I'll try playing with the available options. @jmarrec might know if there are other options being looked at for more output in the future.

The files you linked open fine for me on Windows, so I'll have to see if those are a Mac only issue. I did confirm this issue on Mac, I suspect it is related to having two dialogs pop up and possibly the update to Qt 6.6.1.

@ckirney
Copy link

ckirney commented Jan 18, 2024

Checklist

Platform and version: Ubuntu 20.04

  • I could install the OpenStudioApp installer
  • I could launch the OpenStudioApp.exe
  • I can load File > Example > Example Model
  • I can go to Geometry Preview and see the example model
  • I can go to all tabs and see stuff loading
  • I can create HVAC loops and assign a thermal zone
  • I can search for Measures on the BCL
  • I can put a measure in my workflow
  • I can run a simulation
  • I can see the simulation results (EnergyPlus Outputs, OpenStudio Results)
  • I have tried enabling (and disabling) the Classic CLI
  • I have tried creating and running a Python measure in the new CLI

Problems found:

As mentioned above, I'm running Ubuntu 20.04. However, it is from a Docker container running on Windows 11 based on a derivative of NREL's OpenStudio 3.7.0 Docker image. You can find the container here (it has the 3.7.0 tag):

https://hub.docker.com/repository/docker/canmet/btap-development-environment/general

and the Dockerfile etc. for the container here:
https://github.com/canmet-energy/btap-development-environment/tree/3.7.0

Other things in the container run without issue but when I try running the OpenStudioApp I get the following error:

Fatal: This application failed to start because no Qt platform plugin could be initialized. Reinstalling the application may fix this problem.

Available platform plugins are: xcb.

Aborted

I'm not sure if this is a problem with the container or with the OpenStudioApp. The OpenStudioApp 1.6.0 ran without problem.

@jmarrec
Copy link
Collaborator

jmarrec commented Jan 19, 2024

@ckirney The OS App is a graphical application, and the docker has no display (it's just a TTY by default). You can't expect it to work like that. You'd need to setup a X server or a VNC server (google "How to run a GUI application from a docker container" or something). Anyways, this is off-topic for the purpose of RC testing.
And if you're on windows, I'd strongly suggest you avoid that footgun and just run the OSApp natively on windows.

@ckirney
Copy link

ckirney commented Jan 19, 2024

Sorry, I should have included that I do have an X server set-up (VcXsrv) on Windows and direct the GUI output through Docker to the X-server. We use the OSApp Windows version but also use the Linux Container for openstudio-standards and other development. Other GUIs function perfectly well on this container setup (e.g. RubyMine, PyCharm, terminator, which uses the x-server). Most past versions of the OSApp (including 1.6.0) and versions of OS before then (pre-3.0) have worked fine this way. However, if it is not supported I understand.

@jmarrec
Copy link
Collaborator

jmarrec commented Jan 19, 2024

@ckirney Maybe open another "issue" if you want to discuss potential fixes for this.
Try running the OSApp with QT_DEBUG_PLUGINS=1 OPENSTUDIO_APPLICATION_DEBUG=1 ./OpenStudioApp to see some infos.

@ckirney
Copy link

ckirney commented Jan 19, 2024

Thanks for the suggestion @jmarrec! I ran it and found the missing library (libxcb-cursor0). I installed it and now the OSApp starts. I can turn this into an issue if it helps. Otherwise, sorry for the trouble.

@jmarrec
Copy link
Collaborator

jmarrec commented Jan 19, 2024

Out of ccuriosity which was it?

@ckirney
Copy link

ckirney commented Jan 19, 2024

It was libxcb-cursor0.

@macumber
Copy link
Collaborator Author

Closing testing of 1.7.0-rc1 in preference to testing of 1.7.0-rc2 at #669

@jmarrec
Copy link
Collaborator

jmarrec commented Jan 22, 2024

I've bumped into libxcb-cursor0 during testing on a clean 22.04 VM and I'm adding it as a dependency in #676

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement Request New feature or request
Projects
None yet
Development

No branches or pull requests

5 participants