Resolves #135 Add in option to support epJSON workflows #136
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
19 tasks
|
Converted to draft as need to add test cases. |
|
Added test for epJSON. Most of these will fail until NREL/OpenStudio#4419 is resolved. |
nllong
approved these changes
Sep 20, 2021
| # before this can be changed. | ||
| if @options[:epjson] | ||
| @logger.info 'Beginning the translation to epJSON' | ||
| @registry[:time_logger]&.start('Translating to EnergyPlus epJSON') |
|
|
||
| # Run using epJSON if @options[:epjson] true, otherwise use ID | ||
| if @options[:epjson] | ||
| command = popen_command("\"#{energyplus_exe}\" in.epJSON 2>&1") |
There was a problem hiding this comment.
is the extension really named epJSON?
| logger ||= ::Logger.new($stdout) | ||
| logger.info 'Translate IDF to epJSON in preparation for EnergyPlus' | ||
| a = ::Time.now | ||
| model_epjson = OpenStudio::EPJSON::toJSONString(model_idf) |
There was a problem hiding this comment.
nice to see EPJSON in OpenStudio natively.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #135
This PR adds support to pass in an argument to use epJSON file format to run EnergyPlus. Currently, IDF is still the default if this option is not set. The option menu on OpenStudio would look like the below menu where
--epjsonis a flag to pass into the workflow gem.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 -e, --epJSON use epJSON file format. The default is IDF -s, --socket PORT Pipe status messages to a socket on localhost PORT --debug Includes additional outputs for debugging failing workflows and does not clean up the run directory -h, --help Print this helpAs an example, to run a workflow using
--epJSONyou would invoke cli by running:openstudio run -e -w compact.oswCurrently, the workflow passes around the
@registry[:model_idf]to various steps in the workflow and manipulates this in various steps and then calls energyplus as subprocess with the final IDF file. This PR maintains this logic and only converts the final IDF to epJSON if@options[:epjson]is set to True.I think it would be preferable to work directly with epJSON, but I don't think all the workflow steps can support this as of now. Plus, the entire workflow process is likely to converted into C++ to support Python so it's probably not worth the effort to do that. This at least allows the usage of epJSON that is available in OpenStudio.