sunpy / sunpy

SunPy - Python for Solar Physics
http://www.sunpy.org
BSD 2-Clause "Simplified" License
894 stars 580 forks source link

Improving "Acquiring data" docs page #2948

Closed dstansby closed 1 year ago

dstansby commented 5 years ago

ref - https://docs.sunpy.org/en/latest/guide/acquiring_data/index.html - this isn't a criticism at all, but a suggestion for improved docs.

If I want to download e.g. AIA 193 data, I would probably go to the SunPy docs, then find the "Acquiring data" page. From that page it is not obvious to me what to do though. In particular, I don't really know what the following mean or which one I should use, which are the top level options in the bulleted list

Maybe that page could do with a little bit of narrative documentation that tells users which of these options can be used for common tasks?

See #3800 as well.

dpshelio commented 5 years ago

I would say the page should only show Fido and other pages for other methods.

m11dedhia commented 3 years ago

I would like to work on this, @nabobalis what all should i necessarily add and what could make the doc even better?

nabobalis commented 3 years ago

Hi @m11dedhia, the original comment has a bunch of information that frames what might need changing on that documentation page. What would you like to know in addition to that?

akshatvishu commented 2 years ago

Hey! This is Akshat, I would like to work on this issue but so far I had a hard time finding contrasts between the above packages mentioned but here were my initial observations after going through sun docs:

So, Is Fido the preferred way to go unless someone wants to do something specific? It would be very kind if someone can point me towards where to look for the use-cases of the above packages.

nabobalis commented 2 years ago

Fido is the prefered way for all data sources.

helioviewer will most likely be removed from sunpy in future.

akshatvishu commented 2 years ago

@nabobalis So, for the doc change we can just add preferred or default in the sidebar menu to Fido so, its visible for everyone especially newcomers or should we add "Using Fido for data acquisition is preferred " in the Finding and Downloading Data using Fido page.

My suggestion is something like this :

defau

Or we can also do this :

Screenshot from 2022-03-11 14-47-29

nabobalis commented 2 years ago

I don't like either approach.

Fundamentally, that section of documentation really needs a total rewrite now. Especially with the changes to Fido to add HEK support to it. As such, I am not sure this is a good first issue anymore.

akshatvishu commented 2 years ago

I see, thanks for your input!! Can you point me towards some doable first issues .

nabobalis commented 2 years ago

I see, thanks for your input!! Can you point me towards some doable first issues .

I would check out the other issues that have that label.

dstansby commented 1 year ago

I think the current page is good now, and solves my original issue