Project

General

Profile

Idea #22197

DAQInterface should have a "help" option

Added by John Freeman about 1 year ago. Updated 10 months ago.

Status:
Reviewed
Priority:
Normal
Assignee:
Category:
-
Target version:
-
Start date:
03/23/2019
Due date:
% Done:

100%

Estimated time:
Experiment:
-
Duration:

Description

While setting up the DAQInterface environment via DAQInterface's source_me file provides users with the link to the DAQInterface wiki manual as a means of providing them help, Ron pointed out that it would be useful if a sort of cheatsheet/quick reference was also made available to DAQInterface users in the terminal. It would be easier for DAQInterface users who've already read the manual and just need a quick refresher to be able to look at a brief reference describing the environment variables which control DAQInterface by executing "DAQInterface --help" instead of having to open the webpage and then rifle through all the documentation to find the desired information.

Associated revisions

Revision e89b9f6f (diff)
Added by John Freeman 10 months ago

JCF: corresponding to Issue #22197, print out a quick cheatsheet of the main environment variables which control DAQInterface behavior

History

#1 Updated by John Freeman 10 months ago

  • % Done changed from 0 to 100
  • Status changed from New to Resolved

Ready to be reviewed. At the head of feature/issue22197_daqinterface_cheatsheet, commit e89b9f6fd54fadf50f85573da2915ad6da38c9c0, if a user types "DAQInterface -h" or "DAQInterface --help", instead of launching DAQInterface - the behavior when no arguments are given - DAQInterface will print out the following cheatsheet, which describes what the most important environment variables to control DAQInterface are.

Before reading on, keep in mind *this is NOT a substitute for reading
the DAQInterface manual* :
https://cdcvs.fnal.gov/redmine/projects/artdaq-utilities/wiki/Artdaq-daqinterface

The following list covers the most important environment variables
used to control DAQInterface's behavior. Remember you need to set a
variable *before* launching DAQInterface; it won't pick up the change
on-the-fly. If you wish to set a variable, do so in
/home/jcfree/DAQInterface/user_sourcefile_example, NOT in the standard DAQInterface source
file /home/jcfree/artdaq-utilities-daqinterface/source_me

///////////////////////////////////////////////////////////////////////

DAQINTERFACE_KNOWN_BOARDREADERS_LIST: the name of the file containing
the list of possible boardreaders to select from for a run

DAQINTERFACE_LOGFILE: the name of the file which logs DAQInterface's
output to screen. Defaults to 
/tmp/daqinterface_${USER}/DAQInterface_partition${DAQINTERFACE_PARTITION_NUMBER}.log

DAQINTERFACE_PARTITION_NUMBER: The partition DAQInterface will run on. Defaults to 0.

DAQINTERFACE_PROCESS_MANAGEMENT_METHOD: The method DAQInterface uses
to control processes. Options are "pmt", "direct", and
"external_run_control". Defaults to "pmt".

DAQINTERFACE_PROCESS_REQUIREMENTS_LIST: The (optional) file users can
edit to control which processes are run-critical, assuming the process
management method is in "direct" mode

DAQINTERFACE_SETTINGS: The name of the file containing
unlikely-to-be-changed-often parameters controlling DAQInterface's
behavior (process timeouts, output directory for artdaq logfiles,
etc.)

//////////////////////////////////////////////////////////////////////

Keep in mind *this is NOT a substitute for reading the DAQInterface manual* :
https://cdcvs.fnal.gov/redmine/projects/artdaq-utilities/wiki/Artdaq-daqinterface

#2 Updated by John Freeman 10 months ago

Apologies - I left out a file from the previous commit. The new-head of feature/issue22197_daqinterface_cheatsheet, 442d4f0acb9b4db5ca9b252cad48b34806b27f4f, fixes this.

#3 Updated by Kurt Biery 10 months ago

  • Status changed from Resolved to Reviewed

I've confirmed that the help message listed in this Issue is printed out with the '--help' option when running on the 22197 branch.



Also available in: Atom PDF