User-defined options for AircraftModel
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 62
- Forks
- 43
- PR merge metrics
- No merged PRs in 30d
Description
It is not straightforward to set options for a user-defined aircraft model (e.g. B738AirplaneModel), although it is possible.
This is because an aircraft class is not instantiated by user, but it is passed to OpenConcept's mission analysis group as a class (not as an instance) and is instantiated internally by OpenConcept. Therefore, the user has to use model_options at a higher-level group to pass down the options to aircraft class.
This should be documented somewhere. Also I think we can get rid of the global variables in this example by using model_options.
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
Read the OpenMDAO model_options documentation linked in the issue, then inspect openconcept/examples/B738_aerostructural.py around line 81. Document how users pass options to a user-defined aircraft model through the higher-level mission analysis group, and update the example to use model_options instead of its global variables.
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
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100