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

Improve help for the --simulate command-line argument in ts_salobj

    XMLWordPrintable

    Details

    • Story Points:
      0
    • Epic Link:
    • Sprint:
      TSSW Sprint - Feb 15 - Mar 1
    • Team:
      Telescope and Site
    • Urgent?:
      No

      Description

      Some CSCs, such as ts_FiberSpectrograph, have multiple simulation modes. Provide a way to provide good help for those modes in the command line argument parser.

        Attachments

          Issue Links

          mitigates

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-28917 Allow configurable CSCs to store their config schema as code

          • Done
          relates to

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-28866 Add missing CSC version information to my CSCs

          • Done

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-28926 Update my configurable CSCs to store the schema as code

          • Done

            Activity

            Ascending order - Click to sort in descending order
            Hide
            Permalink
            rowen Russell Owen added a comment - - edited

            Changes:

            • BaseCsc: added simulation_help class variable. The default is None. If not None then use as help for the --simulate command-line argument (if one is added).
            • BaseCsc: improve handling of the simulation_mode constructor argument so that the simulation_mode attribute is available (properly set) when the constructor has run – though only if valid_simulation_modes is non-None, since otherwise there's no way to check the value that early.

            For an example using this new capability see ts_FiberSpectrograph:
            https://github.com/lsst-ts/ts_FiberSpectrograph/blob/develop/python/lsst/ts/FiberSpectrograph/csc.py

            I also implemented DM-28917: allow configurable CSCs to store their configuration in code.
            For an example of how that works out, see any of the DM-28926 pull requests.

            Pull request: https://github.com/lsst-ts/ts_salobj/pull/180

            Show
            rowen Russell Owen added a comment - - edited Changes: BaseCsc: added simulation_help class variable. The default is None. If not None then use as help for the --simulate command-line argument (if one is added). BaseCsc: improve handling of the simulation_mode constructor argument so that the simulation_mode attribute is available (properly set) when the constructor has run – though only if valid_simulation_modes is non-None, since otherwise there's no way to check the value that early. For an example using this new capability see ts_FiberSpectrograph: https://github.com/lsst-ts/ts_FiberSpectrograph/blob/develop/python/lsst/ts/FiberSpectrograph/csc.py I also implemented DM-28917 : allow configurable CSCs to store their configuration in code. For an example of how that works out, see any of the DM-28926 pull requests. Pull request: https://github.com/lsst-ts/ts_salobj/pull/180
            Hide
            Permalink
            wvreeven Wouter van Reeven added a comment -

            Looks good to me.

            Show
            wvreeven Wouter van Reeven added a comment - Looks good to me.
            Hide
            Permalink
            rowen Russell Owen added a comment - - edited

            Merged to develop and tagged as v6.3.0.beta.1.

            I also wrote a confluence page to help with upgrading CSCs that use ts_salobj.

            Show
            rowen Russell Owen added a comment - - edited Merged to develop and tagged as v6.3.0.beta.1. I also wrote a confluence page to help with upgrading CSCs that use ts_salobj.

              People

              Assignee:
              rowen Russell Owen
              Reporter:
              rowen Russell Owen
              Reviewers:
              Wouter van Reeven
              Watchers:
              Russell Owen, Wouter van Reeven
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.