Update example file

lattice/example/soleil/example.ae

@@ -11,7 +11,7 @@ dipole	rms   500.0e-6	500.0e-6	0.2e-03
 
 
 
-#girder	sys   100.0e-6	100.0e-6	0.5e-03
-#quad	sys    30.0e-6	 30.0e-6       80.0e-06
-#sext	sys    30.0e-6	 30.0e-6      100.0e-06
-#dipole	sys   500.0e-6	500.0e-6	0.2e-03
+girder	sys   100.0e-6	100.0e-6	0.5e-03
+quad	sys    30.0e-6	 30.0e-6       80.0e-06
+sext	sys    30.0e-6	 30.0e-6      100.0e-06
+dipole	sys   500.0e-6	500.0e-6	0.2e-03

lattice/example/soleil/example_input.prm

@@ -5,25 +5,22 @@
 # input script to set the file and bool flag
 #
 #  comments:
-# 1) Blank line and line starting with "#" (comment) are ignored
-# 2) Mandatory parameter: lat_file,
-#     lat file name is without the extension of .lat
-# 3) All the other parameters are optional, and all the default 
-#      values for flags are false
+# 1) The rules to define commands are described in the tracy mannual.
 #
-#  Test verison for the development of Tracy 3, always the nearest
+# 2) Test verison for the development of Tracy 3, always the nearest
 #        input file verison.
 #
-#                     09/2011    Jianfeng Zhang 
+#                     12/2011    Jianfeng Zhang 
 #
 #******************************************************************
 
-#*************************
-#  mandatory setting
-**************************
+#================================================
+# mandatory parts
+#================================================
+
 # relative directory of the files in the script
- in_dir ./
-#in_dir  /home/zhang/codes/TracyIII/lattice/example/
+# in_dir /home/zhang/codes/TracyIII/lattice/   
+in_dir ./
 
 # lattice file must be wihout .lat extension
   lat_file   example_lattice  
@@ -41,14 +38,15 @@
 # skew quadrupole
   qt            QT
 
-
-#*******************************
-#  option setting 
-#*******************************
+#======================================
 # GLOBAL PARAMETER PART
+#======================================
+
 # Activate quadrupole Fringefield
  QuadFringeOnFlag 
 
+# Deactivate quadrupole Fringefield
+  QuadFringeOffFlag
 
 # VACCUUM CHAMBER PART
 # read vacuum chamber from chamber_file
@@ -56,155 +54,145 @@
 
 # set RF voltage, if false, then use the definition value
 # of RF cavity in the lattice
-# name, flag, RF voltage [V]
   RFvoltageFlag   3000000
 
-  
-#####################
-# Read the field error, and replacement the corresponding components
-# of the element.
-#  Generic features
-####################
+#======================================
+#specific for SOLEIL lattice
+#======================================
 
-ReadfefileFlag   example_dip.fe
+# read the multipole field error, and add 
+# the corresponding components of the element
+ # multipole_file multipole_error_fullquad.dat
+# files for looking for the multipole field errors of 
+# correctors and skew quadrupoles, which are integrated in the sextupoles
+ # fic_hcorr corh.txt
+ # fic_vcorr corv.txt
+ # fic_skew  corqt.txt
 
+ # ReadMultipoleFlag  
 
 
+# file of source of coupling; only works for SOLEIL lattice
+  #virtualskewquad_file   virtual_skew_quad_currents.txt 
 
+#### Virtual Skew quadrupole FACTORY
+# read the virtual setting of skew quadrupoles from a file
+  #ReadVirtualSkewquadFlag 
 
-# fit tunes
-  FitTuneFlag     q7   q9  18.202 10.317
-# fit chromaticities
-  FitChromFlag   sx9 sx10  2.0    2.0
+# add random rotation error to the two half quadrupoles
+# to introduce coupling into the lattice
+  #ErrorCoupling2Flag   0  0.0007
 
-# NOT finished
-#PrintGirderFlag testgirder.out
+# fit tune for the lattice with each quadrupole is cut into two pieces
+# name, flag, tuned quadrople,tuned quadrople,targetnudx    targetnudz
+  #FitTune4Flag     qp7a qp7b  qp9a qp9b  18.202 10.317
 
-######################
-# alignment error file, after read the misalignment, the orbit is corrected
-#####################
+#=================================================
+## general command (NOT machine dependent)
+#=================================================  
+
+# Read the multipole field errors, and replacement the corresponding components
+# of the element.
+  
+  ReadfefileFlag   example_dip.fe
+
+# read the misalignment error from a file 
   ReadaefileFlag    example.ae
+
 #####################
-#  orbit correction, if ReadaefieldFlag is on, then must set the parameters to do orbit correction
-#####################
+#  orbit correction
+  CODCorrectFlag
+
+#parameters used to do orbit correction
 # file to specify which correctors are used for H orbit correction  
   hcorr_file  example_hcorr_56nom.state
 # file to specify which correctors are used for V orbit correction  
   vcorr_file  example_vcorr_56nom.state
 
- #number of statistics (seeds) --> N flat-files
-   n_stat        2    
- #number of times to scale the errors
-  n_scale       1     
- #number of iterations for orbit correction, if 0, no orbit correction 
-  n_orbit       0     
+#number of iterations for orbit correction, should NOT small than 1
+n_orbit       5     
 #number of singular values in H-plane, must be not larger than the number of correctors used for orbit correction
 nwh           60    
 #number of singular values in V-plane, must be not larger  than the number of correctors used for orbit correction
 nwv           60    
 
 
