Uploaded image for project: 'Request For Comments'
  1. Request For Comments
  2. RFC-305

Define lsst_apps, lsst_obs, lsst_distrib in pipelines.lsst.io

    Details

    • Type: RFC
    • Status: Withdrawn
    • Resolution: Done
    • Component/s: DM
    • Labels:
      None

      Description

      We do not currently have a definition of the lsst_apps, lsst_obs, and lsst_distrib meta-packages in our documentation. It seems to me that these meta-packages are for the convenience of organizing the Stack code and might change from release to release, so they should be defined in pipelines.lsst.io. (A possible alternative might be to define them by fiat in LDM-148, but I think that is less desirable.) I propose to do so at the beginning of https://pipelines.lsst.io/install/index.html.

      Pointers to the definitions should be placed in the DM Developer Guide developer.lsst.io, including Adding a Package, the lsstsw documentation, and even the Python Style Guide.

      Proposed definitions:

      • lsst_apps contains the Science Pipelines algorithmic code that we expect to use in production and its dependencies, including any packages needed to test and verify the others, such as a minimal set of obs_* observatory/camera definition packages.
      • lsst_obs contains all supported obs_* packages.
      • lsst_distrib contains additional LSST-supported software related to the Alert, Calibration Products, and Data Release Productions, including the following not in lsst_apps or lsst_obs:
        • Optional algorithmic code and plugins not expected to be used in production or testing
        • Production control software and configurations for organizing large-scale computations
        • Interfaces to other operational services

        Attachments

          Issue Links

            Activity

            ktl Kian-Tat Lim created issue -
            ktl Kian-Tat Lim made changes -
            Field Original Value New Value
            Description We do not currently have a definition of the {{lsst_apps}}, {{lsst_obs}}, and {{lsst_distrib}} meta-packages in our documentation. It seems to me that these meta-packages are for the convenience of organizing the Stack code and might change from release to release, so they should be defined in {{pipelines.lsst.io}}. (A possible alternative might be to define them by fiat in LDM-148, but I think that is less desirable.) I propose to do so at the beginning of https://pipelines.lsst.io/install/index.html.

            Pointers to the definitions should be placed in the DM Developer Guide {{developer.lsst.io}}, including [Adding a Package|https://developer.lsst.io/build-ci/new_package.html], [the lsstsw documentation|https://developer.lsst.io/build-ci/lsstsw.html], and even the [Python Style Guide|https://developer.lsst.io/coding/python_style_guide.html#dm-python-library-code-with-an-external-user-base-must-support-python-2-7-and-3-x].

            Proposed definitions:
            * {{lsst_apps}} contains the Science Pipelines algorithmic code that we expect to use in production, including any packages needed to test and verify the others, such as a minimal set of {{obs_*}} observatory/camera definition packages.
            * {{lsst_obs}} contains all supported {{obs_*}} packages.
            * {{lsst_distrib}} contains all LSST-supported software, including the following not in {{lsst_apps}} or {{lsst_obs}}:
            ** Optional algorithmic code and plugins not expected to be used in production or testing
            ** Production control software and configurations for organizing large-scale computations
            ** Interfaces to other operational services
            We do not currently have a definition of the {{lsst_apps}}, {{lsst_obs}}, and {{lsst_distrib}} meta-packages in our documentation. It seems to me that these meta-packages are for the convenience of organizing the Stack code and might change from release to release, so they should be defined in {{pipelines.lsst.io}}. (A possible alternative might be to define them by fiat in LDM-148, but I think that is less desirable.) I propose to do so at the beginning of https://pipelines.lsst.io/install/index.html.

            Pointers to the definitions should be placed in the DM Developer Guide {{developer.lsst.io}}, including [Adding a Package|https://developer.lsst.io/build-ci/new_package.html], [the lsstsw documentation|https://developer.lsst.io/build-ci/lsstsw.html], and even the [Python Style Guide|https://developer.lsst.io/coding/python_style_guide.html#dm-python-library-code-with-an-external-user-base-must-support-python-2-7-and-3-x].

            Proposed definitions:
            * {{lsst_apps}} contains the Science Pipelines algorithmic code that we expect to use in production and its dependencies, including any packages needed to test and verify the others, such as a minimal set of {{obs_*}} observatory/camera definition packages.
            * {{lsst_obs}} contains all supported {{obs_*}} packages.
            * {{lsst_distrib}} contains additional LSST-supported software related to the Alert, Calibration Products, and Data Release Productions, including the following not in {{lsst_apps}} or {{lsst_obs}}:
            ** Optional algorithmic code and plugins not expected to be used in production or testing
            ** Production control software and configurations for organizing large-scale computations
            ** Interfaces to other operational services
            tjenness Tim Jenness made changes -
            Link This issue relates to RFC-251 [ RFC-251 ]
            tjenness Tim Jenness made changes -
            Remote Link This issue links to "Page (Confluence)" [ 14969 ]
            lpetrick Libby Petrick [X] (Inactive) made changes -
            Remote Link This issue links to "Page (Confluence)" [ 14980 ]
            tjenness Tim Jenness made changes -
            Remote Link This issue links to "Page (Confluence)" [ 14980 ]
            tjenness Tim Jenness made changes -
            Remote Link This issue links to "Page (Confluence)" [ 15008 ]
            tjenness Tim Jenness made changes -
            Planned End 25/Mar/17 12:00 AM 01/Jun/17 12:00 AM
            tjenness Tim Jenness made changes -
            Remote Link This issue links to "Page (Confluence)" [ 15029 ]
            lpetrick Libby Petrick [X] (Inactive) made changes -
            Remote Link This issue links to "Page (Confluence)" [ 15071 ]
            tjenness Tim Jenness made changes -
            Remote Link This issue links to "Page (Confluence)" [ 15071 ]
            swinbank John Swinbank made changes -
            Planned End 01/Jun/17 12:00 AM 01/Jul/17 12:00 AM
            swinbank John Swinbank made changes -
            Link This issue blocks DM-6551 [ DM-6551 ]
            swinbank John Swinbank made changes -
            Planned End 01/Jul/17 12:00 AM 15/Jul/17 12:00 AM
            tjenness Tim Jenness made changes -
            Link This issue relates to RFC-351 [ RFC-351 ]
            tjenness Tim Jenness made changes -
            Planned End 15/Jul/17 12:00 AM 22/Aug/17 12:00 AM
            tjenness Tim Jenness made changes -
            Remote Link This issue links to "Page (Confluence)" [ 15305 ]
            womullan Wil O'Mullane made changes -
            Remote Link This issue links to "Page (Confluence)" [ 15319 ]
            tjenness Tim Jenness made changes -
            Remote Link This issue links to "Page (Confluence)" [ 15319 ]
            tjenness Tim Jenness made changes -
            Planned End 22/Aug/17 12:00 AM 31/Aug/17 12:00 AM
            jbosch Jim Bosch made changes -
            Link This issue blocks RFC-351 [ RFC-351 ]
            frossie Frossie Economou made changes -
            Attachment rfc.png [ 29993 ]
            ktl Kian-Tat Lim made changes -
            Resolution Done [ 10000 ]
            Status Proposed [ 10805 ] Withdrawn [ 10605 ]
            tjenness Tim Jenness made changes -
            Watchers Colin Slater, Frossie Economou, Jim Bosch, John Parejko, John Swinbank, Jonathan Sick, Kian-Tat Lim, Simon Krughoff, Tim Jenness, Wil O'Mullane [ Colin Slater, Frossie Economou, Jim Bosch, John Parejko, John Swinbank, Jonathan Sick, Kian-Tat Lim, Simon Krughoff, Tim Jenness, Wil O'Mullane ] Colin Slater, Frossie Economou, Gabriele Comoretto, Jim Bosch, John Parejko, John Swinbank, Jonathan Sick, Kian-Tat Lim, Simon Krughoff, Tim Jenness, Wil O'Mullane [ Colin Slater, Frossie Economou, Gabriele Comoretto, Jim Bosch, John Parejko, John Swinbank, Jonathan Sick, Kian-Tat Lim, Simon Krughoff, Tim Jenness, Wil O'Mullane ]

              People

              • Assignee:
                ktl Kian-Tat Lim
                Reporter:
                ktl Kian-Tat Lim
                Watchers:
                Colin Slater, Frossie Economou, Gabriele Comoretto, Jim Bosch, John Parejko, John Swinbank, Jonathan Sick, Kian-Tat Lim, Simon Krughoff, Tim Jenness, Wil O'Mullane
              • Votes:
                0 Vote for this issue
                Watchers:
                11 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:
                  Planned End:

                  Summary Panel