Question-and-Answer Resource for the Building Energy Modeling Community
Get started with the Help page
Ask Your Question

OpenStudio Analysis Spreadsheet Outputs

asked 2016-07-05 15:56:54 -0500

updated 2016-07-05 16:03:37 -0500

I've successfully run several analyses using the spreadsheet. However, I have not been able to include specific outputs other than the ones from the template.xlsx file. The documentation lacks a detailed description for setting up this sheet so I was hoping to fill in some blanks. Here's what I've done so far:

1) Modified the open_studio_results reporting measure to include a runner.registerValue statement in the run method. The SQL query has been tested and returns the correct value.

query = "SELECT Value FROM TabularDataWithStrings WHERE ReportName = 'Economics Results Summary Report' AND ReportForString = 'Entire Facility' AND TableName = 'Annual Cost' AND RowName = 'Cost' AND ColumnName = 'Total'"
value = sqlFile.execAndReturnFirstDouble(query).get
runner.registerValue("annual_cost_total", value)

2) Included it in the measures folder.

3) On the Outputs sheet I've included the following in the Measure/Variable Unique Name column (D).

edit retag flag offensive close merge delete


Did you also include the measure in the Variables worksheet?

shorowit gravatar imageshorowit ( 2016-07-05 16:17:02 -0500 )edit

I know this will sound wonky, but try putting that into a different reporting measure. Then make sure you are using measure.variable_name in the spreadsheet output tab. The exact name needed can be found by looking at the .json file for a datapoint.

BrianLBall gravatar imageBrianLBall ( 2016-07-06 10:27:33 -0500 )edit

actually, try 'standard_reports.annual_cost_total' in the spreadsheet. There usually isnt a open_studio_results measure that is avail in the workflow. I think those values get put into standard_reports. Any how, all the measures available in the workflow (as well as the arguments or values that are available) can be found in the data_points/{uuid}.json file

BrianLBall gravatar imageBrianLBall ( 2016-07-06 11:25:57 -0500 )edit

@shorowit - thanks for the suggestion. I tried and no luck.

@BrianLBall - looking at the JSON, it's actually standard_report_legacy.total_life_cycle_cost that i'm after, which incidentally looks like it's listed incorrectly in the example projects as standard_report.total_life_cycle_cost.

I should add that my goal is to download the CSV Results from the sims. It's unclear to me whether the Outputs sheet allows for user-defined outputs or simply those that are built-in and listed in the JSON file.

MatthewSteen gravatar imageMatthewSteen ( 2016-07-06 20:50:07 -0500 )edit

if you put the variable in the output tab and set the export column to true, the value should end up in the database and then be available on csv or rdataframe export

BrianLBall gravatar imageBrianLBall ( 2016-07-07 10:18:15 -0500 )edit

1 Answer

Sort by ยป oldest newest most voted

answered 2017-05-16 16:22:29 -0500

Chienman gravatar image

It's my understanding that the outputs your specify in the spreadsheet are pushed to the mongo container of the OS-server, not the SQL file? I may not be correct here. What can tell you is I've noticed that by logging into the Openstudio-server instance and getting inside of the container where mongo is deployed, you can start mongo and query it to see the specific outputs you've commanded. But I have not been able to figure out how to get inside of the container at run-time using the ruby bindings to export. I've thought that there must be some bash command you can run, but I haven't figured out how to get it to work.

So what I do is just build my own custom script as a ruby measure and scrape out everything I can find and push this to a new container somewhere else in the cloud so it can be optimized to handle throughput, a separate microservice just to store my results. I can get sneaky and also push specific outputs requested in the spreadsheet as arguments to this ruby measure, if that makes sense to you.

edit flag offensive delete link more

Your Answer

Please start posting anonymously - your entry will be published after you log in or create a new account.

Add Answer


Question Tools

1 follower


Asked: 2016-07-05 15:56:54 -0500

Seen: 782 times

Last updated: May 16