Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-18160

Add note about the Calib->PhotoCalib replacement to v17 Release Notes

    Details

      Description

      Sometime in the next month, I will be replacing Calib with PhotoCalib (DM-10153). We need a note in the Release Notes for v17 to prepare people (the transition is not fully backwards compatible).

        Attachments

          Issue Links

            Activity

            Hide
            swinbank John Swinbank added a comment -

            Please aim to get this done as soon as you can — Gabriele is just about ready to push the button on v17, and we shouldn't do anything to delay the release.

            Show
            swinbank John Swinbank added a comment - Please aim to get this done as soon as you can — Gabriele is just about ready to push the button on v17, and we shouldn't do anything to delay the release.
            Hide
            Parejkoj John Parejko added a comment -

            I don't know what to say for for it, exactly. Old release notes don't really have a "beware future deprecations" section. Something like:

            ## Final version to support `lsst.afw.image.Calib`
             
            17.0 is the final major release of the stack to support the `lsst.afw.image.Calib` photometric calibration object. Beginning with 18.0, `Calib` will be replaced with `PhotoCalib`. Some deprecated interfaces have been implemented for backwards compatibility, but given the fundamental difference in behaviour, full interface compatibility is not possible. `PhotoCalib` will be able to read files persisted with `Calib` objects, so file backwards compatibility will be maintained. See (RFC-289)[https://jira.lsstcorp.org/browse/RFC-289],  (RFC-573)[https://jira.lsstcorp.org/browse/RFC-573], and Epic (DM-10153)[https://jira.lsstcorp.org/browse/DM-10153], for more details. We will write a Community post summarizing the changes when the transition occurs.
            

            Show
            Parejkoj John Parejko added a comment - I don't know what to say for for it, exactly. Old release notes don't really have a "beware future deprecations" section. Something like: ## Final version to support `lsst.afw.image.Calib`   17.0 is the final major release of the stack to support the `lsst.afw.image.Calib` photometric calibration object. Beginning with 18.0, `Calib` will be replaced with `PhotoCalib`. Some deprecated interfaces have been implemented for backwards compatibility, but given the fundamental difference in behaviour, full interface compatibility is not possible. `PhotoCalib` will be able to read files persisted with `Calib` objects, so file backwards compatibility will be maintained. See (RFC-289)[https://jira.lsstcorp.org/browse/RFC-289], (RFC-573)[https://jira.lsstcorp.org/browse/RFC-573], and Epic (DM-10153)[https://jira.lsstcorp.org/browse/DM-10153], for more details. We will write a Community post summarizing the changes when the transition occurs.
            Hide
            swinbank John Swinbank added a comment -

            Modified version of that text, together with some text describing BG2 deprecation, at: https://github.com/lsst/pipelines_lsst_io/pull/123

            Waiting for Jenkins to see what it looks like (if it works...): https://ci.lsst.codes/blue/organizations/jenkins/sqre%2Finfra%2Fdocumenteer/detail/documenteer/384/pipeline

            Show
            swinbank John Swinbank added a comment - Modified version of that text, together with some text describing BG2 deprecation, at: https://github.com/lsst/pipelines_lsst_io/pull/123 Waiting for Jenkins to see what it looks like (if it works...): https://ci.lsst.codes/blue/organizations/jenkins/sqre%2Finfra%2Fdocumenteer/detail/documenteer/384/pipeline
            Hide
            swinbank John Swinbank added a comment -

            Simon, would you mind taking a quick look at this? PR here: https://github.com/lsst/pipelines_lsst_io/pull/123

            I think this includes text for DM-18111.

            I'm about to drop off the network for a week or three, so I'm happy for Gabriele Comoretto or whoever to merge this when Simon is happy.

            Show
            swinbank John Swinbank added a comment - Simon, would you mind taking a quick look at this? PR here: https://github.com/lsst/pipelines_lsst_io/pull/123 I think this includes text for DM-18111 . I'm about to drop off the network for a week or three, so I'm happy for Gabriele Comoretto or whoever to merge this when Simon is happy.
            Hide
            swinbank John Swinbank added a comment -

            (Should add: the text for DM-18111 was “borrowed” from Yusra AlSayyad on #dm-middleware; errors are misconceptions are mine, not hers)

            Show
            swinbank John Swinbank added a comment - (Should add: the text for DM-18111 was “borrowed” from Yusra AlSayyad on #dm-middleware; errors are misconceptions are mine, not hers)
            Hide
            krughoff Simon Krughoff added a comment -

            So sorry. I approved the PR on Friday, but neglected to mark reviewed. I'm very happy.

            Show
            krughoff Simon Krughoff added a comment - So sorry. I approved the PR on Friday, but neglected to mark reviewed. I'm very happy.

              People

              • Assignee:
                swinbank John Swinbank
                Reporter:
                Parejkoj John Parejko
                Reviewers:
                Simon Krughoff
                Watchers:
                Gabriele Comoretto, John Parejko, John Swinbank, Kian-Tat Lim, Simon Krughoff
              • Votes:
                0 Vote for this issue
                Watchers:
                5 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Summary Panel