Changes between Version 25 and Version 26 of HowToNeut

Timestamp:

Feb 27, 2017, 10:20:25 AM (7 years ago)

Author:

Clarence Wret

Comment:

--

HowToNeut

@@ -1 +1 @@
 = How to generate events with NEUT and feed them to NUISANCE =
 
-This page aims to outline how to use NEUT to create a sample of interactions on your favourite target. We'll also outline how to feed this generated sample through the NUISANCE framework and get good results.
+This page outlines how to use NEUT to create a sample of interactions on your favourite target. We also outline how to feed this generated sample through the NUISANCE framework and get good results.
 
 {{{
@@ -12 +12 @@
 }}}
 
+
 [[PageOutline(1-3,Wiki content,inline,numbered)]]
+
 
 [=#point_compile]
@@ -21 +23 @@
 The main neutrino-nucleus interaction generator lives in `$NEUT_ROOT/src/neutsmpl/neutroot2`, which is the compiled program with source `$NEUT_ROOT/src/neutsmpl/neutroot.F`. 
 
-NEUT has two dependencies: ROOT and CERNLIB. You need to have `$ROOTSYS`, `$CERN` and `$CERN_LEVEL` environment variables set-up to compile NEUT. These should all be specified by the user in `$NEUT_ROOT/src/neutsmpl/EnvMakeneutsmpl.csh`. 
-
-`$ROOTSYS` should be set to your ROOT installation (e.g. sourcing `YOUR_DIR/root/bin/thisroot.sh`). `$CERNLIB` is your CERNLIB installation folder. `$CERN_LEVEL` is the folder inside `$CERNLIB` which you've installed: in my case (2017) the folder is called `2005`, so I set `export CERN_LEVEL=2005`.
-
-Once the environment variables are set (or included in `EnvMakeneutsmpl.csh`, compilation is done by running `./Makeneutsmpl` in `$NEUT_ROOT/src/neutsmpl/`. This sources the above `EnvMakeneutsmpl.csh`, runs through a host of makefiles, sets up symlinks and builds the project.
-
-You can now run the main executable by:
-
-{{{
-./neutroot2 NEUT_CARD_FILE.card OUTPUT_ROOT_FILE.root
+=== Dependencies ===
+NEUT has two dependencies: `ROOT` and `CERNLIB`. 
+
+You need to have `$ROOTSYS`, `$CERN` and `$CERN_LEVEL` environment variables set-up to compile NEUT. These should all be specified by the user in `$NEUT_ROOT/src/neutsmpl/EnvMakeneutsmpl.csh`, or available to the system by
+
+{{{
+export ROOTSYS=/LOCATION/OF/ROOT
+export CERNLIB=/LOCATION/OF/CERNLIB
+export CERN_LEVEL=/CERNLIB/VERSION
+}}}
+
+
+`$ROOTSYS` should be set to your ROOT installation directory(e.g. sourcing `YOUR_DIR/root/bin/thisroot.sh`). 
+
+`$CERNLIB` is your CERNLIB installation folder. 
+
+`$CERN_LEVEL` is the folder inside `$CERNLIB` which you've installed: in my case (2017) the folder is called `2005`, so I set `export CERN_LEVEL=2005`.
+
+=== Compiling ===
+Once the environment variables are set, compilation is done by running 
+{{{
+$ ./Makeneutsmpl
+}}}
+
+in `$NEUT_ROOT/src/neutsmpl/`. This sources the above `EnvMakeneutsmpl.csh`, runs through a host of makefiles, sets up symlinks and builds the project.
+
+=== Running the executable ===
+You can now run the main executable (`neutroot2`) by:
+
+{{{
+$ ./neutroot2 NEUT_CARD_FILE.card OUTPUT_ROOT_FILE.root
 }}}
  
-where `NEUT_CARD_FILE.card` is a card file compliant with your chosen NEUT version, and `OUTPUT_ROOT_FILE.root` is the ROOT output file where the events are to be saved. This output file contains all the event information and is the input for NUISANCE analyses.
-
-Examples of NEUT card files can be found in the `$NEUT_ROOT/src/neutsmpl/Cards` directory, or have a look at what team NUISANCE used for 2016 analyses at 
+where `NEUT_CARD_FILE.card` is a card file compliant with your chosen NEUT version, and `OUTPUT_ROOT_FILE.root` is the ROOT output file where the events are to be saved. 
+
+This output file contains all the event information and is the input for NUISANCE analyses.
+
+=== Card-file examples ===
+Examples of NEUT card files can be found in the `$NEUT_ROOT/src/neutsmpl/Cards` directory.
+
+Alternatively, have a look at what team NUISANCE used for 2016 analyses at 
 [wiki:Winter2016] and at our [https://imperialcollegelondon.app.box.com/files/0/f/13226969736/neut_cards box].
 
@@ -41 +69 @@
 
 
-== Structure of card files: ==
-
-NEUT has a load of defaults set on run-time if the user does not supply them, which means you're running with "reference" NEUT.
+== Structure of card files ==
+
+NEUT has a load of defaults set on run-time if the user does not supply them, which means you're running with default NEUT.
 
 Selecting different models is done in the cardfile, and all the inputs that a user can specify is found in `src/neutcore/necard.F`.
 
-We can specify how many events we want, the input flux in TH1D format, the incoming neutrino type, the flux file, number of bound protons and neutrons and free protons, what interaction modes, and so on.
-
-Here's a list for generating all modes on T2K H2O. The "C" at the start of each line is just a comment and will not be parsed by NEUT.
+The user can specify how many events to generate, the input flux in a `TH1D`, the incoming neutrino type, the flux file, number of bound protons and neutrons and free protons, what interaction modes, and so on.
+
+Here's a list for generating all modes on T2K H,,2,,O. The "C" at the start of each line is just a comment and will not be parsed by NEUT.
 
 
@@ -88 +116 @@
 
 = Compiling NUISANCE against NEUT =
-Once you have a working NEUT installation and generated events, you can link NUISANCE against NEUT.
+Once you have a working NEUT installation and generated events (see [#point_compile above], you can link NUISANCE against NEUT.
 
 To run NUISANCE with NEUT you'll need to specify the `$NEUT_ROOT`, `$CERNLIB` and `$CERN_LEVEL` variables.