merge: release 1.0.5 #10
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
Owner
gampnico
commented
May 29, 2023
gampnico
commented
- Perform and plot regressions.
- Mark API objects as deprecated.
Refs: ST-2, ST-122
Corrects package installation path. Refs: ST-2, ST-122
Refs: ST-26, ST-123
Adds method to MetricsFlux to perform regression on labelled data. Refs: ST-7, ST-106
Refs: ST-3, ST-7, ST-106
Creates scatter plot with optional regression line and optional annotation for the coefficient of determination. Refs: ST-3, ST-8, ST-106
Matplotlib plots generated by methods in metrics_calculations are now structured as list[tuple[plt.Figure, plt.Axes]] instead of stacked into a single tuple. Refs: ST-3, ST-7, ST-8, ST-124, ST-126
Adds ability to plot and save regression between calculated fluxes and innFLUX data. Fixes some incorrect test conditions which led to tests being skipped. Refs: ST-3, ST-7, ST-8, ST-106, ST-107
Begins:
- ST-126: Deprecate FigurePlotter.plot_iterated_fluxes in favour of
plot_iterated_metrics
Refs: ST-3, ST-7, ST-8
Begins deprecation of FigurePlotter.plot_iterated_fluxes in favour of MetricsFlux.plot_iterated_metrics. The former method is redundant. Refs: ST-7, ST-8, ST-126
Refs: ST-1, ST-7, ST-8
Refs: ST-1
* refactor: minor docstring fixes Refs: ST-2, ST-127 * refactor: update README Refs: ST-2, ST-127 * refactor: minor efficiency fixes Refs: ST-2, ST-5, ST-7, ST-127 * refactor: minor updates to test logic Refs: ST-3, ST-127 * refactor: improve code legibility in main Refs: ST-26, ST-127 * fix: remove unsupported type hinting Refs: ST-3, ST-127 Refs: ST-1, ST-127
* feat(backed): add decorators for deprecating objects
Call the decorator with:
from scintillometry.backend.deprecations import Decorators
@Decorators.deprecated(stage="...", reason="...", version="...")
def some_function(foo=...):
...
Refs: ST-3, ST-6, ST-128
* feat(backend): deprecate individual arguments
Adds method to deprecate individual function arguments.
```
from scintillometry.backend.deprecations import Decorators
@Decorators.deprecated_argument(stage, old_argument="new_argument")
def some_function(new_argument):
...
```
Refs: ST-3, ST-6, ST-128
* refactor(visuals): start deprecating plot_iterated_fluxes
Marks `plot_iterated_fluxes` as pending deprecation. This function is
superseded by `MetricsFlux.plot_iterated_metrics`.
Refs: ST-3, ST-8, ST-126
* refactor(metrics): deprecate argument in plot_iterated_metrics
Marks `site_location` as pending deprecation. Argument is replaced by
`location`.
Refs: ST-3, ST-7, ST-126
* docs(metrics): updates docstring noting deprecation
Refs: ST-2, ST-126
Refs: ST-1, ST-2
Refs: ST-1
Signed-off-by: gampnico <45390064+gampnico@users.noreply.github.com>
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.