5.1. Initialisation file

Any calculation with USINE starts by loading an ASCII USINE-formatted initialisation file. The file usage is flexible enough so that you should not need to recompile the code or go into it. The price to pay is a complicated syntax for the parameter values, which are described in Parameter value syntax (init. file). The present section focusses on the structure and goal of the initialisation file.

5.1.1. What for?

Quantities initialised:
 List of CRs to propagate and their parents (and associated charts); energy ranges for the various species (nuclei, anti-nuclei, leptons); cross sections and CR data to use; propagation (ISM, source, transport) and solar modulation models…
When/how should I modify these files?:
 If you want to change some inputs files (XS, CR data), model parameter values (e.g., diffusion coefficient, ISM density…), etc., you only need to edit parameter values in the file: many examples are provided in Tutorial: ./bin/usine.
What about fit parameters?:
 The parameters to fit, their range, and whether to use them as free or nuisance parameters is also completely handled by the same ASCII file (specific parameters, see below). See Fit parameters and minimizer.

5.1.2. File (and line) format

Initialisation files consist of USINE-formatted lines: group @ subgroup @ parameter @ M=0,1 @ value

- group: pre-defined keyword, see Group/subgroup keywords
- subgroup: pre-defined keyword, see Group/subgroup keywords
- parameter: pre-defined keyword, see Parameter value syntax (init. file)
- M=0,1: boolean, with M=1 for true, M=0 for false
- value: editable value of the parameter, see Parameter value syntax (init. file)
 With this syntax, a parameter belongs to a subgroup, which itself belongs to a group. This allows to easily associate a parameter to a given physics ingredient. The list of keywords is of course a matter of the developer’s taste, and for the user’s point of view, it is what it is!
Multiple-entry parameter (M=0 or 1):
 Most of the time, parameters are single-valued ones (M=0). However, for instance for CR data and XS files (but not only), it proves useful to enable multiple-entries (e.g., to load several files): in that case, the files are read sequentially, and the last read values always overrides previously read values (if applies). In practice, the user can add as many lines as parameter values for this parameter, see examples in Edit E-grid, CR lists….
Value:Controlling all the model parameters in a single ASCII file has a price; the syntax of the parameter value is quite specific and is often parameter-dependent. The flexibility it enables for the description of transport, sources, etc. is detailed in Parameter value syntax (init. file) along with the appropriate syntax.

A typical initialisation file is init.TEST.par, partly reproduced below (a line starting with # is a comment):

Base  @ CRData      @ fCRData           @ M=1 @ $USINE/inputs/crdata_dummy.dat
Base  @ CRData      @ NormList          @ M=0 @ H,He:PAMELA|20.|kEkn;C,N,O,F,Ne,Na,Mg,Al,Si,P,S,Cl,Ar,K,Ca,Sc,Ti,V,Cr,Mn,Fe,Ni:HEAO|10.6|kEkn
Base  @ EnergyGrid  @ NBins             @ M=0 @ 33
Base  @ EnergyGrid  @ NUC_EknRange      @ M=0 @ [5.e-2,5.e3]
Base  @ EnergyGrid  @ ANTINUC_EknRange  @ M=0 @ [5e-2,1.e2]
Base  @ EnergyGrid  @ LEPTONS_EkRange   @ M=0 @ [5e-2,1.e4]
Base  @ ListOfCRs   @ fAtomicProperties @ M=0 @ $USINE/inputs/atomic_properties.dat
Base  @ ListOfCRs   @ fChartsForCRs     @ M=0 @ $USINE/inputs/crcharts_Zmax30_ghost97.dat
Base  @ ListOfCRs   @ IsLoadGhosts      @ M=0 @ false
###Base @ ListOfCRs   @ ListOfCRs         @ M=0 @ [1H,58Fe]
Base  @ ListOfCRs   @ ListOfCRs         @ M=0 @ [2H-BAR,30Si]
Base  @ ListOfCRs   @ ListOfParents     @ M=0 @ 2H-bar:1H-bar,1H,4He;1H-bar:1H,4He
Base  @ ListOfCRs   @ PureSecondaries   @ M=0 @ Li,Be,B
Base  @ ListOfCRs   @ SSRelativeAbund   @ M=0 @ $USINE/inputs/solarsystem_abundances2003.dat
Base  @ MediumCompo @ Targets           @ M=0 @ H,He
Base  @ XSections   @ Tertiaries        @ M=0 @ 1H-bar,2H-bar
Base  @ XSections   @ fProd             @ M=1 @ $USINE/inputs/XS_NUCLEI/sigProdGALPROP17_OPT12.dat
Base  @ XSections   @ fProd             @ M=1 @ $USINE/inputs/XS_ANTINUC/dSdEProd_pbar_1H4He+HHe_Donato01.dat
Base  @ XSections   @ fProd             @ M=1 @ $USINE/inputs/XS_ANTINUC/dSdEProd_dbar_1H4He+HHe_Duperray05_Coal79MeV.dat