Revision history [back]

You need to make a system call to the openstudio CLI. openstudio.exe run -w workflow.osw. Your workflow.osw can be as simple as:

{
   "seed_file" : "../model.osm",
   "weather_file" : "USA_IL_Chicago-OHare.Intl.AP.725300_TMY3.epw"
}

The OpenStudioApplication can also be used to configure your model / weather file, add measures etc, and it will create a workflow.osw in the model companion directory (= if you have a file called mymodel.osm you will find a folder next to it called mymodel/ and inside at mymodel/workflow.osw you have the workflow file). This is helpful to see what a valid workflow.osw looks like.

You need to make a system call to the openstudio CLI. openstudio.exe run -w workflow.osw. Your workflow.osw can be as simple as:

{
   "seed_file" : "../model.osm",
   "weather_file" : "USA_IL_Chicago-OHare.Intl.AP.725300_TMY3.epw"
}

The OpenStudioApplication can also be used to configure your model / weather file, add measures etc, and it will create a workflow.osw in the model companion directory (= if you have a file called mymodel.osm you will find a folder next to it called mymodel/ and inside at mymodel/workflow.osw you have the workflow file). This is helpful to see what a valid workflow.osw looks like.

$ openstudio run --help

Usage: openstudio run [options]

Options:

    -w, --workflow [FILE]            Specify the FILE path to the workflow to run
    -m, --measures_only              Only run the OpenStudio and EnergyPlus measures
    -p, --postprocess_only           Only run the reporting measures
        --export-epJSON              export epJSON file format. The default is IDF
    -s, --socket PORT                Pipe status messages to a socket on localhost PORT
        --show-stdout                Prints the output of the workflow run in real time to the console, including E+ output
        --debug                      Includes additional outputs for debugging failing workflows and does not clean up the run directory

Forward Translator Options:
        --[no-]runcontrolspecialdays Include RunControlSpecialDays (Holidays) [Default: True]
        --set-ip-tabular-output      Request IP units from E+ Tabular (HTML) Report [Default: False]
        --[no-]lifecyclecosts        Include LifeCycleCosts [Default: True]
        --[no-]sqlite-output         Request Output:SQLite from E+ [Default: True]
        --[no-]html-output           Request Output:Table:SummaryReports report from E+ [Default: True]
        --[no-]space-translation     Add individual E+ Space [Default: True]

Stdout Options: only available when --show-stdout is passed
        --add-timings                Print the start, end and elapsed times of each state of the simulation.
        --style-stdout               Style the stdout output to more clearly show the start and end of each state of the simulation

    -h, --help                       Print this help

You need to make a system call to the openstudio CLI. openstudio.exe run -w workflow.osw. Your workflow.osw can be as simple as:

{
   "seed_file" : "../model.osm",
   "weather_file" : "USA_IL_Chicago-OHare.Intl.AP.725300_TMY3.epw"
}

The OpenStudioApplication can also be used to configure your model / weather file, add measures etc, and it will create a workflow.osw in the model companion directory (= if you have a file called mymodel.osm you will find a folder next to it called mymodel/ and inside at mymodel/workflow.osw you have the workflow file). This is helpful to see what a valid workflow.osw looks like.

$ openstudio openstudio.exe run --help

Usage: openstudio run [options]

Options:

    -w, --workflow [FILE]            Specify the FILE path to the workflow to run
    -m, --measures_only              Only run the OpenStudio and EnergyPlus measures
    -p, --postprocess_only           Only run the reporting measures
        --export-epJSON              export epJSON file format. The default is IDF
    -s, --socket PORT                Pipe status messages to a socket on localhost PORT
        --show-stdout                Prints the output of the workflow run in real time to the console, including E+ output
        --debug                      Includes additional outputs for debugging failing workflows and does not clean up the run directory

Forward Translator Options:
        --[no-]runcontrolspecialdays Include RunControlSpecialDays (Holidays) [Default: True]
        --set-ip-tabular-output      Request IP units from E+ Tabular (HTML) Report [Default: False]
        --[no-]lifecyclecosts        Include LifeCycleCosts [Default: True]
        --[no-]sqlite-output         Request Output:SQLite from E+ [Default: True]
        --[no-]html-output           Request Output:Table:SummaryReports report from E+ [Default: True]
        --[no-]space-translation     Add individual E+ Space [Default: True]

Stdout Options: only available when --show-stdout is passed
        --add-timings                Print the start, end and elapsed times of each state of the simulation.
        --style-stdout               Style the stdout output to more clearly show the start and end of each state of the simulation

    -h, --help                       Print this help