mdolab / mdolab/OpenAeroStruct
Clean up and standardize surface dictionary inputs and format
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 281
- Forks
- 135
- PR merge metrics
- No merged PRs in 30d
Description
With the introduction of a few more components and options, the surface dictionary has now become unruly, especially when using the wingbox or full set of options.
We need to either document this fully, have a simple example that explain what all the values are, or switch to using OM options dictionary. Maybe all of these would be effective.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the surface dictionary inputs and the existing component and option examples, especially the wingbox and full-option cases. Decide whether the work should document the current values, add a simple example, or move to an OpenMDAO options dictionary. Done means the surface inputs have a consistent, understandable format and their values are explained or represented by the chosen alternative.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 32/100