Documentation : add example use for global spectral transforms #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
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.
Description
This PR adds a use case in the gallery of examples, to show how the global spectral transforms can be used.
For GRIB files, this requires the use of the
get_spectral_geometry()function, currently insrc/epygram/cli/spectrum.py. This did not feel right, so I propose here to move this function tosrc/spectra.py, where all the other spectrum-related utility functions are stored.Detail of modifications
docs/source/gallery/C-data/03.spectral_filtering_global.ipynbget_spectral_geometry()function tospectra.py, and raise an error for GRIBs with geometries that are not handled.