# 27-Mar-2014
# Set of script files to do wire calibration of Unser and 
# do logging data from BCMs, Faraday Cap, ... in Hall A
# Scripts location: hacuser@hlal01:~/bin
# Created: March, 2014 R.P.(romanip@jlab.org)
----------------------------------
BCM_logger 

Does logging data from epics variables (BCM, Unser, Faraday Cap, IBC0L02, ...) to file and store it
in directory ~BCMLOG/. 
Name of data file is: bcm_log_<date>-<time>.log
     	     	      date: MM-DD-YYYY (month-day-year)
		      time: HH-MM-SS   (hours-minutes-seconds)
Format of data file:
       # Date Time
       # epics_var1 epics_var2 epics_var3 ...
       time1 epics_var1 epics_var2 epics_var3 ...
       time2 epics_var1 epics_var2 epics_var3 ...
        ...  ...        ...        ...        ...
       timeN epics_var1 epics_var2 epics_var3 ...

Usage: 
BCM_logger <rate_sec> <file_with_epics_variables>
	   <rate_sec>                  - readout rate in seconds (default is 1);
	   <file_with_epics_variables> - name of file with list of epics variables.
	   If file not supplied, then internal definition of epics variables from PV_LIST is used.
	   Format of file with list of epics variables:
	   epics_var1
	   epics_var2
	    .....

----------------------------------
set_K224

Set current in current source K224 (Unser wire) and hold it for some time, 
then set zero current and hold it same time.

Usage:
set_K224 <current_uA> <time_on_sec> <cycles>
	 <current_uA>  - current to set in Unser wire in uA (Maximum is 1000 uA)
	 <time_on_sec> - time to hold set current in seconds and then to hold 'zero' current same time
	 <cycles>      - number of cycles (1-10)


-----------------------------------
set_rng_K224

Set current in current source K224 (Unser wire) in range from minimum value to maximum value 
with current step and hold every set during some time.

Usage:
set_K224 <min_rng_uA> <max_rng_uA> <step_uA> <time_on_sec>
	 <min_rng_uA>  - low current range in uA  (maximum -1000 uA)
	 <max_rng_uA>  - high current range in uA (maximum +1000 uA)
	 <step_uA>     - current step in uA       (1-100 uA)
	 <time_on_sec> - time to hold in seconds  (1-100 sec)


-------------------------------------
unser_cal.sh

Starts BCM_logger in background then starts script that is supplied in command line.
When script is finished, it kills BCM_logger also.

Usage:
unser_cal.sh '<script_with_arg>'
 	     <script_with_arg> - one of scripts with arguments: 'set_K224 <current_uA> <time_on_sec> <cycles>' 
	     		         or 'set_rng_K224 <min_rng_uA> <max_rng_uA> <step_uA> <time_on_sec>'

------------------------------------

TODO
Script/program to calculate an avarage value for every epics variables for every current set from data file.
Then calculate gains and offsets.