Index of /~ib38/bbu/versions

[ICO]NameLast modifiedSizeDescription
[PARENTDIR]Parent Directory  -  
[ ]v0.8.tar.gz2014-03-16 20:12 17K 
#2014/03/15
README file for BI, v0.8
BI - code to simulate transverse beam breakup

1. INSTALLATION
2. USAGE
3. HELP
4. UNITS
5. NOTATIONS
   5.1 PARAMETER FILE
   5.2 LATTICE FILE
   5.3 HOM DATA FILE
6. CITATION/ACKNOWLEDGEMENT
7. BUGS


1. INSTALLATION
Download the source from http://www.lns.cornell.edu/~ib38/bbu/src/
The current version is v0.8.tar.gz
Extract: gunzip -c v0.8.tar.gz | tar xv
Make:    make


2. USAGE
Usage: bi [OPTIONS]...
Options must be of the following form: -parameter_name=value.
Physical values are in SI units and energy is in MeV.
 
If the same options are supplied in both the file and through
the command line, the latter overrides.
The list of accepted parameters:
  -param=FILENAME                file containing current, t_on, etc.
  -lattice=FILENAME              file containing layout and matrices
  -homdata=FILENAME              file containing HOM data
 
The following can also be supplied in parameter_file:
  -search=YES|NO|FILENAME        seek instability threshold
  -checktrack=YES|NO|FILENAME    writes coordinates at the locations
                                   of the cavities to the file
  -verbose=YES|NO                suppresses messages when negative
  -homsbefore=YES|NO             HOMs follow the cavity if negative
  -injection_energy=VALUE        initial kinetic energy
  -current=VALUE                 beam current
  -bunch_frequency=VALUE         bunch repetition rate
  -t_on=VALUE                    total time the beam stays on
  -t_print=VALUE                 generate output with this interval
                                   between the bunches
  -output_volt=FIRST|LAST|NAME   location for HOM voltage output
                                   where the name is cavity name
                                   from lattice_file; first|last
                                   means first or last cavity
  -output_coor=FIRST|LAST|NAME   location for coordinates output
Note: setting t_on and t_print to 0 instructs the code to assign
t_on = max(Q/f/pi) and t_print = 1E-4*t_on.


3. HELP
Type: bi --help


4. UNITS
All parameters are in SI and kinetic energy is in MeVs. Transfer matrices
are the same as 6x6 MAD matrix notation. HOM polarization angle is in
degrees.


5. NOTATIONS
Three parameter files are used by BI
5.1 Parameter file. Default file name is 'param.txt' if no -param=FILENAME
      command line argument is supplied.
    File format should be: PARAMETER = VALUE
    The following parameter names are accepted:
      search=YES|NO|FILENAME        seek instability threshold
      checktrack=YES|NO|FILENAME    writes coordinates at the locations
                                       of the cavities to the file
      verbose=YES|NO                suppresses messages when negative
      homsbefore=YES|NO             HOMs follow the cavity if negative
      injection_energy=VALUE        initial kinetic energy
      current=VALUE                 beam current
      bunch_frequency=VALUE         bunch repetition rate
      t_on=VALUE                    total time the beam stays on
      t_print=VALUE                 generate output with this interval
                                       between the bunches
      output_volt=FIRST|LAST|NAME   location for HOM voltage output
                                       where the name is cavity name
                                       from lattice_file; first|last
                                       means first or last cavity
      output_coor=FIRST|LAST|NAME   location for coordinates output
    Note: setting t_on and t_print to 0 instructs the code to assign
    t_on = max(Q/f/pi) and t_print = 1E-4*t_on.

5.2 Lattice file. Default name is 'lattice.txt' if no -lattice=FILENAME
      command line argument is supplied (or corresponding entry in the
      parameter file is not found). This file contains layout of 
      the problem with 6x6 transfer matrices.
    File format should be:
    ELEM_1           : dZ, R11 .. R16 R21 .. R26 .. .. R61 .. R66
    ...
    ELEM_k -> ELEM_m : dZ, R11 .. R16 R21 .. R26 .. .. R61 .. R66
    
    Element name is before colon (:), followed by the element length and
      36 matrix elements (6x6). Colon is required, otherwise format is
      free.
    Cavities *with* HOMs are recognized as lines that look like
      NAME1 -> NAME2 : ...
      Example. 2 pass linac with 2 cavities: CAV1, CAV2
	         INJECTION	: ...
		 CAV1_1 -> CAV1 : ...
		 DRIFT          : ...
		 CAV2_1 -> CAV2 : ...
		 ARC		: ...
		 CAV1_2 -> CAV1 : ...
		 DRIFT		: ...
		 CAV2_2 -> CAV2 : ...
		 DUMP		: ...
    Filenames used for voltage or coordinate output consist of
      cavity name with '.volt' or '.coor' extension. E.g. if output
      is requested at 'CAV1_1' location, the voltage output will be
      written to 'CAV1_1.volt', and the coordinate output will be
      written to 'CAV1_1.coor'.

5.3 HOM data file. Default name is 'homdata.txt' if no -homdata=FILENAME
      command line argument is supplied (or corresponding entry in
      parameter file is not found). This file contains HOM parameters.
    File format is:
      CAVITYNAME : R/Q Q f polarization
      CAVITYNAME is a name that corresponds to 'NAME1 -> NAME2' from
      the lattice file. Either NAME1 or NAME2 can be used. Data entries
      that follow the required colon (:) are R/Q [Ohm], Q, f[Hz], and
      polarization [deg]. 0 deg corresponds to horizontally polarized mode
      and 90 deg correspond to vertically polarized mode. R/Q is in LINAC
      definition (2x CIRCUIT).


6. CITATION
When using the code please cite
I.V. Bazarov, "bi - Beam Instability BBU Code",
http://www.lepp.cornell.edu/~ib38/bbucode/src


7. BUGS
Report bugs to <ib38@cornell.edu>