sunpy
sunpy copied to clipboard
sunpy
Deprecate CompositeMap?
Provide a general description of the issue or problem.
We decided to deprecate CompositeMap at the coordination meeting.
We should get this in for 4.1 ideally.
Presumably this means deprecate for removal? "We" did not include me.
Granted, CompositeMap is largely a plotting helper with a clunky API, and certainly could benefit significantly from updates. However, I feel that plotting helpers are not something to do away with lightly, and telling users to instead type in a sequence of commands isn't great for the user experience.
Maybe it should be moved over to sunpy.visualization?
If there is enough interest in updating and moving CompositeMap to sunpy.visualization, I would be happy to work on this. I can start working with suggestions from #2745 and #6085.
Also, it seems like #5940 might be a good addition to CompositeMap (e.g., a plot_rgb method).
I think the first step in deprecating composite map would be writing a tutorial that explains how to do everything CompositeMap does but with other classes/methods/functions. That way we can make sure that there are 'nice' ways to replace all the functionality of CompositeMap before actually doing the deprecation.
At the moment, I have adapted the current two CompositeMap tutorials (in the Example Gallery and Map guide) to use other (primarily plotting) methods. I also have a somewhat more advanced tutorial that overlays a masked map, unedited map, and contours. This last example does not fit the goal that examples achieve a singular task. However, I think it is useful in showing the steps required to combine several sunpy functionalities.
Should these remain individual tutorials for the Example Gallery? Or should these instead be part of a “Composite Plotting” guide in the documentation? If the preference is for the individual tutorials, I will open a draft pull request so everyone can review what I currently have done.
Without seeing them, it's hard for me to decide.
I would like the example gallery to still have long form content until we roll out tutorials.