Move legacy code selection to input file #17
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
crecine
reviewed
Dec 28, 2023
Comment on lines
+158
to
+159
| user specifies. They could specify files to load and values to | ||
| replace here as well. |
There was a problem hiding this comment.
I know this isn't a result of this PR, but I'm confused by this sentence. Is this only referring to users that write their own load_inputs method?
There was a problem hiding this comment.
Yeah, I think so. The docstrings in methods_for_level_2 appear to be written for an audience of users writing their own level3 interface. Eventually we should have proper docstrings here and could move this kind of explanation to a level3 docs page.
crecine
reviewed
Dec 29, 2023
Co-authored-by: crecine <51181861+crecine@users.noreply.github.com>
Co-authored-by: crecine <51181861+crecine@users.noreply.github.com>
jdgratz10
previously requested changes
Jan 3, 2024
aviary/docs/examples/coupled_aircraft_mission_optimization.ipynb
Outdated
Show resolved
Hide resolved
johnjasa
approved these changes
Jan 9, 2024
crecine
approved these changes
Jan 9, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Which legacy code's methods can be used for a given input file is almost always limited to a single option based on which inputs were provided. Because of this, method selection was moved to a declaration in the input file to prevent mistakes when calling run_aviary.
Settingswas added to the variable hierarchy to hold new "meta-level" switches, including setting equations of motion, mass method, and verbosity/debug levelphase_infoand anything that needs to know mission method is now inmethods_for_level_2.pyDocs were updated to reflect this new, simplified interface. While updating the docs, I cleaned some of them up a bit.
Required future work:
methods_for_level_2.pymay be helpful to cleanup the logic and make it easier for level 2 users to customize analysis. Such assimpleandsolvedmission methods - they are technically sub-methods ofheight-energyand2DOF, and treating them differently than full equations of motion may be needed.Related Issues
Backwards incompatibilities
None
New Dependencies
None