= Happy Function Generator =


== Software management ==
Happy Function Generator is managed by {{{supervisord}}} on {{{k1script}}}.
Basically, applications managed by {{{supervisor}}} are automatically launched when {{{k1script}}} boots up
and they are automatically re-launched when they hang up.

  * If you update {{{happy function generator}}} code, please restart the process by following command.
  {{{
  k1script> sudo supervisorctl restart als_freqmon_xpll # <- freqmonitor_XPLL.py
  k1script> sudo supervisorctl restart als_pcas_xpll    # <- pcas_xpll.py
  k1script> sudo supervisorctl restart als_freqmon_ypll # <- freqmonitor_YPLL.py
  k1script> sudo supervisorctl restart als_pcas_ypll    # <- pcas_ypll.py
  }}}

  * Configuration file for supervisord (Maybe it is not needed to touch for many people.)
  {{{
  k1script> cat /etc/supervisor/conf.d/k1als.conf
  [program:als_freqmon_xpll]
  user=controls
  directory=/home/controls
  command=bash -c 'source /kagra/apps/etc/client-user-env.sh && \
    python /opt/rtcds/userapps/release/cds/common/scripts/epics-motor- control/keysight/freqmonitor_XPLL.py'
  autorestart=true
  autostart=true
  stopasgroup=true
  redirect_stderr=true
  stdout_logfile=/tmp/als_freqmon_xpll.log

  [program:als_freqmon_ypll]
  user=controls
  directory=/home/controls
  command=bash -c 'source /kagra/apps/etc/client-user-env.sh && \
    python /opt/rtcds/userapps/release/cds/common/scripts/epics-motor-control/keysight/freqmonitor_YPLL.py'
  autorestart=true
  autostart=true
  stopasgroup=true
  redirect_stderr=true
  stdout_logfile=/tmp/als_freqmon_ypll.log

  [program:als_pcas_xpll]
  user=controls
  directory=/home/controls
  command=bash -c 'source /kagra/apps/etc/client-user-env.sh && \
     python /opt/rtcds/userapps/release/cds/common/scripts/epics-motor-control/keysight/pcas_xpll.py'
  autorestart=true
  autostart=true
  stopasgroup=true
  redirect_stderr=true
  stdout_logfile=/tmp/als_pcas_xpll.log

  [program:als_pcas_ypll]
  user=controls
  directory=/home/controls
  command=bash -c 'source /kagra/apps/etc/client-user-env.sh && \
     python /opt/rtcds/userapps/release/cds/common/scripts/epics-motor-control/keysight/pcas_ypll.py'
  autorestart=true
  autostart=true
  stopasgroup=true
  redirect_stderr=true
  stdout_logfile=/tmp/als_pcas_ypll.log
  }}}

  * Management commands
  {{{
  k1script> sudo supervisorctl start foo_bar_baz   # <- Start model plotter
  k1script> sudo supervisorctl stop foo_bar_baz    # <- Stop model plotter
  k1script> sudo supervisorctl restart foo_bar_baz # <- Restart model plotter
  k1script> sudo supervisorctl status foo_bar_baz  # <- Check run status
  k1script> sudo supervisorctl tail foo_bar_baz    # <- Check error log
  }}}