|
|
[Rivet-svn] r3953 - trunk/doc
blackhole at projects.hepforge.org
blackhole at projects.hepforge.org
Thu Oct 4 17:03:04 BST 2012
Author: fsiegert
Date: Thu Oct 4 17:03:04 2012
New Revision: 3953
Log:
Add first draft of paper.
Added:
trunk/doc/paper.tex
Modified:
trunk/doc/ (props changed)
trunk/doc/Makefile.am
trunk/doc/agilerunmc.tex
trunk/doc/gettingstarted.tex
Modified: trunk/doc/Makefile.am
==============================================================================
--- trunk/doc/Makefile.am Thu Oct 4 16:35:50 2012 (r3952)
+++ trunk/doc/Makefile.am Thu Oct 4 17:03:04 2012 (r3953)
@@ -2,9 +2,10 @@
dist_noinst_SCRIPTS = mk-analysis-html mk-analysis-latex
+LATEXSUBSOURCES = preamble.tex intro.tex gettingstarted.tex writinganalyses.tex agilerunmc.tex acknowledgements.tex analyses.tex
DOCSOURCES = compare-histos.txt heppennames.sty warning.png thinker.png cone.png \
h-physrev3.bst hepnames.sty JHEP3.cls bend.png hepnicenames.sty JHEP.bst \
- make-plots.txt rivet-manual.tex preamble.tex intro.tex gettingstarted.tex writinganalyses.tex agilerunmc.tex acknowledgements.tex hepparticles.sty maybemath.sty \
+ make-plots.txt rivet-manual.tex $(LATEXSUBSOURCES) hepparticles.sty maybemath.sty \
rivet-manual.pdf hepunits.sty underscore.sty microtype.sty
## TODO: replace readplot with lighthisto/YODA functionality
@@ -63,7 +64,7 @@
RM = rm -f
DOCNAME = rivet-manual
-$(DOCNAME).pdf : $(DOCNAME).tex preamble.tex intro.tex gettingstarted.tex writinganalyses.tex agilerunmc.tex acknowledgements.tex analyses.tex refs.bib analyses.bib
+$(DOCNAME).pdf : $(DOCNAME).tex $(LATEXSUBSOURCES) refs.bib analyses.bib
$(LATEX) $<; true
egrep $(MAKEIDX) $< && ($(MAKEINDEX) $(DOCNAME) && cp $(DOCNAME).toc $(DOCNAME).toc.bak && $(LATEX) $<) > /dev/null; true
egrep -c $(RERUNBIB) $(DOCNAME).log && ($(BIBTEX) $(DOCNAME) && cp $(DOCNAME).toc $(DOCNAME).toc.bak && $(LATEX) $<); true
@@ -108,7 +109,7 @@
arxivtar: $(DOCSOURCES) rivet-manual.bbl
for i in *.png; do convert $$i $${i/.png/.eps}; done
tar czf rivet-manual.tar.gz \
-rivet-manual.tex preamble.tex intro.tex gettingstarted.tex writinganalyses.tex agilerunmc.tex acknowledgements.tex analyses.tex rivetversion.sty rivet-manual.bbl \
+rivet-manual.tex $(LATEXSUBSOURCES) rivetversion.sty rivet-manual.bbl \
hepnames.sty hepnicenames.sty hepparticles.sty heppennames.sty hepunits.sty maybemath.sty microtype.sty underscore.sty \
bend.eps cone.eps thinker.eps warning.eps \
h-physrev3.bst JHEP3.cls JHEP.bst
@@ -119,6 +120,13 @@
clean-local:
rm -rf $(DOCS)
+paper.pdf : paper.tex $(LATEXSUBSOURCES) refs.bib analyses.bib
+ $(LATEX) $<; true
+ egrep $(MAKEIDX) $< && ($(MAKEINDEX) paper && cp paper.toc paper.toc.bak && $(LATEX) $<) > /dev/null; true
+ egrep -c $(RERUNBIB) paper.log && ($(BIBTEX) paper && cp paper.toc paper.toc.bak && $(LATEX) $<); true
+ for i in `seq 5`; do if egrep $(RERUN) paper.log; then echo "LaTeX re-run $i"; cp paper.toc paper.toc.bak; $(LATEX) $<; else break; fi; done; true
+ if cmp -s paper.toc paper.toc.bak; then true; else $(LATEX) $<; true; fi
+ $(RM) paper.toc.bak; true
## Install!
pkgdata_DATA = $(DOCS)
Modified: trunk/doc/agilerunmc.tex
==============================================================================
--- trunk/doc/agilerunmc.tex Thu Oct 4 16:35:50 2012 (r3952)
+++ trunk/doc/agilerunmc.tex Thu Oct 4 17:03:04 2012 (r3953)
@@ -1,11 +1,11 @@
\begin{itemize}
-\item \paragraph{Simple run:}{\kbd{agile-runmc Herwig:6510 -P~lep1.params
+\item \textbf{Simple run: }{\kbd{agile-runmc Herwig:6510 -P~lep1.params
--beams=LEP:91.2 \cmdbreak -n~1000} will use the Fortran Herwig 6.5.10
generator (the \kbd{-g} option switch) to generate 1000 events (the \kbd{-n}
switch) in LEP1 mode, i.e. $\Ppositron\Pelectron$ collisions at $\sqrt{s} =
\unit{91.2}{\GeV}$.}
-\item \paragraph{Parameter changes:}{\kbd{agile-runmc Pythia6:425
+\item \textbf{Parameter changes: }{\kbd{agile-runmc Pythia6:425
--beams=LEP:91.2 \cmdbreak -n~1000 -P~myrun.params -p~"PARJ(82)=5.27"}
will generate 1000 events using the Fortran Pythia 6.423 generator, again
in LEP1 mode. The \kbd{-P} switch is actually the way of specifying a
@@ -19,7 +19,7 @@
testing of parameter values without needing to write a parameters file for
use with~\kbd{-P}.}
-\item \paragraph{Writing out HepMC events:}{\kbd{agile-runmc Pythia6:425
+\item \textbf{Writing out HepMC events: }{\kbd{agile-runmc Pythia6:425
--beams=LHC:14TeV -n~50 -o~out.hepmc -R} will generate 50 LHC events with
Pythia. The~\kbd{-o} switch is being used here to tell \kbd{agile-runmc} to
write the generated events to the \kbd{out.hepmc} file. This file will be a
Modified: trunk/doc/gettingstarted.tex
==============================================================================
--- trunk/doc/gettingstarted.tex Thu Oct 4 16:35:50 2012 (r3952)
+++ trunk/doc/gettingstarted.tex Thu Oct 4 17:03:04 2012 (r3953)
@@ -265,12 +265,12 @@
\begin{itemize}
-\item \paragraph{Getting help:}{\kbd{rivet --help} will print a (hopefully)
+\item \textbf{Getting help: }{\kbd{rivet --help} will print a (hopefully)
helpful list of options which may be used with the \kbd{rivet} command, as
well as other information such as environment variables which may affect the
run.}
-\item \paragraph{Choosing analyses:}{\kbd{rivet --list-analyses} will list the
+\item \textbf{Choosing analyses: }{\kbd{rivet --list-analyses} will list the
available analyses, including both those in the Rivet distribution and any
plugins which are found at runtime. \kbd{rivet --show-analysis \val{patt}}
will show a lot of details about any analyses whose name match the
@@ -280,7 +280,7 @@
details of all available CDF experiment analyses published in the
``noughties.''}
-\item \paragraph{Running analyses:}{\kbd{rivet -a~DELPHI_1996_S3430090
+\item \textbf{Running analyses: }{\kbd{rivet -a~DELPHI_1996_S3430090
fifo.hepmc} will run the Rivet
\kbd{DELPHI_1996_S3430090}\cite{Abreu:1996na} analysis on the events in the
\kbd{fifo.hepmc} file (which, from the name, is probably a filesystem named
@@ -297,12 +297,12 @@
% above, incompatible analyses will be removed before the main analysis run
% begins.}
-\item \paragraph{Histogramming:}{\kbd{rivet fifo.hepmc -H~foo.aida} will read all the
+\item \textbf{Histogramming: }{\kbd{rivet fifo.hepmc -H~foo.aida} will read all the
events in the \kbd{fifo.hepmc} file. The \kbd{-H} switch is used to
specify that the output histogram file will be named \kbd{foo.aida}. By
default the output file is called \kbd{Rivet.aida}.}
-\item \paragraph{Fine-grained logging:}{\kbd{rivet fifo.hepmc -A
+\item \textbf{Fine-grained logging: }{\kbd{rivet fifo.hepmc -A
-l~Rivet.Analysis=DEBUG~\cmdbreak -l~Rivet.Projection=DEBUG
-l~Rivet.Projection.FinalState=TRACE~\cmdbreak -l~NEvt=WARN}
will analyse events as before, but will print different status
Added: trunk/doc/paper.tex
==============================================================================
--- /dev/null 00:00:00 1970 (empty, because file is newly added)
+++ trunk/doc/paper.tex Thu Oct 4 17:03:04 2012 (r3953)
@@ -0,0 +1,146 @@
+\documentclass[preprint,12pt]{elsarticle}
+
+\input{preamble}
+\usepackage{hyperref}
+
+\begin{document}
+
+\begin{frontmatter}
+
+ \title{Rivet user manual}
+
+ \author[a]{Andy Buckley}
+ \author[b]{Jonathan Butterworth}
+ \author[c]{Hendrik Hoeth}
+ \author[d]{Leif L\"onnblad}
+ \author[b]{James Monk}
+ \author[e]{Holger Schulz}
+ \author[f]{Frank Siegert\corref{author}}
+
+ \address[a]{PPE Group, School of Physics, University of Edinburgh, UK.}
+ \address[b]{HEP Group, Dept. of Physics and Astronomy, UCL, London, UK.}
+ \address[c]{IPPP, Durham University, UK.}
+ \address[d]{Theoretical Physics, Lund University, Sweden.}
+ \address[e]{Institut f\"ur Physik, Berlin Humboldt University, Germany.}
+ \address[f]{Physikalisches Institut, Freiburg University, Germany.}
+
+ \cortext[author]{Corresponding author.\\\textit{E-mail address:} frank.siegert at cern.ch}
+
+ \begin{abstract}
+ This is the manual and user guide for the Rivet system for the
+ validation and tuning of Monte Carlo event generators. As well as the core
+ Rivet library, this manual describes the usage of the \kbd{rivet} program and
+ the AGILe generator interface library. The depth and level of description is
+ chosen for users of the system, starting with the basics of using validation
+ code written by others, and then covering sufficient details to write new
+ Rivet analyses and calculational components.
+ \end{abstract}
+
+ \begin{keyword}
+ Event generator; simulation; validation; tuning; QCD
+ \end{keyword}
+
+\end{frontmatter}
+
+
+{\bf PROGRAM SUMMARY}
+
+\begin{small}
+ \noindent
+ {\em Manuscript Title: Rivet user manual}\\
+ {\em Authors: Andy Buckley, Jonathan Butterworth, Hendrik Hoeth,
+ Leif L\"onnblad, James Monk, Holger Schulz, Frank Siegert}\\
+ {\em Program Title: Rivet}\\
+ {\em Journal Reference:} \\
+ % Leave blank, supplied by Elsevier.
+ {\em Catalogue identifier:} \\
+ % Leave blank, supplied by Elsevier.
+ {\em Licensing provisions:} \\
+ % enter "none" if CPC non-profit use license is sufficient.
+ {\em Programming language: C++, Python}\\
+ {\em Computer: PC running Linux, Mac}\\
+ % Computer(s) for which program has been designed.
+ {\em Operating system: Linux, Mac OS}\\
+ % Operating system(s) for which program has been designed.
+ {\em RAM: 20M} bytes\\
+ % RAM in bytes required to execute program with typical data.
+ {\em Number of processors used: 1} \\
+ % If more than one processor.
+ {\em Supplementary material:} \\
+ % Fill in if necessary, otherwise leave out.
+ {\em Keywords:} Event generator, simulation, validation, tuning, QCD \\
+ % Please give some freely chosen keywords that we can use in a
+ % cumulative keyword index.
+ {\em Classification: 11.9 Event Reconstruction and Data Analysis}\\
+ % Classify using CPC Program Library Subject Index, see (
+ % http://cpc.cs.qub.ac.uk/subjectIndex/SUBJECT_index.html)
+ % e.g. 4.4 Feynman diagrams, 5 Computer Algebra.
+ {\em External routines/libraries: HepMC, GSL, FastJet, Python, Swig, Boost, YAML}\\
+ % Fill in if necessary, otherwise leave out.
+ {\em Nature of problem:}\\
+ Experimental measurements from high-energy particle colliders should be
+ defined and stored in a general framework such that it is simple to compare
+ theory predictions to them. Rivet is such a framework, and contains at the
+ same time a large collection of existing measurements.
+ \\
+ {\em Solution method:}\\
+ Rivet is based on HepMC events, a standardised output format provided by many
+ theory simulation tools. Events are processed by Rivet to generate histograms
+ for the requested list of analyses, incorporating all experimental phase
+ space cuts and histogram definitions.
+ \\
+ {\em Restrictions:}\\
+ Can not calculate statistical errors for correlated events as they appear
+ in NLO calculations.
+ \\
+ {\em Unusual features:}\\
+ It is possible for the user to implement and use their own custom analysis
+ as a module without having to modify the main Rivet code/installation.
+ \\
+ {\em Additional comments:}\\
+ % Provide any additional comments here.
+ \\
+ {\em Running time:}\\
+ Depends on the number and complexity of analyses being applied, but typically
+ a few hundred events per second.
+ \\
+
+\end{small}
+
+
+\section{Introduction}
+\label{sec:intro}
+\input{intro}
+
+\cleardoublepage
+
+\part{Getting started with Rivet}
+\label{part:gettingstarted}
+\input{gettingstarted}
+
+\cleardoublepage
+
+\part{How Rivet works}
+\label{part:writinganalyses}
+\input{writinganalyses}
+
+\cleardoublepage
+
+\part{Appendices}
+\appendix
+
+\section{Typical \kbd{agile-runmc} commands}
+\label{app:agilerunmc}
+\input{agilerunmc}
+
+\section{Acknowledgements}
+\label{app:acknowledgements}
+\input{acknowledgements}
+
+
+\cleardoublepage
+
+\bibliographystyle{elsarticle-num}
+\bibliography{refs}
+
+\end{document}
More information about the Rivet-svn
mailing list
|