Changes between Version 79 and Version 80 of HowToAddSample

Timestamp:

Jan 9, 2017, 3:40:09 PM (7 years ago)

Author:

Clarence Wret

Comment:

--

HowToAddSample

@@ -75 +75 @@
 Out of these, string comparisons are only made on `DataType` and `DimensionVar`. The other identifiers exist to adhere to some standard and keep sample naming tidy and consistent.
 
-
+{{{
+#!div class="important"
 '''What to do:'''
 
@@ -81 +82 @@
 
 This is a sufficient name: there is no ambiguity what the class describes and there is no way of confusing it with other classes in NUISANCE.
-
+}}}
 
 == Placing the sample in a directory ==
@@ -91 +92 @@
 The new files themselves for the new samples should be identical (or very similar) to the sample name to avoid confusion.
 
-
+{{{
+#!div class="important"
 '''What to do:'''
 
 Make the new files '''`src/T2K/T2K_CC1pip_H2O_XSec_1Dpmu_nu.cxx`''' and '''`src/T2K/T2K_CC1pip_H2O_1Dpmu_nu.h`'''. These are the implementation and header files for the new measurement and similar goes for the `1DEnuMB` implementation.
-
+}}}
 
 == Placing the data in a directory ==
@@ -107 +109 @@
 In some cases we might have the same topology defining the cross-section but for a different interaction target. In this case we add another sub-directory for the target, e.g. `data/T2K/CC1pip/H2O` for us.
 
-
+{{{
+#!div class="important"
 '''What to do:'''
 
 Put the ROOT file from the [http://t2k-experiment.org/results/nd280data-numu-cc1pi-xs-on-h2o-2015/ data release] into the `data/T2K/CC1pip/H2O` directory.
-
-
-{{{
-#!html
-<hr width="100%" size="10">
-}}}
+}}}
+
+----
 = Coding up a sample =
 
@@ -135 +135 @@
 If you're implementing multiple distributions for the same measurement (e.g. dσ/dp,,µ,, and dσ/dcosθ,,µ,,) we recommend adding the signal definition to the namespace rather than directly in the `isSignal(FitEvent *event)` function in the class implementation. We'll talk about implementing a signal definition [#point_signaldef later].
 
-
+{{{
+#!div class="important"
 '''What to do:'''
 Our header file now looks like:
@@ -164 +165 @@
 
 Note the simple structure for the sample: we really only need to set up three functions. The inheritance from `Measurement1D` and helper function within it does most of the heavy lifting.
-
+}}}
 
 [=#point_const]
@@ -275 +276 @@
 }}}
 
+{{{
+#!div class="important"
 '''What to do:'''
 The data and covariance matrix are available in a ROOT file for the sample, so I used `Measurement1D::SetDataFromFile` to set up the data and `Measurement1D::SetCovarFromDataFile` to set up the covariances.
@@ -316 +319 @@
 };
 }}}
-
+}}}
 
 [=#point_variable]
@@ -518 +521 @@
 You simply need to add the implementation files to the `set(IMPLFILES` list and the header files to the `set(HEADERFILES`.
 
+{{{
+#!div class="important"
 '''What to do:'''
  * Add `T2K_CC1pip_H2O_XSec_1Dpmu_nu.cxx` and `T2K_CC1pip_H2O_XSec_1DEnuMB_nu.cxx` to `set(IMPLFILES`
 
  * Add `T2K_CC1pip_H2O_XSec_1Dpmu_nu.h` and `T2K_CC1pip_H2O_XSec_1DEnuMB_nu.h` to `set(HEADERFILES`
-
+}}}
 
 = Make NUISANCE aware of the sample =
@@ -530 +535 @@
 As mentioned earlier, NUISANCE loads samples through `src/FCN/SampleList.cxx` and specifically `bool SampleUtils::LoadSample`. We need to add our new sample to this long `if else` statement, making sure we string compare to the name set [#point_naming previously].
 
+{{{
+#!div class="important"
 '''What to do:'''
 
@@ -557 +564 @@
 }}}
 
+}}}
+
 = Recompiling NUISANCE with the new sample =
 
-Since we've added files to the `CMakeList.txt` we need to reprocess the makefiles produced by CMake. This is done by:
+Since we've added files to the `CMakeList.txt` we need to reprocess the makefiles produced by CMake.
+
+{{{
+#!div class="important"
+'''What to do:'''
 
 {{{
@@ -578 +591 @@
 
 If all is well we exit without any errors and we can proceed to making predictions for our new sample in NUISANCE.
+}}}
 
 = Running NUISANCE with the new sample =
+We can now write a cardfile and run any of the NUISANCE application with the sample!
+
+{{{
+#!div class="important"
+If you haven't got any generated MC, now's the time to generate them! Alternatively, check [https://nuisance.hepforge.org/mcfilehosting.html our generated MC] for T2K ND280 flux with H,,2,,O target; it should be available for most generators!
+
+Once you have your sample make a NUISANCE input card file, e.g.
+{{{
+$vim my_T2KH2O_card.card
+}}}
+and specify the sample in the card file as
+{{{
+sample T2K_CC1pip_H2O_XSec_1Dpmu_nu GENERATOR:PATH_TO_GENERATOR_OUTPUT_FILE
+}}}
+where you replace `GENERATOR` with whatever generator you ran with, all in caps (e.g. `GENIE`, `NEUT`, `NUWRO`, `GIBUU` or `NUANCE`).
+
+Then finally run any of the NUISANCE executables, specifying the input card file and output root file e.g.
+
+{{{
+$ ./nuiscomp -c my_T2KH2O_card.card -o testing_my_T2KH2O_impl.root
+}}}
+
+'''Hot tip:''' If you're testing/debugging an implementation you might not want to run over several million events. You can change the number of loaded events by appending `-q input.maxevents=50000` to run with 50000 events instead.
+
+}}}
 
 [=#point_fullimp]