Skip to content
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

Mention Table interface in "Creating a New Table File" in FITS docs #3552

Closed
astrofrog opened this issue Feb 27, 2015 · 6 comments
Closed

Mention Table interface in "Creating a New Table File" in FITS docs #3552

astrofrog opened this issue Feb 27, 2015 · 6 comments

Comments

@astrofrog
Copy link
Member

When people want to create a simple binary FITS table with no other HDUs, most users should probably just use the Table interface in Astropy instead and then write to FITS. Therefore I think in the io.fits docs (e.g. here: http://docs.astropy.org/en/stable/io/fits/index.html#creating-a-new-table-file) we should add a note to mention the Table interface, or maybe even provide an example.

(This is not high priority, so could be done as a starter GSoC project)

@embray
Copy link
Member

embray commented Feb 27, 2015

👍 (This is practically a FAQ).

@vinayak-mehta
Copy link
Contributor

@astrofrog
Copy link
Member Author

@vortex-ape - what you have is a good start, but please open a pull request so that we can comment on it in detail (pull requests can be updated once opened)

@embray
Copy link
Member

embray commented Mar 2, 2015

I don't think this should have been labeled package-novice now that I look.

@embray
Copy link
Member

embray commented Mar 3, 2015

Per #3561, it would also be nice to clarify in the docs that even when using the "lower-level" interface it is not strictly necessary to go through the effort of creating Column objects manually--that data already in a Numpy array can be used to directly create a FITS table as long as it's in a structured array. Direct use of the old interface is more of a FITS-ism, and only required in certain cases.

@vinayak-mehta
Copy link
Contributor

@embray - What more benefits can I add?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants