sPHENIX tracking discussion

[Martin Purschke <purschke AT bnl.gov>]

... I forgot one more thing:

In a number of files, I see "reminders" to the author in the text such as

TODO: Add a figure from the  new simulation.

Of course that will go into the actual document, and can be quite
embarrassing if you forget to address every single one of them and they
survive into the final document. And since they are free-form, there is
no consistent way to search for them.

A much better solution is to use the \message facility:

\message{TODO: Add a figure from the  new simulation.}

This is like a message to yourself that there are still some things to
address. But they don't get into the final document.

        - Martin

On 9/19/15 4:46 PM, Martin Purschke wrote:
> 
> Dear All,
> 
> I was just going through the pCDR for some more updates. I have a number
> of latex-level suggestions that I think will make the individual chapter
> authors' life easier.
> 
> First, as it is right now with a fresh pull at ~3:30pm, the entire pCDR
> will not cleanly typeset - there are a few issues in the hcal section
> (especially the inclusion of eps, rather than pdf files).
> 
> Brant set the structure up in a way that this shouldn't matter unless
> you want to typeset the entire thing - once you have git-cloned the
> pCDR, that's what the chapter-local 1<chaptername>.tex files (such as
> daq_trig/1daq_trig.tex)  are for. They allow you to continue to work in
> your local area, basically independent of everything that's going on
> around you. Just cd to your area, and "make debug".
> 
> One problem though - the figs/ directory is relative to the pCDR/ level,
> not your chapter level.
> 
> Just add a
> 
> \graphicspath{{../}}
> 
> directive to your 1xxxxxx.tex file, and it will work. That instructs
> latex to search for the figures relative to the pCDR level again.
> 
> If top-level maintainer Brant agrees, we could add this to all the local
> 1*.tex files... what do you think?
> 
> A similar tangle (with a less elegant solution) exists when your area
> consists of a number of input files, such as the emcal section -
> 
>> \input{emcal/emcal_overview_physics}
>> \input{emcal/emcal_overview_detector}
>> \input{emcal/emcal_simulations}
>> \input{emcal/emcal_prototyping_rd}
>> \input{emcal/emcal_alternatives}
> 
> which leads to a wrong path if you are in the emcal area already.
> 
> Here's an overleaf-benign way out:
> 
> add the following line to your main tex file (e.g. emcal.tex)
> 
> \providecommand*{\IncludePath}{./}
> 
> and modify the \input statements to read
> 
>> \input{\IncludePath/emcal/emcal_overview_physics}
>> \input{\IncludePath/emcal/emcal_overview_detector}
>> \input{\IncludePath/emcal/emcal_simulations}
>> \input{\IncludePath/emcal/emcal_prototyping_rd}
>> \input{\IncludePath/emcal/emcal_alternatives}
> 
> When processed from the pCDR-level tex file, the includes become
> ./emcal/emcal_overview_physics.tex and are right.
> 
> Now add the line
> 
> \providecommand*{\IncludePath}{../}
> 
> to your 1xxxxxx.tex file, and that path will be ok, too.
> \providecommand is like \newcommand, except it doesn't scream if the
> variable in question is already defined. It is more like a "if not yet
> defined, define it as follows".
> 
> Other pointers:
> 
> - The \label{} in a figure caption MUST go into the caption, not into
> the body of the figure.
> 
> wrong:
> \begin{figure}
> \includegraphics{something.pdf}
> \caption{The caption}
> \label{TheFigure}
> \end{figure}
> 
> right:
> \begin{figure}
> \includegraphics{something.pdf}
> \caption{\label{TheFigure}The caption}
> \end{figure}
> 
> This is because it is the caption which constitutes the counter.
> 
> - I'd suggest that we all spell the Cerenkov counter \v{C}erenkov.
> 
> 
> - When you process the current pCDR, you'll find a number of undefined
> references (they are easy to track down), but also a number of duplicate
> labels, where someone probably copy-pasted a figure caption without
> changing the label. Those are a bit harder to find. Here is a simple
> way: After processing the 0main.tex file (or your local one), you can
> search for the word "multiply":
> 
>> $ grep multiply  0main.log
>> LaTeX Warning: Label `Tab:ElectronicsRequirements' multiply defined.
>> LaTeX Warning: Label `default' multiply defined.
>> LaTeX Warning: Label `default' multiply defined.
>> LaTeX Warning: Label `default' multiply defined.
>> LaTeX Warning: Label `default' multiply defined.
>> LaTeX Warning: Label `default' multiply defined.
>> LaTeX Warning: Label `default' multiply defined.
>> LaTeX Warning: Label `default' multiply defined.
>> LaTeX Warning: Label `default' multiply defined.
>> LaTeX Warning: Label `default' multiply defined.
>> LaTeX Warning: Label `default' multiply defined.
>> LaTeX Warning: Label `default' multiply defined.
>> LaTeX Warning: Label `default' multiply defined.
>> LaTeX Warning: Label `default' multiply defined.
>> LaTeX Warning: There were multiply-defined labels.
> 
> 
> or you can do
> 
>> $ grep newlabel 0main.aux | awk -F\} '{print $1}' | sort | uniq -d
>> \newlabel{Tab:ElectronicsRequirements
>> \newlabel{default
> 
> Et voilà.
> 
> I hope it helps those of us who git-pull a local version to work on the
> plane, or otherwise offline or local.
> 
> Best,
>       Martin
> 
> 
> On 9/18/15 5:25 PM, John Haggerty wrote:
>> Hello,
>>
>> It's by no means "done," even for today, but I just wanted to thank 
>> everyone who contributed to the draft of the pCDR we have today.  I just 
>> put a snapshot of the document here:
>>
>>> https://www.phenix.bnl.gov/WWW/p/draft/haggerty/sphenix/pcdr/pcdr00.pdf
>>
>> It's good to try and put down on paper what we want to build, and 
>> collecting the text, figures, and simulations several weeks before it is 
>> "due" has proven pretty useful.  Please continue to work and simulate 
>> and write as we try and turn this draft into a true proposal.
>>
>> We'll continue working on it tonight, you can see the current state in 
>> Overleaf.
>>
>> Thanks to all!
>>
>> On 9/16/15 9:02 AM, John Haggerty wrote:
>>> Hello,
>>>
>>> I am shepherding the effort to write the sPHENIX Preliminary Conceptual
>>> Design Report, and I would like to remind the authors that we agreed to
>>> show BNL management a snapshot of the document this Friday, Sep 18
>>> (i.e., two days from now).  Obviously, it's not done yet and won't be
>>> done on Friday, either, I think it's a way point like showing your
>>> thesis adviser your outline and some of the draft figures and text.
>>>
>>> But we should strive to get as much content as we can into it, which we
>>> can then reorder, revise, rewrite.  You can see the document draft in
>>> real time here:
>>>
>>>> https://www.overleaf.com/2657127qghjbm
>>>
>>> The section author-editors are here:
>>>
>>>> %% Scientific Objective and Performance  John Harris, Jamie, Dave
>>>> %% SC-Magnet                             Kin, Achim
>>>> %% Tracker                               Ed, Yasuyuki,Itaru, Tom, Takao
>>>> %% EMCal                                 Sean, Craig, Anne
>>>> %% HCal                                  John, John, Edward
>>>> %% Calorimeter Electronics               Eric, Chi
>>>> %% DAQ/Trigger                           Martin, Eric
>>>> %% Infrastructure                        Paul, Don
>>>> %% Installation and Integration          Don, Dave
>>>> %% Project Management                    Ed, Jim
>>>
>>> but I would encourage anyone with good drawings, plots, or words to send
>>> them what you can now to incorporate into the pCDR.
>>>
>>> I'll make a snapshot of the pdf at 11:59pm on Friday with what we have.
>>>
>>> We have been asked to submit the next version of this document on
>>> Friday, October 2, but I think we should renegotiate that to Friday,
>>> October 9, which is still a month in advance of the November 9-10 BNL
>>> review, and leaves a week after Quark Matter, where many people who are
>>> writing and reading this document will be.
>>>
>>
>>
> 
> 


-- 
Martin L. Purschke, Ph.D.        ;   purschke AT bnl.gov
                                 ;   http://www.phenix.bnl.gov/~purschke
                                 ;
Brookhaven National Laboratory   ;   phone: +1-631-344-5244
Physics Department Bldg 510 C    ;   fax:   +1-631-344-3253
Upton, NY 11973-5000             ;   skype: mpurschke
-----------------------------------------------------------------------