Half orbit mixin#7
Merged
Merged
Conversation
This file contains hidden or 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
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.
Add a mixin for the half orbit range query.
The main difficulty for the implementation is to rely on the information from the folder instead from the files. Scanning the folders is much quicker. Generally, we expect that the cycle_number information is in the folders. The pass_number information should still be fetched from the files with a reduced scan because the files are organized per half orbits so this information will not be in the folders (folders are used to group the files). The implementation of the half orbit mixin also needs to override the time_coverage implementation, because knowing the first and last cycles will reduce the number of folders to scan.
All these issues are adressed in this PR. The implementation always falls back to a full scan if a PerformanceWarning is issued. However, this warning is suppressed for all methods of the mixin except
cycle_range. This warning suppression is wanted because there will always be a partial scan of the files for thepass_numbercomponent of the half_orbit_range.The documentation has been updated with a section describing the mixin-related methods for each implementation.
Other points of interest is :
_pick_subset_before_files_scanto improve the code readability and reduce code duplication.filter_valueswere not sanitized (ie. converted to the expected type). This is now the case.List of breaking changes: