OpenMDAO / OpenMDAO/Aviary

Input Listing Tool

Open
#377 2 comments 0 reactions 1 assignee View on GitHub

@Kenneth-T-Moore is already working on this.

Since Jan 6, 2025.

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

Description

Desired capability or behavior.

from @jdgratz10:
Given the complex and customizable nature of Aviary models, the user needs a way that they can see a list of what input variables are required for their specific configuration, and which input variables are optional.

At first glance, a utility that lists all the unconnected inputs as required and the connected inputs as optional (via overriding) seems helpful. However, it would also be helpful for the user to have an idea of what minimal set is required. If we could develop some sort of tool that would trace through the code and identify inputs which are only ever used to calculate unconnected outputs, we could provide the user with a list of these inputs as well as the corresponding outputs they influence. Then, if the user did not care about those unconnected outputs, they could decide to simply not set the related inputs.

One caveat here will be that we will need to make sure to filter out outputs that are not technically connected anywhere but are used as constraints or objectives.

Is your feature request related to a problem? Please describe.

No response

Associated Bug Report

No response

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.