= KleineWelle =
== Installation ==
  * KleineWelle is contained in the {{{gds-minitor}}} packages which is available from LIGO's apt/yum repositories.
  {{{
debian> apt-get install gds-monitors
RHEL> yum install gds-monitors
  }}}
  * T. Yamamoto installed KleineWelle all client workstations (k1ctr*) and k1sum*.

== How to use ==
  * Technical Document of KleineWelle is [1].
  * KleineWelle is available as a {{{kleineWelleM}}} command.
  {{{
> kleineWelleM  parameter_file  -inlist  file_list
  }}}
  * The format of {{{parameter_file}}} is as follows (T. Yamamoto cannot find the sample of the format).
  {{{
stride 16
basename K-KW_TRIGGERS
transientDuration 4.0
significance 2.0
threshold 3.0
decimateFactor -1
channel K1:FOO-BAR_BAZ
channel K1:BAR-BAZ_FOO
  }}}
  * The format of {{{file_list}}} is a simple list of the file path (not a LIGO cache file format).
  {{{
/path/to/K-K1_C-1000000000-32.gwf
/path/to/K-K1_C-1000000032-32.gwf
/path/to/K-K1_C-1000000064-32.gwf
...
  }}}

== Trigger generation for DailySummary ==
 * DailySummaryPage uses the trigger files using {{{gwtrigfind}}} for constructing the KleineWelle summary page.
 * T. Yamamoto modified {{{gwtrigfind}}} because our computer environment is slightly different from LIGO's one.
   * According to the {{{gwtrigfind}}} code, trigger files should be generated in the {{{/gds-k1/dmt/triggers}}}
   * T. Yamamoto change to {{{/home/controls/triggers}}} (same as Omicron output directory).
 {{{
--- /home/controls/opt/summary-2.7/lib/python2.7/site-packages/gwtrigfind/core.py.bak   2018-10-19 09:12:45.375654000 +0900
+++ /home/controls/opt/summary-2.7/lib/python2.7/site-packages/gwtrigfind/core.py       2019-01-23 18:29:06.224172322 +0900
@@ -223,8 +223,8 @@ def find_kleinewelle_files(channel, star
     else:
         tag = '%s-KW_TRIGGERS' % site
     if base is None:
-        base = os.path.join(os.sep, 'gds-{}'.format(ifo.lower()),
-                            'dmt', 'triggers', tag, '{}-{{0}}'.format(tag))
+        base = os.path.join(os.path.sep, 'home',
+                            'controls', 'triggers', tag, '{}-{{0}}'.format(tag))

     # loop over GPS directories and find files
     filename = '%s-*-*.%s' % (tag, ext)
 }}}

 * The KleineWelle job is automated using {{{crontab}}} on {{{k1sum1}}}.
 {{{
> crontab -l | grep KleineWelle
10-59/15 * * * * /users/DET/tools/KleineWelle/Script/automation.sh /users/DET/tools/KleineWelle/Parameter/summary_test.txt > /tmp/auto-kleinewelle.log 2>&1
 }}}

 * When you want to add some channels for the KleineWelle search,
   1) add channel name to {{{DATA CHANNELS}}} line of {{{/users/DET/tools/KleineWelle/Parameter/summary_test.txt}}}<<BR>>
   or 2) add new job to crontab
   {{{
> crontab -e
10-59/15 * * * * /users/DET/tools/KleineWelle/Script/automation.sh /users/DET/tools/KleineWelle/Parameter/summary_test.txt > /tmp/auto-kleinewelle.log 2>&1
10-59/15 * * * * /users/DET/tools/KleineWelle/Script/automation.sh /path/to/your_parameter.txt > /tmp/auto-kleinewelle2.log 2>&1
   }}}
   * In order to use trigger results on SummaryPage, use {{{K-KW_TRIGGERS}}} for the {{{basename}}} parameter.

== Reference ==
  * [1] [[https://dcc.ligo.org/T060221/public|LIGO-T060221]], KleienWelle Technical Document
  * [2] [[https://dcc.ligo.org/cgi-bin/private/DocDB/ShowDocument?.submit=Identifier&docid=T1300468&version=|LIGO-T1300468]], DetChar Trigger Handling Conventions