NatLabRockies / NatLabRockies/OpenStudio
Incomplete out.osw file on otherwise successful (but slow) run
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 646
- Forks
- 237
- Avg merge
- 3d 11h
- Merged PRs (30d)
- 10
Description
Issue overview
This is related to #4821, however this incomplete out.osw only occurred to 1 of the 6 climate locations I ran this URBANopt feature even though they were all equally slow.I don't know if it is repeatable yet but I wanted to document it.
Current Behavior
This OSW ran successfully in URBANopt including running reporting measures making HTML files with the proper data, but at a certain point in the workflow measure were not updated with results, and the current measure step. I only noticed this when I was running a rake tasks that parses through the out.osw to generate a summary CSV file. It was failing because some measures didn't have result.
Expected Behavior
Every measure, even skipped measures should have a result value. In the case of skipped measures the result is skipped. This unexpected state of the file prevented proper use of the out.osw file. I don't know what state of runner was like at the time, but I assume this Issue this would have also impacted OSAF use of runner.registerValues.
Steps to Reproduce
See steps for issue #4821. In my case this happened to Atlanta, but not sure why. I also haven't confirmed yet if any of the runs on windows machine had this issue.
Possible Solution
Details
This out.osw file was about 30mb and 150k lines. I thought at first maybe some hard limit was it hit, but this didn't happen for the same feature in other climate zones, and there was at least one feature that had a larger out.osw (both in file size and number of lines) that didn't exhibit this behavior.
On the image below both workflows have 27 steps, but for some reason the one on the right shows it is only at stop 20 even though it is complete and successful.

The same two datapoints are below in the same order. Starting with add_packaged_ice_storage the workflow on the right doesn't have a result. This is true for every measure after that. Notice that the one that worked on the left is a larger out.osw file but didn't exhibit this behaivor.

Environment
Some additional details about your environment for this issue (if relevant):
- Mac 12.6 M1 Max 32GB memory
- OpenStudio 3.5.1+22e1db7be5
- URBANOpt 0.9.1
Context
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the incomplete out.osw with the successful run described in issue #4821, focusing on the runner workflow around the first measure without a result. Check how OSAF uses runner.registerValues and how the rake task parses out.osw. Done means every measure, including skipped measures, has a result and the summary CSV can be generated.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100