Remove state rates, control rates, and t_phase from the timeseries by default, and remove type prefix. #935
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
…, use the rate source name as the timeseries output
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
… option to a phase timeseries_option called use_prefix. Previous global behavior was being "sticky" during tests and could potentially cause trouble when loading phases. That functionality is next.
nsteffen
approved these changes
Jun 9, 2023
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
Toggles the PhaseTimeseriesOptions
include_state_rates,include_control_rates, andinclude_t_phaseto beFalseby default. This will result in expected outputs changing for some users, but will also cut down on the amount of information shown in the timeseries plots.Users can recover the old values by setting these options to
True.Dymos option
use_timeseries_prefixis also now defaulted toFalse, meaning timeseries outputs will no longer be prefixed by the type of variable they are.Again, users can recover the previous behavior by setting this option to
True.Related Issues
Backwards incompatibilities
Users expecting inclusion of these values in their timeseries outputs will need to either add them variable-by-variable or set the correct value of the relative option phase timeseries options or dymos global options.
Global dymos options
use_timeseries_prefixis now inPhase.timeseries_options['use_prefix'].New Dependencies
None