NatLabRockies / NatLabRockies/OpenStudio

Investigate reducing the number of JSON files being written during workflow (measure_attributes.json, results.json, data_point_out_.json)

Open
#5,029 0 comments 0 reactions 1 assignee View on GitHub

@brianlball is already working on this.

Since Nov 13, 2023.

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

Description

Enhancement Request

Context: https://github.com/NREL/OpenStudio/pull/5028#pullrequestreview-1727908612

When things calm down, it'd be good to investigate this.

Detailed Description

  • We get the same info in measure_attributes.json, results.json and data_point_out.json...
  • measure_attributes.json is flushed after each apply measure Step (ModelMeasures, EnergyPlusMeasures,
    ReportingMeasures), then at the end of ReportingMeasures it's done once again and results.json is spat out too
  • Do we really need the data_point_out.json in addition to this?
  • Seems like we could just run the output of results.json/data_point_out.json at the end of the workflow run instead

Possible Implementation

Standardize on a single file.

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.