Skip to content

CAIMAN Documentation

Calibration Implementation Manager (CAIMAN) Documentation

  • Choose a link on the left, such as the User Guide.
  • Below is a quick reference guide.

Quick Reference

Use CLAS12 module environment files (only necessary if you don't already do this in your shell startup files):

module use /scigroup/cvmfs/hallb/clas12/sw/modulefiles

Load the module on ifarm:

module load caiman

Run caiman, then within VIT:

Keys Action
<down> / <up> move down / up; alternatively, press j / k
<enter> view details of a task; press <enter> again to return
/ search for a task; press n or N to jump to the next or previous match, respectively
b then y mark a task as 'started' or not 'started'
d then y mark a task as 'done' (do NOT press capital D, which deletes a task, and may cause issues)
m then status:pending then <enter> mark a 'done' task as not 'done'
A add an annotation (do not confuse this with lowercase a, which adds a new task)
E remove an annotation
e edit a task in a text editor
u undo the previous action (avoid doing this)
q quit
<ctrl+l> redraw, which is useful if you resize your window
:help<enter> view all keybindings
  • Press the keys in order; note that they are case sensitive
  • A key surrounded by angle brackets ('<...>') is a non-character key, e.g., '<up>' is the up arrow
  • Many key presses such as b or d will ask for yes or no confirmation at the bottom of the screen: press y or n
  • Pressing colon (':') opens a command line at the bottom

Warning

Please avoid leaving VIT open for long periods of time: open it, make your changes, then quit.

  • Only one user at a time can run caiman, to prevent two users from making conflicting changes at the same time.
  • Use the dashboard website if you want to be able to see tasks for longer periods of time.