NatLabRockies / NatLabRockies/OpenStudio

Add a ForwardTranslator specific key in the out OSW

Open
#5,087 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Enhancement Request

Forward translator errors have no dedicated place in the out OSW, which makes it hard to diagnostic failures (or warnings) in that domain.

Detailed Description

It is possible that (in some cases?) these warnings are captured nowhere. Should probably test up the current situation before thinking about implementation.

Possible Implementation

Store the ft.warnings() / ft.errors in a dedicated OSW key. Requires changing the OSW schema.

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 examining how the current OSW output represents ForwardTranslator results and whether ft.warnings() and ft.errors are captured anywhere. Review the OSW schema before deciding how a dedicated key would fit, then verify that translator warnings and errors are represented in the resulting OSW.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
data, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.