Skip to content

Fix #5385 - add WorkflowJSON::setRootDir(path&) and setRunDir(path&) #5392

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
kbenne merged 2 commits into from
Apr 30, 2025
Merged

Fix #5385 - add WorkflowJSON::setRootDir(path&) and setRunDir(path&) #5392

kbenne merged 2 commits into from
Apr 30, 2025

Conversation

@jmarrec
Copy link
Collaborator

@jmarrec jmarrec commented Apr 1, 2025

Pull request overview

Pull Request Author

  • Model API Changes / Additions
  • Any new or modified fields have been implemented in the EnergyPlus ForwardTranslator (and ReverseTranslator as appropriate)
  • Model API methods are tested (in src/model/test)
  • EnergyPlus ForwardTranslator Tests (in src/energyplus/Test)
  • If a new object or method, added a test in NREL/OpenStudio-resources: Add Link
  • If needed, added VersionTranslation rules for the objects (src/osversion/VersionTranslator.cpp)
  • Verified that C# bindings built fine on Windows, partial classes used as needed, etc.
  • All new and existing tests passes
  • If methods have been deprecated, update rest of code to use the new methods

Labels:

  • If change to an IDD file, add the label IDDChange
  • If breaking existing API, add the label APIChange
  • If deemed ready, add label Pull Request - Ready for CI so that CI builds your PR

Review Checklist

This will not be exhaustively relevant to every PR.

  • Perform a Code Review on GitHub
  • Code Style, strip trailing whitespace, etc.
  • All related changes have been implemented: model changes, model tests, FT changes, FT tests, VersionTranslation, OS App
  • Labeling is ok
  • If defect, verify by running develop branch and reproducing defect, then running PR and reproducing fix
  • If feature, test running new feature, try creative ways to break it
  • CI status: all green or justified

@jmarrec jmarrec added Enhancement Request component - Workflow Pull Request - Ready for CI This pull request if finalized and is ready for continuous integration verification prior to merge. labels Apr 1, 2025
@jmarrec jmarrec self-assigned this Apr 1, 2025
@ci-commercialbuildings
Copy link
Collaborator

ci-commercialbuildings commented Apr 1, 2025 •
edited
Loading

CI Results for f8bfc69:

@jmarrec
Copy link
Collaborator Author

jmarrec commented Apr 2, 2025

@rajeee could you take one the installers here and try it out on actual workflows please?

@rajeee
Copy link

rajeee commented Apr 2, 2025

@rajeee could you take one the installers here and try it out on actual workflows please?

@jmarrec Sure but I would need Darwin installer for my Mac.

@jmarrec
Copy link
Collaborator Author

jmarrec commented Apr 2, 2025

Pfff, mac CI is again bricked at the CPack step

CPack Error: Problem copying the package: /Users/jenkins/git/OpenStudioIncremental/OS-build-release-v2/_CPack_Packages/Darwin/IFW/OpenStudio-3.10.0-alpha+f8bfc694fd-Darwin-x86_64.dmg to /Users/jenkins/git/OpenStudioIncremental/OS-build-release-v2/OpenStudio-3.10.0-alpha+f8bfc694fd-Darwin-x86_64.dmg

CPack Error: Error when generating package: OpenStudio

I tried rebooting the CI Run, maybe it'll work, maybe it won't. Don't have more access to it anyways, so otherwise we're stuck until @anchapin takes control.

@rajeee
Copy link

rajeee commented Apr 8, 2025 •
edited
Loading

@rajeee could you take one the installers here and try it out on actual workflows please?

I don't currently have a workflow that makes use of this new feature, but I did test it in a sample script. Seems to be working.

require 'openstudio'
workflow = OpenStudio::WorkflowJSON.new
workflow.setRunDir("I_can_name_my_run_dir_now")
workflow.setRootDir("I_can_name_my_root_dir_now")
workflow.setOswPath("I_could_only_set_my_osw_path_before")
runner = OpenStudio::Measure::OSRunner.new(workflow)
puts("#{runner.workflow.absoluteRunDir.to_s}")
puts("#{runner.workflow.absoluteRootDir.to_s}")
puts("#{runner.workflow.oswPath.get.to_s}")
╰─ openstudio rundir_test.rb                                                                                                                                                                            ─╯
/Users/radhikar/Documents/buildstock2025/resstock2025/measures/ResStockArgumentsPostHPXML/tests/I_can_name_my_root_dir_now/I_can_name_my_run_dir_now
/Users/radhikar/Documents/buildstock2025/resstock2025/measures/ResStockArgumentsPostHPXML/tests/I_can_name_my_root_dir_now
/Users/radhikar/Documents/buildstock2025/resstock2025/measures/ResStockArgumentsPostHPXML/tests/I_could_only_set_my_osw_path_before

@DavidGoldwasser DavidGoldwasser added this to the OpenStudio SDK 3.10.0 milestone Apr 29, 2025
@kbenne
Copy link
Contributor

kbenne commented Apr 30, 2025

Maybe I'm imaging this, but I have this feeling that @bonnema asked for something like this a long time ago. I know there was some kind of workflow setter he was looking for that surprisingly did not exist.

@kbenne kbenne merged commit 63bf90d into develop Apr 30, 2025
4 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kbenne kbenne kbenne approved these changes

Assignees

@jmarrec jmarrec

Labels

component - Workflow Enhancement Request Pull Request - Ready for CI This pull request if finalized and is ready for continuous integration verification prior to merge.

Projects

None yet

Milestone

OpenStudio SDK 3.10.0

Development

Successfully merging this pull request may close these issues.

Add setRunDir method to WorkflowJSON class

6 participants

@jmarrec @ci-commercialbuildings @rajeee @kbenne @DavidGoldwasser