Skip to content

Commit 02f4e12

Browse files
authored
Merge pull request #676 from lsst-dm/tickets/DM-26548
encourage astropy.table
2 parents 553c97a + d68413a commit 02f4e12

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

python/astropy.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Integration of Astropy core into the LSST software stack is an ongoing process t
1313
This document is not discussing Astropy affiliated packages, use of which must go through the standard :doc:`RFC </communications/rfc>` process.
1414
Not all Astropy core packages can be used by default.
1515

16-
The following packages can be used internally in packages if they do not leak into public APIs:
16+
The following packages can be used internally in packages:
1717

1818
* :mod:`astropy.coordinates`
1919
* :mod:`astropy.time`
@@ -27,17 +27,21 @@ For reading and writing files in FITS format, both :mod:`astropy.io.fits` and `f
2727
These libraries differ in the features available and in performance (with the latter usually surpassing the former).
2828
Developers must evaluate which works best for their use case and choose one accordingly.
2929

30+
3031
.. _fitsio: https://github.com/esheldon/fitsio
3132

3233
.. warning::
3334

3435
``lsst.afw.fits`` must not be used in any new Python code, as it is not considered memory safe.
3536

37+
If not interacting with C++ classes the use of ``astropy.table`` is encouraged.
38+
In particular, the Table class has beneficial properties over Pandas DataFrame.
3639
The interaction of Astropy with LSST C++ classes providing related functionality should be carefully monitored.
3740
If the code is already using ``afw`` it is strongly preferred that ``afw`` equivalents be used until such time as specific ``afw`` interfaces are deprecated.
3841
:mod:`astropy.table` views into ``afw.table`` tables can be used if required.
3942

40-
Changing public APIs to use the above Astropy packages requires prior permission and possibly an :doc:`RFC </communications/rfc>`.
43+
Changing any public APIs requires an :doc:`RFC </communications/rfc>`.
44+
Hence using Astropy in any public API must go through an RFC.
4145

4246
These items have functionality that is similar to that provided in LSST packages:
4347

0 commit comments

Comments
 (0)