Revision history [back]

OpenStudio 2.x introduced the OpenStudio Workflow (OSW). This is used by the OpenStudio application to run a single datapoint, and by PAT to run multiple datapoints (each datapoint has it's own in.osw file). It is not used by the "Apply Measure Now" dialog which applies a measure dynamically to your currently loaded model. An OSW identifies the seed model and EPW to be passed into a workflow, as well as the measures and measure arguments to be applied.

Before a simulation has been run you may find an file named "in.osw" or "data_point.osw", but after the simulation there should be an "out.osw" that is overloaded with additional information such as the info, warning, and error and messages.

You might be able to use this OSW file, which is structured as JSON, but there are some alternate options.

1. Use the out.osw (described above)
2. If you are running an algorithmic workflow (using PAT or Analysis Spreadsheet) you can download the CSV (results) from the analysis page. This CSV will have a row for each datapoint, and a column for each input variable used as well as output variables that have been requested.
3. OpenStudio measure have access to the OSW file. you could harvest data out of the OSW (pre or post simulation) and write out to the file format of your choice, after filtering or post-processing data how you want. An example use case we had for this was a variable describing when I building was built, that we wanted to maintain across multiple measures.

If you have more detailed questions about any of these three approaches, let me know. You get 1 for free, so I'd start with that and see if it works for what you need. I will point out that the out.osw can be long and harder to look through so you may want to look at the in.osw or data_point.osw first.

OpenStudio 2.x introduced the OpenStudio Workflow (OSW). This is used by the OpenStudio application to run a single datapoint, and by PAT to run multiple datapoints (each datapoint has it's own in.osw file). It is not used by the "Apply Measure Now" dialog which applies a measure dynamically to your currently loaded model. An OSW identifies the seed model and EPW to be passed into a workflow, as well as the measures and measure arguments to be applied.

Before a simulation has been run you may find an file named "in.osw" or "data_point.osw", but after the simulation there should be an "out.osw" that is overloaded with additional information such as the info, warning, and error and messages.messages generated by the measure when it was run.

You might be able to use this OSW file, which is structured as JSON, but there are some alternate options.

1. Use the out.osw (described above)
2. If you are running an algorithmic workflow (using PAT or Analysis Spreadsheet) you can download the CSV (results) from the analysis page. This CSV will have a row for each datapoint, and a column for each input variable used as well as output variables that have been requested.
3. OpenStudio measure have access to the OSW file. you could harvest data out of the OSW (pre or post simulation) and write out to the file format of your choice, after filtering or post-processing data how you want. An example use case we had for this was a variable describing when I building was built, that we wanted to maintain across multiple measures.

If you have more detailed questions about any of these three approaches, let me know. You get 1 for free, so I'd start with that and see if it works for what you need. I will point out that the out.osw can be long and harder to look through so you may want to look at the in.osw or data_point.osw first.

OpenStudio 2.x introduced the OpenStudio Workflow (OSW). This is used by the OpenStudio application to run a single datapoint, and by PAT to run multiple datapoints (each datapoint has it's own in.osw file). It is not used by the "Apply Measure Now" dialog which applies a measure dynamically to your currently loaded model. An OSW identifies the seed model and EPW to be passed into a workflow, as well as the measures and measure arguments to be applied.

Before a simulation has been run you may find an file named "in.osw" or "data_point.osw", but after the simulation there should be an "out.osw" that is overloaded with additional information such as the info, warning, and error and messages generated by the measure when it was run.

You might be able to use this OSW file, which is structured as JSON, but there are some alternate options.

1. Use the out.osw (described above)
2. If you are running an algorithmic workflow (using PAT or Analysis Spreadsheet) you can download the CSV (results) from the analysis page. This CSV will have a row for each datapoint, and a column for each input variable used as well as output variables that have been requested.
3. OpenStudio measure have access to the OSW file. you could harvest data out of the OSW (pre or post simulation) and write out to the file format of your choice, after filtering or post-processing data how you want. An example use case we had for this was a variable describing when I building was built, that we wanted to maintain across multiple measures.
4. Probably a better option than 3 (if you don't want to use it to change the downstream measure behavior) is to write your own custom PAT Project scripts, which is what you see on the results page. It is written in javascript. It doesn't have access to the OSM or EnergyPlus SQL file directly like a OpenStudio reporting measure does, but it does have access to anything in the OSW file, which includes any input values to measures or data pulled out of measures by SQL files using the 'runner.registerValue' method.

If you have more detailed questions about any of these three approaches, let me know. You get 1 for free, so I'd start with that and see if it works for what you need. I will point out that the out.osw can be long and harder to look through so you may want to look at the in.osw or data_point.osw first.

OpenStudio 2.x introduced the OpenStudio Workflow (OSW). This is used by the OpenStudio application to run a single datapoint, and by PAT to run multiple datapoints (each datapoint has it's own in.osw file). It is not used by the "Apply Measure Now" dialog which applies a measure dynamically to your currently loaded model. An OSW identifies the seed model and EPW to be passed into a workflow, as well as the measures and measure arguments to be applied.

Before a simulation has been run you may find an file named "in.osw" or "data_point.osw", but after the simulation there should be an "out.osw" that is overloaded with additional information such as the info, warning, and error and messages generated by the measure when it was run.

You might be able to use this OSW file, which is structured as JSON, but there are some alternate options.

1. Use the out.osw (described above)
2. If you are running an algorithmic workflow (using PAT or Analysis Spreadsheet) you can download the CSV (results) from the analysis page. This CSV will have a row for each datapoint, and a column for each input variable used as well as output variables that have been requested.
3. OpenStudio measure have access to the OSW file. you could harvest data out of the OSW (pre or post simulation) and write out to the file format of your choice, after filtering or post-processing data how you want. An example use case we had for this was a variable describing when I building was built, that we wanted to maintain across multiple measures.
4. Probably a better option than 3 (if you don't want to use it to change the downstream measure behavior) is to write your own custom PAT Project scripts, which is what you see on the results page. It is written in javascript. It doesn't have access to the OSM or EnergyPlus SQL file directly like a OpenStudio reporting measure does, but it does have access to anything in the OSW file, which includes any input values to measures or data pulled out of the SQL file by measures by SQL files using the 'runner.registerValue' method.

If you have more detailed questions about any of these three approaches, let me know. You get 1 for free, so I'd start with that and see if it works for what you need. I will point out that the out.osw can be long and harder to look through so you may want to look at the in.osw or data_point.osw first.

OpenStudio 2.x introduced the OpenStudio Workflow (OSW). This is used by the OpenStudio application to run a single datapoint, and by PAT to run multiple datapoints (each datapoint has it's own in.osw file). It is not used by the "Apply Measure Now" dialog which applies a measure dynamically to your currently loaded model. An OSW identifies the seed model and EPW to be passed into a workflow, as well as the measures and measure arguments to be applied.

Before a simulation has been run you may find an file named "in.osw" or "data_point.osw", but after the simulation there should be an "out.osw" that is overloaded with additional information such as the info, warning, and error and messages generated by the measure when it was run.

You might be able to use this OSW file, which is structured as JSON, but there are some alternate options.

1. Use the out.osw (described above)
2. If you are running an algorithmic workflow (using PAT or Analysis Spreadsheet) you can download the CSV (results) from the analysis page. This CSV will have a row for each datapoint, and a column for each input variable used as well as output variables that have been requested.
3. OpenStudio measure have access to the OSW file. you could harvest data out of the OSW (pre or post simulation) and write out to the file format of your choice, after filtering or post-processing data how you want. An example use case we had for this was a variable describing when I building was built, that we wanted to maintain across multiple measures.
4. Probably a better option than 3 (if you don't want to use it to change the downstream measure behavior) is to write your own custom PAT Project scripts, which is what you see on the results page. It is written in javascript. It doesn't have access to the OSM or EnergyPlus SQL file directly like a OpenStudio reporting measure does, but it does have access to anything in the OSW file, which includes any input values to measures or data pulled out of the SQL file by measures files using the 'runner.registerValue' method.

If you have more detailed questions about any of these three approaches, let me know. You get 1 for free, so I'd start with that and see if it works for what you need. I will point out that the out.osw can be long and harder to look through so you may want to look at the in.osw or data_point.osw first.

OpenStudio 2.x introduced the OpenStudio Workflow (OSW). This is used by the OpenStudio application to run a single datapoint, and by PAT to run multiple datapoints (each datapoint has it's own in.osw file). It is not used by the "Apply Measure Now" dialog which applies a measure dynamically to your currently loaded model. An OSW identifies the seed model and EPW to be passed into a workflow, as well as the measures and measure arguments to be applied.

Before a simulation has been run you may find an file named "in.osw" or "data_point.osw", but after the simulation there should be an "out.osw" that is overloaded with additional information such as the info, warning, and error and messages generated by the measure when it was run.

You might be able to use this OSW file, which is structured as JSON, but there are some alternate options.

1. Use the out.osw (described above)
2. If you are running an algorithmic workflow (using PAT or Analysis Spreadsheet) you can download the CSV (results) from the analysis page. This CSV will have a row for each datapoint, and a column for each input variable used as well as output variables that have been requested.
3. OpenStudio measure have access to the OSW file. OpenStudio Workflow through `runner.workflow.workflowSteps'. you could harvest data out of the OSW (pre or post simulation) and write out to the file format of your choice, after filtering or post-processing data how you want. An example use case we had for this was a variable describing when I building was built, that we wanted to maintain across multiple measures.
4. Probably a better option than 3 (if you don't want to use it to change the downstream measure behavior) is to write your own custom PAT Project scripts, which is what you see on the results page. It is written in javascript. It doesn't have access to the OSM or EnergyPlus SQL file directly like a OpenStudio reporting measure does, but it does have access to anything in the OSW file, which includes any input values to measures or data pulled out of the SQL file by measures files using the 'runner.registerValue' method.

If you have more detailed questions about any of these three approaches, let me know. You get 1 for free, so I'd start with that and see if it works for what you need. I will point out that the out.osw can be long and harder to look through so you may want to look at the in.osw or data_point.osw first.