Changes between Version 9 and Version 10 of CardFileExamples

Timestamp:

Jun 13, 2017, 1:09:55 PM (7 years ago)

Author:

Patrick Stowell

Comment:

--

CardFileExamples

@@ -19 +19 @@
 
 == XML Card Structures ==
+
+=== XML Structure ===
+When writing XML card files you also need to wrap eveything in a '<nuisance>' root element.
+{{{
+<nuisance>
+
+  ...
+
+</nuisance>
+}}}
+
+If you don't do this, the ROOT XML parser will fail and NUISANCE will think your card file is empty. For example **the following card file is valid**
+{{{
+<nuisance>
+ 
+  <parameter type="genie_parameter" name="MaCCQE" nominal="1.0" state="FIX" />
+  <sample name="MiniBooNE_CCQE_XSec_1DQ2_nu" input="GENIE:/path/to/neut/file.root" />
+
+</nuisance>
+}}}
+
+but **the following card file is NOT valid** as it is missing the root element
+{{{
+  <parameter type="genie_parameter" name="MaCCQE" nominal="1.0" state="FIX" />
+  <sample name="MiniBooNE_CCQE_XSec_1DQ2_nu" input="GENIE:/path/to/neut/file.root" />
+}}}
+
+
+=== Sample Structure === 
+Data comparison samples are specified by including the 'sample structure, listing the name of the sample and the input. These structures are read by '''nuiscomp''', '''nuismin''', and '''nuissyst'''
+{{{
+<sample  name="NAME"   input="TYPE:/path/to/FILE"   option="[OPTION]"  norm="[NORMVALUE]" />
+}}}
+- **NAME** : Name string of the sample of interest specified in src/FCN/SampleList.cxx. 
+- **TYPE** : Generator Input Type string telling NUISANCE what the file type is (e.g. GENIE)
+- **OPTION** : (Optional Argument) Specifying extra sample options that change the way the sample behaves at run time (e.g. SHAPE). If none given, this is left as DEFAULT.
+- **NORMVALUE** : (Optional Argument) Starting sample normalisation value used to shift total MC normalisation. If none given this is left at the value 1.0.
+
+In the XML format, if you don't want to provide optional arguments, these can just be left out completely from the xml entry.
+
+Multiple sample structures can be given in the NUISANCE card file to include many data comparisons at once.
+
+{{{
+#!div class="important" 
+NOTE: Reading in Generators requires that Generator to be built and have NUISANCE built against it. E.g. to read GENIE files, you need to have a working install of GENIE and NUISANCE built against that version.
+}}}
+
+
+**Example 1** : MiniBooNE CCQE comparison using a GENIE file
+{{{
+<sample  name="MiniBooNE_CCQE_XSec_1DQ2_nu"  input="GENIE:/path/to/my/geniefile.root" />  
+}}}
+
+**Example 2** : MiniBooNE CCQE comparison using a NuWro file
+{{{
+<sample  name="MiniBooNE_CCQE_XSec_1DQ2_nu"  input="NEUT:/path/to/my/nuwrofile.root" />  
+}}}
+
+**Example 3** : MiniBooNE CC1pi comparison using a NEUT file
+{{{
+<sample  name="MiniBooNE_CC1pi_XSec_1DTpi_nu"  input="NEUT:/path/to/my/neutfile.root" />  
+}}}
+
+**Example 4** : MiniBooNE CC1pi comparison using a GiBUU file and the SHAPE option
+{{{
+<sample  name="MiniBooNE_CC1pi_XSec_1DTpi_nu"  input="GiBUU:/path/to/my/gibuufile.root"  option="SHAPE" />
+}}}
+
+**Example 5** : MINERvA CCQE comparison using a NEUT file and shifting the MC normalisation by 1.0 / 0.9.
+{{{
+<sample  name="MINERvA_CCQE_XSec_1DQ2_nu"  input="NEUT:/path/to/my/neutfile.root"  option="DEFAULT"  norm="0.9" />
+}}}
+
+**Example 6** : MiniBooNE CCQE comparison using a NuWro, shifting the MC by 0.9 / 1.0 but also adding a normalisation penalty to the likelihood (option=NORM)
+{{{
+<sample  name="MiniBooNE_CCQE_XSec_1DQ2_nu"  input="NEUT:/path/to/my/neutfile.root"  option="NORM"  norm="0.9" />
+}}}
+
+**Example 7** : Include both MiniBooNE CCQE and CC1pip data
+{{{
+<sample  name="MiniBooNE_CC1pi_XSec_1DTpi_nu"  input="NEUT:/path/to/my/neutfile.root" />  
+<sample  name="MiniBooNE_CCQE_XSec_1DQ2_nu"    input="NEUT:/path/to/my/neutfile.root" /> 
+}}}
 
 == Simple Card Structures ==