Add a plot and an image to the docs

[cdeil]

It would be very nice if the Astroquery gallery contained a plot (e.g. a Herzsprung-Russel-Diagram or whatever) and an image (e.g. the Galactic center region).

That's what I expected when I clicked "gallery". :-)

@keflavich If you don't want images in the repo because of the file size, then maybe an independent IPython notebook and a link to nbviewer would be better?

[keflavich]

I think perhaps snapshots of the table.show_in_browser(jsviewer=True) would be appropriate, but I like the HR diagram idea. 👍

[cdeil]

FYI: I don't plan to do this in case someone else wants to.
Once Fermi and TeVCat are done I can make a nice IPython notebook for gamma-rays.

[keflavich]

That sounds great. I've added a link to one ipynb in the splatalogue docs, but I think more demo notebooks would be very useful.

[cdeil]

@keflavich Where did you add that link?

[keflavich]

partway down the page at astroquery.readthedocs.org/en/latest/splatalogue/splatalogue.html. I think it should be cleaned up and moved to the Gallery

[keflavich]

Punting to wishlist.

[gracca]

I constructed a HR diagram using Astroquery, if you want to use it in the gallery:
https://github.com/gracca/XHIP-HR-Diagram

[cdeil]

@gracca I think that would be a great example! Are you be interested to turn this into a pull request for Astroquery (and change to docstrings in English)?

@keflavich How should the Gallery work technically? The simplest solution would probably be to commit PNG or SVG files to the repo, but there's also the option to let Sphinx make the plot and maybe even to use https://github.com/sphinx-gallery/sphinx-gallery or bokeh to get interactive plots. The main disadvantage of this is that the Sphinx build might fail from time to time when the download of the datasets doesn't work because the service isn't up.

[gracca]

My Python skills are rather poor, but I'll be glad to contribute! No problems with changing the docstrings to English. I'll see how to make the pull request.

[keflavich]

Thanks @gracca! Do you need help making the pull request?

@cdeil - I prefer the simpler solution for now; I prefer to have self-contained docs. But, we don't want to host too many images. If you want to make a PR to use sphinx-gallery, I'll support that, but I won't be implementing it myself.

[gracca]

@keflavich: Is it as simple as clonning astroquery repo and editing docs/gallery.rst to add the example? And then commit and pull?

[keflavich]

Pretty much, yeah. Unless we try one of the fancier plotting approaches
cdeil suggested
On Jan 8, 2015 8:49 PM, "Germán A. Racca" [email protected] wrote:

@keflavich https://github.com/keflavich: Is it as simple as clonning
astroquery repo and editing besancon.rst to add the example? And then
commit and pull?

—
Reply to this email directly or view it on GitHub
#307 (comment).

[cdeil]

@keflavich - So for this case you want the PNG to be committed into the repo?
(The other simple alternative would be to put a .. plot:: directive into the rst.)

[keflavich]

I've never used the .. plot:: directive; that sounds preferable if it works.

[cdeil]

@gracca - In case you haven't used the Sphinx plot directive before, here's an example:

• https://gammapy.readthedocs.org/en/latest/_sources/astro/source/snr.txt
• https://gammapy.readthedocs.org/en/latest/astro/source/snr.html

The drawback is that it will fail if the service isn't up ... but my suggestion would be to use it and if it turns out to be unreliable we can put the PNG or data in this repo or some other Github repo.

[keflavich]

Superseded by #3027