Skip to content

Consolidate script and tools #528

@alessandrothea

Description

@alessandrothea

The set of utility scripts to manage conffwk databases has grown organically to the point where it's not trivial to remember what is what. A renaming/documenation/consolidation campaign is advisable in preparation for v5.2.

Possible guidelines

  • Tools performing pure OKS operations (i.e. no assumptions on what schema a database uses) should use the oks_ prefix
  • DUNE-DAQ tools, i.e. confmodel/appmodel aware, directly using files or classes of the two models, should use the daqconf_ prefix
  • Merging scripts that operate in the same context should be considered.

Inventory

Python scripts

  • oks_enable: manages the confmodel::Session disable list. Not a OKS specific tool

    • remove oks_, add daqconf_,
    • maybe merge with other scripts
  • consolidate, consolidate_files, copy_configuration: copy or merge all or a selection OKS data files in a single file. This is a oks-specific operation performed w/o any knowledge of the schema

    • Prefix with oks_, add _db postfix to consolidate.
    • Confirm consolidate (See below)
    • Maybe merge in one tool.
    • Maybe move to oks repo, realistically not possible since it relied on conffwk::Configuration to operate on the database.
  • oks-format: Loads and force a re-write of selected files, enforcing the OKS xml format AND pruning obsoleta data members (and classes maybe), effectively consolidating the structure of the files.

    • Rename to represent the real task performed by this tool
    • Maybe merge with other oks tools
  • get_apps:

    • Merge with inspector?
  • oks_enable_tpg: Enables TPG processin in appmodel::ReadoutApplications in a confmodel::Session. This is not an oks tool.

    • Remove oks, add daq_conf>
    • Maybe mere with other tools
  • validate: Verifies session consistency.

    • Rename verify_session, prefix daqconf_
    • Maybe merge with inspector
  • createOKSdb: generates an 'empty' DUNEDAQconfmodel database. This is not an OKS tool.

    • Rename to daqconf_create_db
    • Maybe merge with other db management tools
  • dromap2oks. Obsolete?

  • generate_readoutOKS. Obsolete? Do we still use readout maps?

    • if not, merge with other tools

Apps scripts

  • create-config-plots:
    • Add daqconf_ prerfix?

Sub-issues

Metadata

Metadata

Labels

good first issueGood for newcomersmiscellaneous deliverableA change that is/will be part of a release but is not substantial enough to be a daq-deliverable

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions