search

sunpy / sunpy-soar

A sunpy plugin for accessing data in the Solar Orbiter Archive (SOAR).
https://docs.sunpy.org/projects/soar/
BSD 2-Clause "Simplified" License
17 stars 10 forks source link

Adding examples for wavelength and detector. #127

Closed NucleonGodX closed 1 month ago

NucleonGodX commented 2 months ago

This PR is a part of GSoC 2024, as the attributes detector and wavelength have been implemented, some gallery examples have been added for helping user understand their functioning.(#121)

Fixes https://github.com/sunpy/sunpy-soar/issues/121

nabobalis commented 2 months ago

What's the difference between the two examples?

NucleonGodX commented 2 months ago

What's the difference between the two examples?

So I've kept two examples from the view of instruments differentiation, two of instruments give range of wavelength(wavemin wavemax) and not the single wavelength column, thats why In my opinion it would be better if we show both the workings to the user.

And I think we would be interested in showing what happens in both conditions when a range is provided and when a single wavelength is provided for all instruments, so covering all these cases in one example felt quite long to me.

nabobalis commented 2 months ago

What's the difference between the two examples?

So I've kept two examples from the view of instruments differentiation, two of instruments give range of wavelength(wavemin wavemax) and not the single wavelength column, thats why In my opinion it would be better if we show both the workings to the user.

And I think we would be interested in showing what happens in both conditions when a range is provided and when a single wavelength is provided for all instruments, so covering all these cases in one example felt quite long to me.

This feels more like one large example or even like a tutorial than two separate examples. I don't see the need to separate this.

Could you try to work it into one large example instead?

hayesla commented 2 months ago

Following discussion on the GSOC update call, we decided that this should be more like a "how to guide" with a simple example for the example gallery.

The how to guide could be a bit more detailed description of how sunpy-soar works and how you can build different searches etc

nabobalis commented 1 month ago

This needs the main PR merged in.