Requirements for Experiment Control

Command Line Interface

Experiment control is responsible for a command line interface that must do the following:

  • Start and stop each of the following 'continuous' sub-systems:
    • PnF;
    • SPADE;
    • SN DAQ;
    • Detector Status;
    • Cluster Status.
  • Start data-taking run such that it does the following:
    • Start DAQ with a specified run number and DAQ configuration key;
    • Start TWR with a specified run number;
    • Load a database, that is shared with PnF, with a partial run summary, where the partial run summary contains:
      • Run Number;
      • Subrun Number;
      • DAQ configuration key;
      • DAQ Mode;
      • JeB configuration key;
      • PnF configuration key;
      • Run Start Time;
      • An optional start-run comment supplied by the operator.
  • Stop data-taking such that it does the following:
    • Stop DAQ;
    • Stop TWR.
    • Update the database, that is shared with PnF, with a completed run summary, where the completed run summary contains:
      • Run Number;
      • Subrun Number;
      • DAQ configuration key;
      • DAQ Mode;
      • JeB configuration key;
      • PnF configuration key;
      • Run Start Time;
      • Run Stop Time;
      • Number of physics events taken;
      • Number of monitor events taken;
      • Number of supernova events taken;
      • Number of TCal events taken.
      • An optional stop-run comment supplied by the operator.
  • Commence continuous data-taking such that new runs will be started whenever an error condition in DAQ or TWR is detector, or after a specified interval of time.
  • Terminate continuous data-taking.
  • Commence flasher runs that are extensions of a normal data taking run modified to supply the following information to the DAQ at prescibed intervals:
    • Flasher configuration;
    • Subrun Number

    And, at the same time a new run summary is loaded into the appropriate database, and flasher configuration is loaded into a database, share with ???.

    Note:
    The contents of the flasher configuration has yet to be determined.
  • Check the state of each of the following sub-systems:
    • DAQ;
    • TWR;
    • PnF;
    • SPADE;
    • SN DAQ;
    • Detector Status;
    • Cluster Status.

    Success is defined as the sub-system being in its expected state or experiment control currently ignoring it. The expected state for each sub-system is determined by the most recent sequence of start, stop and ignore instructions issued by experiment control.

  • Signal experiment control whether the check of a sub-system will be made against its expected state, or whether the check will alway succeed, i.e. the actual state of the sub-system is ignored.
  • Display a summary of information for each sub-system (as enumerated above). (The contents of each sub-systems summary is defined elsewhere.)
  • Support multiple instances of the command line process executing at the same time.

Control

  • Experiment control is responsible for monitoring each sub-system (as enumerated above) to check they are in their expected states, and if not, inform an email list that an error condition exists:
  • When in continuous data-taking mode, if either the DAQ or TWR sub-systems are not in their expected modes, experiment control is responsible for stopping data-taking and restarting it.

Data Management

  • Experiment control is responsible for maintaining and incrementing the Run Number.
  • Experiment control is responsible for maintaining a set containing each sub-system's (as enumerated above) expected state.
  • Experiment control is responsible for the schema, creation and updating of the contents of the database, shared with PnF, the contains all run summary records created by Experiment Control.
    Note:
    Experiment control is not responsible for the maintenance of this database.
  • Experiment control is responsible for the schema, creation and updating of the contents of the database, shared with ??, that contains all flasher configuration records created by Experiment Control.
    Note:
    Experiment control is not responsible for the maintenance of this database.

Web Status Pages

Experiment control is responsible for providing the following web pages at http://icecube.wisc.edu/Status

  • A 'summary' page at least once every 15 minutes that includes the following:
    • The state of each subsystem (as enumerated above).
    • The following information from DAQ:
      • Run Number;
      • Run Start Time;
      • Run Stop Time, if no run is in progress;
      • Number of physics events taken;
      • Number of monitor events taken;
      • Number of supernova events taken;
      • Number of TCal events taken.
    • The following information from PnF:
      • Maximum disk usage;
      • Current disk usage.
      • Current run being consumed by JEB;
      • Current event being consumed by JEB;
      • Number of clients attached to PnF;
      • Number of buffers in use;
      • Number of events in the PnF/JeB system.
    • The following information from SPADE:
      • Maximum daily TDRSS usage;
      • Current daily TDRSS usage.
    • The following for Monitoring:
      • The pending runs for the physics stream;
      • Maximum disk usage for the physics stream;
      • Current disk usage for the physics stream;
      • The pending runs for the monitor stream;
      • Maximum disk usage for the monitor stream;
      • Current disk usage for the monitor stream.
    • The following from Cluster Status:
      • To be determined.
  • A 'daily' page that summarizes the sub-system's statuses since the beginning of the previous day.
  • A 'monthly' page that summarizes the sub-system's statuses since the beginning of the previous month.
  • A 'annual' page that summarizes the sub-system's statuses for each month.

Configuration Keys

Note:
Experiment Control is not responsible for the definition of what each configuration key that is used by DAQ, TWR and PnF key means. Experiment control will be provided with a list of valid keys along with an optional list of descriptions for each keys.