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

Naming convention for arguments in osw file

asked 2018-06-25 22:56:46 -0500

katsuya.obara's avatar

updated 2018-06-26 12:34:38 -0500

I am trying to use command line interface to run OpenStudio applying measure Set Output Table to IP units referring to this page.
Even though I confirmed that seed file can run without error, when I try to run through command line using below batch file, seems they dont run without showing any message.

D: cd\C:\openstudio-2.4.0\bin\ "openstudio.exe" run --debug --workflow D:\Projects\Katsuya\1802_Grasshopper_Lecture\test\case4\OpenStudio\workflow.osw

I am wondering this problem is caused by missing arguments and try to find how the arguments should be specified but couldnt find.
Does anyone know how arguments should be specified for this measure? and any convention how arguments should be specified from xml file which suppose to summarize arguments for measure?
I added osw file below for your reference.

   "created_at" : "20180626T033154Z",
   "seed_file" : "D:/Projects/Katsuya/1802_Grasshopper_Lecture/test/case4/OpenStudio/case4.osm",
   "steps" : [
         "arguments" : {},
         "measure_dir_name" : "Set_Output_Table_to_IP_units"
   "updated_at" : "20180626T033155Z"

Updated osw file:

   "created_at" : "20180626T062141Z",
   "seed_file" : "D:/Projects/Katsuya/1802_Grasshopper_Lecture/test/case4/OpenStudio/case4.osm",
   "weather_file": "E:/Reference/Climate/epw/CHN_Hong.Kong.SAR.450070_CityUHK.epw",
   "steps" : [
         "measure_dir_name" : "Set_Output_Table_to_IP_units",
     "arguments" : {
   "updated_at" : "20180626T062142Z"
edit retag flag offensive close merge delete

1 Answer

Sort by ยป oldest newest most voted

answered 2018-06-25 23:45:21 -0500

The link you pointed to demonstrates arguments in the OSW Structure section. Also looking in that section see how the Weather file is defined. After addressing the weather file, if the CLI fails, please update the post if there is any feedback on from the CLI on what happened.

You can use "measure_paths" and "file_paths" as shown here. This example is a bit unique in that it points to directories that sit above the OSW file. Typically "measures" , "weather", and "seeds" will sit next to the OSW. I think when in those positions, paths may not have to be defined.

edit flag offensive delete link more


@David Goldwasser I got openstudio.exe is not recognized as an internal or external command. May I know where this exe file is located to register to environmental variable?

katsuya.obara's avatar katsuya.obara  ( 2018-06-26 01:31:50 -0500 )edit

C:\openstudio-x.y.z\bin if using version >= 2.0.0. C:\Program Files\OpenStudio x.y.z\bin if using 1.x

Julien Marrec's avatar Julien Marrec  ( 2018-06-26 06:36:30 -0500 )edit

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: 2018-06-25 22:56:46 -0500

Seen: 128 times

Last updated: Jun 26 '18