OpenMDAO / OpenMDAO/Aviary

Max or min values in metadata

Open
#1,108 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
287
Forks
140
Avg merge
6d 14h
Merged PRs (30d)
18

Description

Desired capability or behavior.

Metadata could be expanded to optionally provide a maximum or minimum value. One example is mass scaler variables should be >= 0. AviaryValues can add checks alongside it's existing type checks. Type checking raises errors - we will need to decide if we want to do the same here or raise a warning.

If implemented, logical min and max values should be added where necessary in the variable metadata.

Contributor guide

No contributing guide indexed for this repository

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 tracing AviaryValues and its existing type checks, then locate the metadata definitions for mass scaler variables. Clarify whether invalid minimum or maximum values should raise errors or warnings, add the necessary logical bounds, and verify the resulting validation behavior with the relevant tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.