NatLabRockies / NatLabRockies/OpenStudio

Workflow: add an option that would save the OSM after applying a model measure as a unique name

Open
#5,441 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

component - Workflow Enhancement Request
Dominant language
C++
Stars
646
Forks
237
Avg merge
3d 11h
Merged PRs (30d)
10

Description

Enhancement Request

I'm quite often having to do this when debugging complex workflows or trying to understand what changes what, a simple runOptions / CLI flag to save the model before/after applying a given measure would be great.

Detailed Description

Possible Implementation

We run measures in a subdirectory named liked {number:03d}_{measure_dir_name}, so we could save the after OSM in a given folder like <run_directory>/debug as {number:03d}_{measure_dir_name}.osm

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the workflow measure execution path and the runOptions or CLI option handling, then inspect where measure subdirectories are named as {number:03d}_{measure_dir_name}. Done means an option can save the model before or after a selected measure into <run_directory>/debug using the proposed unique .osm filename.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
backend, cli
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.