[Rivet-svn] r4304 - trunk/doc

[blackhole at projects.hepforge.org]

Author: fsiegert
Date: Fri May 24 10:16:22 2013
New Revision: 4304

Log:
Final changes for CPC submission. Will revert parts of this later as not all of it is necessary for our normal manual.

Added:
   trunk/doc/projections.png   (contents, props changed)
Modified:
   trunk/doc/acknowledgements.tex
   trunk/doc/gettingstarted.tex
   trunk/doc/paper.tex
   trunk/doc/selectedanalyses.py
   trunk/doc/writinganalyses.tex

Modified: trunk/doc/acknowledgements.tex
==============================================================================
--- trunk/doc/acknowledgements.tex	Thu May 23 11:45:24 2013	(r4303)
+++ trunk/doc/acknowledgements.tex	Fri May 24 10:16:22 2013	(r4304)
@@ -6,7 +6,8 @@
   contract MRTN-CT-2006-035606 and Framework Programme 7 contract PITN-GA-2012-315877.
 \item Andy Buckley has been supported by grants from the UK Science and
   Technology Facilities Council (Special Project Grant), the Scottish
-  Universities Physics Alliance (Advanced Research Fellowship), the Institute
+  Universities Physics Alliance (Advanced Research Fellowship), 
+  the Royal Society (Research Fellowship), the Institute
   for Particle Physics Phenomenology (Associateship), and a CERN Scientific
   Associateship.
 \item Holger Schulz and Frank Siegert acknowledge the support of the German

Modified: trunk/doc/gettingstarted.tex
==============================================================================
--- trunk/doc/gettingstarted.tex	Thu May 23 11:45:24 2013	(r4303)
+++ trunk/doc/gettingstarted.tex	Fri May 24 10:16:22 2013	(r4304)
@@ -183,7 +183,7 @@
 In the following command examples, we will assume that a generator has been set
 up to write to the \kbd{fifo.hepmc} FIFO, and just list the \kbd{rivet} command
 that reads from that location. Some typical \kbd{agile-runmc} commands are
-listed in \AppendixRef{app:agilerunmc}.
+listed in \ref{app:agilerunmc}.
 
 
 \subsection{Analysis status}

Modified: trunk/doc/paper.tex
==============================================================================
--- trunk/doc/paper.tex	Thu May 23 11:45:24 2013	(r4303)
+++ trunk/doc/paper.tex	Fri May 24 10:16:22 2013	(r4304)
@@ -22,7 +22,7 @@
   \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[d]{Department of Astronomy and Theoretical Physics, Lund University, Sweden.}
   \address[e]{Institut f\"ur Physik, Berlin Humboldt University, Germany.}
   \address[f]{Physikalisches Institut, Freiburg University, Germany.}
 
@@ -122,12 +122,6 @@
 
 \cleardoublepage
 
-\part{Selected analyses}
-\label{part:selectedanalyses}
-\input{selectedanalyses}
-
-\cleardoublepage
-
 \part{How Rivet works}
 \label{part:writinganalyses}
 \input{writinganalyses}
@@ -141,6 +135,10 @@
 \part{Appendices}
 \appendix
 
+\section{Selection of analyses available in the Rivet framework}
+\label{sec:selectedanalyses}
+\input{selectedanalyses}
+
 \section{Typical \kbd{agile-runmc} commands}
 \label{app:agilerunmc}
 \input{agilerunmc}

Added: trunk/doc/projections.png
==============================================================================
Binary file. No diff available.

Modified: trunk/doc/selectedanalyses.py
==============================================================================
--- trunk/doc/selectedanalyses.py	Thu May 23 11:45:24 2013	(r4303)
+++ trunk/doc/selectedanalyses.py	Fri May 24 10:16:22 2013	(r4304)
@@ -213,14 +213,14 @@
 publications, status and authors of the Rivet implementation as well as run
 details necessary for comparing a Monte-Carlo prediction with the data.
 
-\section{Selection of analyses available in the Rivet framework}
+{\scriptsize
 """
 
 body = ""
 for page in pages:
     body = body + page + "\n"
 
-outstr = prefix + body
+outstr = prefix + body + "}\n"
 
 ## Write out to TeX and BibTeX files
 f = open("%s.tex" % OUTNAME, "w")

Modified: trunk/doc/writinganalyses.tex
==============================================================================
--- trunk/doc/writinganalyses.tex	Thu May 23 11:45:24 2013	(r4303)
+++ trunk/doc/writinganalyses.tex	Fri May 24 10:16:22 2013	(r4304)
@@ -161,6 +161,13 @@
 
 \section{Projections}
 
+\begin{figure}[p]
+  \centering
+  \includegraphics[height=0.98\textheight]{projections.png}
+  \caption{List of available projections and their inheritance structure.}
+  \label{fig:projections}
+\end{figure}
+
 The name ``projection'' is meant to evoke thoughts of projection operators,
 low-dimensional slices/views of high-dimensional spaces, and other things that
 might appeal to physicists who view the world through quantum-tinted lenses. A
@@ -184,6 +191,10 @@
 loops in the nesting chain.) Calling a complex projection in an analysis may
 actually transparently execute many projections on each event.
 
+You can find a list of all existing projections and their inheritance structure
+in Fig.~\ref{fig:projections}. An up-to-date version of this listing can always
+be found in the code documentation at \url{http://rivet.hepforge.org}.
+
 
 \subsection{Projection caching}