mdolab / mdolab/OpenAeroStruct
Improve drag polar example
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Python
- Stars
- 281
- Forks
- 135
- PR merge metrics
- No merged PRs in 30d
Description
https://github.com/mdolab/OpenAeroStruct/blob/master/openaerostruct/examples/drag_polar.py
This needs a few improvements:
- Add comments and API notes throughout
- Add labels to plots and clean up formatting
- Create a test to cover this file; could compare matplotlib output or at least numerical values
- Add doc to show how to use this
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 with openaerostruct/examples/drag_polar.py and compare it with nearby examples and existing test conventions. The work is complete when the example has comments and API notes, clearer plot labels and formatting, test coverage for its behavior, and documentation showing how to use it.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, testing
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100