OpenMDAO / OpenMDAO/Aviary

Help users convert unconverted values

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

Nobody has claimed this yet.

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

Description

Missing documentation or idea for new documentation.

Aviary lists all the FLOPS and GASP variables that have not been converted by the fortran_to_aviary converter function, but there is no information on the best way for a user to replicate the functionality of those variables in Aviary.
We should add a documentation page to assist with describing how to implement the functionality, link to examples if we have them and/or include small code snippets to help.

A good example is FLOPS AERIN.VAPPR which would add a constraint on the VAPP output variable.
In aviary there is no mapping of VAPPR so it is ignored during conversion.
It is easy to replicate this by adding a constraint in Aviary that Mission.Landing.INITIAL_VELOCITY >= VAPPR. This can be added with prob.model.add_constraint(Mission.Landing.INITIAL_VELOCITY, lower=145, ref=1e2) sometime before prob.setup().
Issue #1222 provides some discussion for this specific variable.

Issue with existing documentation.

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.

Research direction

Start with the fortran_to_aviary converter and issue #1222 to understand how unconverted FLOPS and GASP variables are identified. Add a documentation page explaining how users can reproduce unmapped functionality, using FLOPS AERIN.VAPPR and the provided constraint example, with links or snippets where available. Done when users can follow the page to implement an unconverted variable in Aviary.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
64/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.