Skip to content

Commit

Permalink
document --mcformat option
Browse files Browse the repository at this point in the history
  • Loading branch information
JostMigenda committed Nov 19, 2020
1 parent 51a89cf commit f83c41f
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,4 +62,4 @@ For details, see the files in `interaction_channels/`.


## Output
A .kin file in the NUANCE format used by the /mygen/vecfile options in WCSim. See [the format documentation](http://neutrino.phy.duke.edu/nuance-format/) for details.
A text file in the NUANCE format (used by the `/mygen/vecfile` options in WCSim) or the RATPAC format. See the documentation for details.
8 changes: 5 additions & 3 deletions doc/documentation.tex
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,11 @@ \subsection{Quick Start Guide}
\begin{description}
\item[\texttt{--format <value>}] Format of input file(s). See section~\ref{sec:input-formats}.
\item[\texttt{--output <value>}] Name of the output file.
\item[\texttt{--ordering <value>}] Neutrino mass ordering. See section~\ref{sec:mass-ordering}.
\item[\texttt{--channel <value>}] Interaction channel to generate events for. See section~\ref{sec:interaction-channels}.
\item[\texttt{--mcformat <value>}] Format of output file. Can be \texttt{NUANCE} or \texttt{RATPAC}.\footnote{For a description of these formats see \url{http://neutrino.phy.duke.edu/nuance-format/} and \url{https://rat.readthedocs.io/en/latest/generators.html\#external}.}

\item[\texttt{--detector <value>}] Detector configuration. See section~\ref{sec:detector-configurations}.
\item[\texttt{--channel <value>}] Interaction channel to generate events for. See section~\ref{sec:interaction-channels}.
\item[\texttt{--ordering <value>}] Neutrino mass ordering. See section~\ref{sec:mass-ordering}.
\item[\texttt{--distance <value>}] Distance to supernova (in kpc).
\item[\texttt{--starttime <value>} and \texttt{--endtime <value>}] Generate events in a certain time range (in milliseconds). If these aren’t specified, events are generated for the full time range for which fluxes are given in the input file.
\item[\texttt{--randomseed <value>}] Set an integer as a seed for the random number generator, to generate events reproducibly.\footnote{Note: Python 2.7 will not give identical results to Python 3.x for the oxygen-16 CC channels.}
Expand Down Expand Up @@ -119,7 +121,7 @@ \section{More Details}
Interaction channel plug-ins specify properties of the interaction channel, like the neutrino species that undergo this interaction, and provide functions to calculate quantities like the differential cross section $\tdiffx{\sigma (E_\nu, E_e)}{E_e}$ or the kinematically allowed energy range.
This modular design makes sntools easily extensible, with roughly 100 lines of code required to add a new input format or interaction channel.

Finally, \texttt{genevts.py} collects the events generated in all interaction channels and writes them to a text file in the NUANCE format\footnote{See \url{http://neutrino.phy.duke.edu/nuance-format/} for a description of this format.}, which can be used as an input file for a full detector simulation.
Finally, \texttt{genevts.py} collects the events generated in all interaction channels and writes them to an output file, which can be used as input for a full detector simulation.

The rest of this chapter describes the various components of the code and the physics behind them in more detail.

Expand Down

0 comments on commit f83c41f

Please sign in to comment.