Changes between Version 10 and Version 11 of CardFileExamples

Timestamp:

Jun 13, 2017, 1:18:36 PM (7 years ago)

Author:

Patrick Stowell

Comment:

--

CardFileExamples

@@ -103 +103 @@
 }}}
 
+
+
+=== Fixed Parameter Structure ===
+Fixed parameters can be specified by using any of the 'parameter' type structures. You must specify the type of parameter first, before listing the name, starting value, and state. These structures are read by '''nuiscomp''', '''nuismin''', and '''nuissyst'''
+{{{
+<parameter type="TYPE_parameter"  name="NAME"   nominal="VALUE"  state="STATE" />
+}}}
+
+- **TYPE** : Type of RW parameter, (e.g. genie_parameter, neut_parameter, norm_parameter)
+- **NAME** : Name of RW parameter, can be any string given in the RW engine. In GENIE this list is given in $GENIE/src/ReWeight/GSyst.h. 
+
+For normalisation parameters the name of the dial corresponds to SAMPLENAME_norm. (e.g. 'MiniBooNE_CCQELike_XSec_1DQ2_nu_norm')
+
+- **VALUE** : Starting value for the dial. In general for RW engine parameters this is given in terms of 1-sigma variations away from the nominal, so that VALUE=0.0 is the nominal generator value. For everything else, like normalisation parameters, this value is in units of the true value.
+
+- **STATE** : State of the dial. This should always be left as FIX as this is the only support option for the time being.
+
+
+Multiple parameter structures can be listed in the nuisance card file to make comparisons with many model parameters changed at once.
+
+
+{{{
+#!div class="important" 
+NOTE: Running with RW parameters changed in Generators requires that specific Generator to be built and have NUISANCE built against it. E.g. to using GENIE RW, you need to have a working install of GENIE+GENIE-RW and NUISANCE built against that version.
+}}}
+
+
+**Example 1** : Fixed GENIE RW 'MaCCQE' to +1 sigma
+{{{
+<parameter type="genie_parameter" name="MaCCQE"  nominal="+1.0"  state="FIX" />
+}}}
+
+**Example 2** : Fixed NuWro RW 'kNuwro_Ma_CCQE' to -1 sigma
+{{{
+<parameter type="nuwro_parameter" name="kNuwro_Ma_CCQE"  nominal="-1.0"  state="FIX"/>
+}}}
+
+**Example 3** : Shift both 'MaCCQE' and 'MaCCRES' in NEUT by 1 sigma
+{{{
+<parameter type="neut_parameter" name="MaCCQE"  nominal="-1.0"  state="FIX" />
+<parameter type="neut_parameter" name="MaCCRES" nominal="+1.0"  state="FIX" />
+}}}
+
+**Example 4** : Change MiniBooNE sample normalisation (alternative to using sample NORMVALUE option)
+{{{
+<parameter type="norm_parameter" name="MiniBooNE_CCQE_XSec_1DQ2_nu_norm"  nominal="0.9"  state="FIX" />
+<sample name="MiniBooNE_CCQE_XSec_1DQ2_nu"  input="NEUT:/path/to/neutinput.root" />
+}}}
+
+
+
+=== Free Parameter Structure ===
+Free parameters can be specified by using any of the 'parameter' type structures. You must specify the type of parameter first, before listing the name, starting value, lower and upper limits, step size and state. This is an extension of the fixed parameter case to include extra information needed by routines that vary parameters.
+These structures are read by '''nuismin''', and '''nuissyst'''. It is possible to use these structures also in nuiscomp, but the dial limits and step sizes will be ignored, fixing the parameter at the chosen value instead.
+{{{
+<parameter type="TYPE_parameter"  name="NAME"  nominal="VALUE"  low="LOW"  high="HIGH" step="STEP" state="STATE" /> 
+}}}
+
+
+- **TYPE** : Type of RW parameter, (e.g. genie_parameter, neut_parameter, norm_parameter)
+- **NAME** : Name of RW parameter, can be any string given in the RW engine. In GENIE this list is given in $GENIE/src/ReWeight/GSyst.h. 
+
+For normalisation parameters the name of the dial corresponds to SAMPLENAME_norm. (e.g. 'MiniBooNE_CCQELike_XSec_1DQ2_nu_norm')
+
+- **VALUE** : Starting value for the dial. In general for RW engine parameters this is given in terms of 1-sigma variations away from the nominal, so that VALUE=0.0 is the nominal generator value. For everything else, like normalisation parameters, this value is in units of the true value.
+
+- **LOW**  : Lower limit of the dial in the same units as **VALUE**
+- **HIGH** : Upper limit of the dial in the same units as **VALUE**
+- **STEP** : Starting step size of the dial in the same units as **VALUE**. This is the stepsize passed to the minimizer, as well as the step size used in various functions that randomly scan the parameter space. 
+
+- **STATE** : State of the dial. This can be left as FREE or FIX. If FREE this tells NUISANCE that we will allow the dial to be varied. If FIX then NUISANCE will make sure it is left at  **VALUE** for the entire time. FIX is a useful option if you decide you would like to stop a single parameter being floated but would like to keep its limit definitions in case you would like to vary it at a later point.
+
+
+Multiple parameter structures can be listed in the nuisance card file to make comparisons with many model parameters changed at once.
+
+
+{{{
+#!div class="important" 
+NOTE: Running with RW parameters changed in Generators requires that specific Generator to be built and have NUISANCE built against it. E.g. to using GENIE RW, you need to have a working install of GENIE+GENIE-RW and NUISANCE built against that version.
+}}}
+
+
+**Example 1** : Free GENIE RW 'MaCCQE' to starting at 0.0 and between -1.0 and 1.0 sigma
+{{{
+<parameter type="genie_parameter" name="MaCCQE"  nominal="0.0"  low="-1.0"  high="1.0"  step="0.5"  state="FREE" />
+}}}
+
+**Example 2** : Free NuWro RW 'kNuwro_Ma_CCQE' 
+{{{
+<parameter type="nuwro_parameter" name="kNuwro_Ma_CCQE" nominal="0.0" low="-1.0" high="1.0" step="0.5" state="FREE" />
+}}}
+
+**Example 3** : Shift both 'MaCCQE' and 'MaCCRES' in NEUT by 1 sigma. Vary MaCCQE.
+{{{
+<parameter type="neut_parameter" name="MaCCQE"  nominal="-1.0"  low="-3.0"  high="3.0"  step="1.0"  state="FREE" />
+<parameter type="neut_parameter" name="MaCCRES" nominal="+1.0"  state="FIX" />
+}}}
+
+**Example 4** : Shift both 'MaCCQE' and 'MaCCRES' in NEUT by 1 sigma. Vary MaCCQE.
+{{{
+<parameter type="neut_parameter" name="MaCCQE"  nominal="-1.0"  low="-3.0"  high="3.0"  step="1.0"  state="FREE" />
+<parameter type="neut_parameter" name="MaCCRES" nominal="+1.0"  low="-3.0"  high="3.0"  step="1.0"  state="FIX" />
+}}}
+
+**Example 5** : Shift both 'MaCCQE' and 'MaCCRES' in NEUT by 1 sigma. Vary both.
+{{{
+<parameter type="neut_parameter" name="MaCCQE"  nominal="-1.0"  low="-3.0"  high="3.0"  step="1.0"  state="FREE" />
+<parameter type="neut_parameter" name="MaCCRES" nominal="+1.0"  low="-3.0"  high="3.0"  step="1.0"  state="FREE" />
+}}}
+
+
+**Example 6** : Vary MiniBooNE sample normalisation between user chosen limits (alternative to using sample NORMVALUE option)
+{{{
+norm_parameter MiniBooNE_CCQE_XSec_1DQ2_nu_norm  0.9  0.8  1.1  0.05 FREE
+sample MiniBooNE_CCQE_XSec_1DQ2_nu  NEUT:/path/to/neutinput.root
+}}}
+
+**Example 7** : Example 5 with a shifted order
+{{{
+<parameter state="FREE" type="neut_parameter" name="MaCCQE"  nominal="-1.0"  low="-3.0"  high="3.0"  step="1.0"   />
+<parameter   nominal="+1.0"  low="-3.0" type="neut_parameter" high="3.0"  step="1.0"  state="FIX" name="MaCCRES" />
+}}}
+
+
+
 == Simple Card Structures ==
 
@@ -229 +354 @@
 - **STATE** : State of the dial. This can be left as FREE or FIX. If FREE this tells NUISANCE that we will allow the dial to be varied. If FIX then NUISANCE will make sure it is left at  **VALUE** for the entire time. FIX is a useful option if you decide you would like to stop a single parameter being floated but would like to keep its limit definitions in case you would like to vary it at a later point.
 
+
+Multiple parameter structures can be listed in the nuisance card file to make comparisons with many model parameters changed at once.
+
+
+{{{
+#!div class="important" 
+NOTE: Running with RW parameters changed in Generators requires that specific Generator to be built and have NUISANCE built against it. E.g. to using GENIE RW, you need to have a working install of GENIE+GENIE-RW and NUISANCE built against that version.
+}}}
+
+
 **Example 1** : Free GENIE RW 'MaCCQE' to starting at 0.0 and between -1.0 and 1.0 sigma
 {{{