-
Notifications
You must be signed in to change notification settings - Fork 295
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update quickstart documentation so that HRV channel is not loaded #1886
Conversation
Codecov Report
@@ Coverage Diff @@
## main #1886 +/- ##
=======================================
Coverage 93.95% 93.95%
=======================================
Files 285 285
Lines 43754 43754
=======================================
Hits 41108 41108
Misses 2646 2646
Flags with carried forward coverage won't be shown. Click here to find out more. Help us with your feedback. Take ten seconds to tell us how you rate us. |
This is a difficult change to accept because this section is specifically meant to show how wavelengths can be used in loading. The next section of documentation specifically says "You can load by wavelength (see above) or by name", this change breaks that. Is there a wavelength that can be requested that would load the original expected channel (like a wavelength just outside HRV but still inside VIS006's range)? Otherwise, are the rest of the instructions in the quickstart valid for HRV or will they fail when HRV is used? If not, should the output just be updated to reflect what is in HRV? Otherwise, should we change the quickstart to not use SEVIRI data because of this complication/complexity? |
The real problem here is Satpys logic to implicitly load HRV when asking for 0.6 µm, which may or may not be what users want. Thereby Satpy doesn't even show a warning that the request is ambiguous. Better would be a (global) config where priority con be configured between different behaviours in case of ambiguity: guess without warning, guess with warning, or error. When guessing, it could be the channel with the narrowest band, channel with the highest spatial resolution, or something else yet. See the dedicated issue #1721. |
Sure but that doesn't change that this PR requires more changes than it has. |
doc/source/quickstart.rst
Outdated
@@ -26,7 +26,7 @@ To load data from the files use the :meth:`Scene.load <satpy.scene.Scene.load>` | |||
method. Printing the Scene object will list each of the | |||
:class:`xarray.DataArray` objects currently loaded: | |||
|
|||
>>> global_scene.load([0.6, 0.8, 10.8]) | |||
>>> global_scene.load(['VIS006', 'VIS008', 'IR_108']) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What about changing 0.6
to VIS006
, but leaving the others. Then update the next sentence below this to something like "As shown above, Satpy allows data to be loaded by wavelength in micrometers or by name. If multiple variables match a wavelength or name then the highest (finest) resolution will be chosen (ex. SEVIRI HRV and VIS006 channels are both match a wavelength request of 0.6)."
I suggest we just use other channels in the example to avoid the ambiguity and fix this bad example quickly. Then we need to address the underlying problem, but in another PR |
pre-commit.ci autofix |
for more information, see https://pre-commit.ci
The quickstart guide currently says:
global_scene.load([0.6, 0.8, 10.8])
But, for SEVIRI, this will load the
HRV
channel and notVIS006
. This PR corrects the quickstart so thatVIS006
is loaded as expected.