From 65d5677293b7ff5a3b89735f90e748a6e7dc3143 Mon Sep 17 00:00:00 2001 From: William O'Mullane Date: Wed, 15 May 2024 17:23:33 +0100 Subject: [PATCH 1/2] encourage astropy.table --- python/astropy.rst | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/python/astropy.rst b/python/astropy.rst index 87f14c19..05773f7c 100644 --- a/python/astropy.rst +++ b/python/astropy.rst @@ -13,7 +13,7 @@ Integration of Astropy core into the LSST software stack is an ongoing process t This document is not discussing Astropy affiliated packages, use of which must go through the standard :doc:`RFC ` process. Not all Astropy core packages can be used by default. -The following packages can be used internally in packages if they do not leak into public APIs: +The following packages can be used internally in packages: * :mod:`astropy.coordinates` * :mod:`astropy.time` @@ -28,17 +28,20 @@ For reading and writing files in FITS format, both :mod:`astropy.io.fits` and `f These libraries differ in the features available and in performance (with the latter usually surpassing the former). Developers must evaluate which works best for their use case and choose one accordingly. + .. _fitsio: https://github.com/esheldon/fitsio .. warning:: ``lsst.afw.fits`` must not be used in any new Python code, as it is not considered memory safe. +If not interacting with C++ classes the use of ``astropy.table`` is encouraged. The interaction of Astropy with LSST C++ classes providing related functionality should be carefully monitored. 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. :mod:`astropy.table` views into ``afw.table`` tables can be used if required. -Changing public APIs to use the above Astropy packages requires prior permission and possibly an :doc:`RFC `. +Changing any public APIs requires prior an :doc:`RFC `. +Hence using Astropy in any public PAI must go through RFC. These items have functionality that is similar to that provided in LSST packages: From f2a22aec132194b69794e4a78670716df1675617 Mon Sep 17 00:00:00 2001 From: William O'Mullane Date: Wed, 15 May 2024 17:41:10 +0100 Subject: [PATCH 2/2] wording --- python/astropy.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/python/astropy.rst b/python/astropy.rst index 05773f7c..089c1f4d 100644 --- a/python/astropy.rst +++ b/python/astropy.rst @@ -40,8 +40,8 @@ The interaction of Astropy with LSST C++ classes providing related functionality 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. :mod:`astropy.table` views into ``afw.table`` tables can be used if required. -Changing any public APIs requires prior an :doc:`RFC `. -Hence using Astropy in any public PAI must go through RFC. +Changing any public APIs requires an :doc:`RFC `. +Hence using Astropy in any public API must go through an RFC. These items have functionality that is similar to that provided in LSST packages: