feat: add timeline plot for wind-up input data #51
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
samuelwnaylor
force-pushed
the
data-timeline-plot
branch
2 times, most recently
from
2302d07 to
74a48e4
Compare
Plot includes key milestones, analysis and exclusion periods. This provides a useful overview of the configuration used for an analysis.
samuelwnaylor
force-pushed
the
data-timeline-plot
branch
from
74a48e4 to
6fc587f
Compare
aclerc
requested changes
Feb 20, 2025
| *, | ||
| figsize: tuple[int, int] = (12, 6), | ||
| height_ratios: tuple[int, int] = (2, 1), | ||
| save_to_folder: Path | None = None, |
There was a problem hiding this comment.
if save_to_folder is None I would just return before doing anything, what do you think?
| @@ -773,6 +774,10 @@ def run_wind_up_analysis( | |||
| random_seed: int = RANDOM_SEED, | |||
| ) -> pd.DataFrame: | |||
| """Run a wind up analysis.""" | |||
| plot_input_data_timeline( | |||
| assessment_inputs=inputs, save_to_folder=inputs.plot_cfg.plots_dir if inputs.plot_cfg.save_plots else None | |||
There was a problem hiding this comment.
I prefer avoiding implicit type conversion (ie here I would have done save_to_folder=inputs.plot_cfg.plots_dir if inputs.plot_cfg.save_plots is not None else None) but I might be in the minority there
| def plot_input_data_timeline( | ||
| assessment_inputs: AssessmentInputs, | ||
| *, | ||
| figsize: tuple[int, int] = (12, 6), |
There was a problem hiding this comment.
I think to support wind farms with lots of turbines the figsize would want to be calculated, giving the figure more height when the number of turbines exceeds some number (say 10), and increasing the height of the figure up to some reasonable maximum. But I don't think it's essential for this PR.
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.
Plot includes key milestones, analysis and exclusion periods. This provides a useful overview of the configuration used for an analysis.
How has it been tested?
Example plots used as test cases may be viewed in the files:
tests/plots/baseline_images/test_input_data/input_data_timeline_fig_toggle.pngtests/plots/baseline_images/test_input_data/input_data_timeline_fig_prepost.pngDesign implementations to note?
Refactored the Smarteole
AssessmentInputsinto apytest.fixturewhich is then used across the Smarteole test cases.