-
-#######################################
 #  print the twiss paramters to a file
-#######################################
   PrintTwissFlag     twisstest.out
 
-########################
 # print close orbit to a file
-##########################
-  PrintCODFlag codtest.out
+  PrintCODFlag testcod.out
 
-#print  coordinates tracking around COD at each element
-PrintTrackFlag  tracktest.out  0.001 0.000  0.0  0.0  0.0  0.0   50
+#print  coordinates tracking around COD at each element to a file 
+ PrintTrackFlag  tracktest.out  0.001 0.000  0.0  0.0  0.0  0.0   50
 
 
 # tune obtained by tracking
   TuneTracFlag   
+
 # chromaticity obtained by tracking
   ChromTracFlag   
 
-###
-### FITTING FACTORY
-###
-# fit tune
-# name, flag, tuned quadrople,tuned quadrople,targetnudx    targetnudz
+# fit tune for the lattice with full quadrupoles
   FitTuneFlag     q7 q9   18.202 10.317
 
 # fit chromaticity
-# name,flag, tuned sextupole, tuned sextupole, targetksix    targetksiz
   FitChromFlag   sx9 sx10  2.0    2.6
 
+# tune shift with amplitude 
+  AmplitudeTuneShiftFlag nudxtest.out nudztest.out   50 30 516 0.035 0.02 0.0
+
+# tune shift with energy
+  EnergyTuneShiftFlag nudptest.out  31 1026 0.06 
 
-# TUNESHIFT WITH AMPLITUDE
-# tune shift with amplitude and energy
-#    AmplitudeTuneShiftFlag flag Nbx Nby TurnNumber xmax(m) ymax(m) delta
-#    Nbx and Nby Number of amplitude values in H et V planes
-#    TurnNumber number of turns for tracking  
-#    xmax ymax maximum amplitude value (sqrt law)
-#    delta energy offset
- AmplitudeTuneShiftFlag nudxtest.out nudztest.out   50 30 516 0.035 0.02 0.0
-
-# EnergyTuneShiftFlag  Nb TurnNumber emax
-#    Nb point number
-#    TurnNumber number of turn for tracking  
-#    emax maximum energy for tracking
- EnergyTuneShiftFlag nudptest.out  31 1026 0.06 
-
-
-# FMA calculate frequency map 
-#    Nbx Nby number of point in h and v planes
-#    TurnNumber Number of turns for tracking
-#    xmax, ymax maximum amplitude
-#    energyoffset 
-#    diffusionflag to compute tunediffusion 
+# frequency map analysis for on momentum particle
  FmapFlag  fmaptest.out 31 21 516 0.025 0.005 0.0 true
 
-#  FMA dp calculate frequency map
-#     Nbx:  number of point in h planes
-#     Nbe: number of point for the energy
-#     TurnNumber: Number of turns for tracking
-#     xmax: maximum amplitude in the horizontal plane
-#     emax: maximum  energyoffset
-#        y: vertical amplitude 
-#     diffusionflag to compute tunediffusion 
+# frequency map analysis for off momentum particle
  FmapdpFlag  fmapdptest.out 101 121 1026 25e-3 0.06 0.3e-3 true
 
-# Error coupling
+
 # add random rotation error to the full quadrupole
-#     random seed number, RMS value of the rotation angle 
-#    of the quadrupole
+# to introduce coupling into the lattice
   ErrorCouplingFlag   0  0.0007
-# coupling flag
-#    calcualte the coupling factor in the lattice 
+
+# calcualte the coupling factor in the lattice 
   CouplingFlag  
 
-# calculate momentum acceptance for Touscheck lifetime
-#   Dim  istart istop eminp emaxp nstepp eminn emaxn nstepn nturns zinitial
-#   Dim: 4D/6D tracking, default value is 6D
-  MomentumAccFlag momacctest.out  6D 1 189 0.01 0.05 100 -0.01 -0.05 100 1026 0.0002
+# calculate momentum acceptance 
+  MomentumAccFlag momacctest.out  6D 1 189 0.01 0.05 100 -0.01 -0.05 100 1026  0.0002
 
 # calculate phase space
-# parameters are:  
-# 4D/6D dimension to track the phase space; 
-# x[m],x',y[m],y',delta,c*tau, Number of turns, flag to turn on/off
-# damping during the tracking
   PhaseSpaceFlag phasetest.out 6D 1e-6 0.0 1e-6 0.0 0.012 0.0 1000 false
 
 
+#===============================================
+### OTHER (for debug ......)
+#===============================================
+# calculate induced amplitude
+#  InducedAmplitudeFlag  
+
+# specific for test
+ # CodeComparaisonFlag  
+
+# calculate Eta function
+ # EtaFlag  
+
 
+#================================================
+#        TO BE UPDATED
+#===============================================
 
-###
 ### Touschek lifetime
-###
 # calculate Touschek lifetime
-# name, flag
-  #TouschekFlag Qb eps[X_] eps[Y_] n_turns sigma_delta sigma_s
-
+#  TouschekFlag 
 # Intra Beam Scattering
-  #IBSFlag  
+#  IBSFlag  
 # Track momentum acceptance and then get Touschek lifetime
-  #TousTrackFlag 
+#  TousTrackFlag 
+
+# print girder
+#PrintGirderFlag testgirder.out