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

Include an output variable in ResStock Parquet files

asked 2023-10-31 17:04:36 -0500

mfath's avatar

updated 2023-11-01 18:59:23 -0500

sashadf1's avatar


How can we include a specific output variable in ResStock final parquet files report? Is that possible? Currently the variable is being reported for each building id in the results_timeseries.csv and was wondering if we can report the average value in the final parquet file?


edit retag flag offensive close merge delete


Are you referring to the average of an individual building's timeseries or an average timeseries across multiple buildings or the averaging multiple building's annual energy use (this last one is the method my team has primarily used in our work to get a "representative" consumption value).

"Average value" is too vague.

sashadf1's avatar sashadf1  ( 2023-11-01 18:40:08 -0500 )edit

1 Answer

Sort by ยป oldest newest most voted

answered 2023-11-01 18:55:23 -0500

sashadf1's avatar

updated 2023-11-01 19:05:38 -0500

Previous versions of ResStock let you specify EnergyPlus output variables to report beyond ResStock's default variables, using the PAT GUI. Examples include things like Zone Air Temperature for each thermal zone. It looks like newer versions of ResStock let you specify a more detailed output using the simulation_output_report key in the yml.


include_timeseries_component_loads: true

include_timeseries_zone_temperatures: true

However, it is possible modifying the simulation_output_report key won't write the specific EnergyPlus variables you are looking for to the output parquet file. You need to look at what the reporting measure (specifically ReportSimulationOutput) is doing to process E+ output variables into the ResStock output fields.

The ruby file for Report Simulation Output is located at restock\resources\hpxml-measures\ReportSimulationOutput

You can also add your own reporting measures as long as they "work within the ResStock workflow."

If you want to report an "average value," writing your own reporting measure could be your best bet. That, or post-processing your results in Excel or Pandas or whatever other tool you are familiar with.

edit flag offensive delete link more


You can still request E+ output variables in the latest ResStock. Note the output_variables argument described here.

shorowit's avatar shorowit  ( 2023-11-01 19:08:06 -0500 )edit

Thank you both! @shorowit I am using the output_variables to report the variables of interest. But, they end up in the results_timeseries.csv file for each bldg. Is there a way to have them reported on the concatenated parquet files similar to some of the other timeseries?

mfath's avatar mfath  ( 2023-11-02 09:26:34 -0500 )edit

@mfath BuildStockBatch should already be including all the columns in the results_timeseries.csv in the concatenated parquet files. Are you finding them to be missing? Can you list which columns are missing?

rajeee's avatar rajeee  ( 2023-11-02 13:12:09 -0500 )edit

@rajeee thank you! variables that I am exporting in the output_variables section are not included in the concatenated parquet file. Though I am finding them in the results_timeseries.csv files for each bldg.

mfath's avatar mfath  ( 2023-11-02 16:00:02 -0500 )edit

Try iterating through results_timeseries.csv and creating your own concatenated parquet file? That's probably faster than digging through the resstock source code to figure out why output_variables aren't getting translated to the parquet.

sashadf1's avatar sashadf1  ( 2023-11-02 16:59:24 -0500 )edit

Your Answer

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

Add Answer

Training Workshops


Question Tools

1 follower


Asked: 2023-10-31 17:04:36 -0500

Seen: 95 times

Last updated: Nov 01 '23