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

standardize _filter.py and other gen3 obs file names

    XMLWordPrintable

    Details

    • Story Points:
      1
    • Urgent?:
      No

      Description

      In DM-20994, we never quite settled on advocating specific names for the location of an instrument's FilterDefintionCollection. After some discussion, we decided it was better to make this for internal use only, and point users to the `instrument.filterDefintions` if they need to access it. This entails renaming e.g. hscFilters.py to _filters.py (or possibly _filterDefinitions.py to make it even more explicit?) and changing the filenames in creating-an-obs-package.rst to reflect this.

      The obs package guide already advocates for _instrument.py as the filename that implements the Instrument class, and I think our existing gen3 obs packages follow that approach. I don't know if there are any other files that we should explicitly standardize in this manner.

      I don't know if we should document in the guide above or somewhere else, how to access the gen3 Instrument in a generic manner, for code that e.g. may want access to the FilterDefinitions.

        Attachments

          Issue Links

            Activity

            There are no comments yet on this issue.

              People

              Assignee:
              Unassigned Unassigned
              Reporter:
              Parejkoj John Parejko
              Watchers:
              John Parejko, Tim Jenness
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated:

                  CI Builds

                  No builds found.