This wiki is now closed and kept for historical purposes. Please visit the new wiki at https://lbne.bnl.gov/wiki/

CDR

From DUSEL
Jump to navigationJump to search

The Conceptual Design Report (CDR) is needed for CD-1 approval.

Organization

The CDR describes the entire project. It contains 7 volumes as outlined here.

Additional organization is done through basecamp:

https://lbne-doc.basecamphq.com/

Schedule

Our current schedule is provided here:

Item Description Date
CDR v1 Authors identified April 15, 2010
Detailed Outline/Rough Draft May 10, 2010
Intermediate Draft June 25, 2010
Internal Review August 13, 2010
August 23 Draft August 23, 2010
August 30 Draft for internal review August 30, 2010
Final for WCD Review September 17, 2010
To WCD Review committee September 27-29, 2010
CDR v2 Revised Design selected April 14, 2011
1st Draft August 29, 2011
internal review October 14, 2011
for collaboration review October 28, 2011
LBNE review March 1, 2012
LBNE review March 3, 2012
Final for Director's Review March 15, 2012

File:Example.jpg

CDR Terminology, standards

(Anne's sandbox)

CDR: Still needed: Figures, tables, numbers, etc.

CDR: Review comments

CDR Volumes

Recently built PDFs of the CDR can be downloaded from http://www.phy.bnl.gov/~bviren/lbne/cdr/. Both per-volume or per-chapter files are available. The files are automatically built w/in 10 minutes of an update to SVN. If a link is broken it means either a build is in progress or the document has failed. A summary of LaTeX errors is produced each rebuild.


Volume 1: LBNE Project

There could be several combinations for vol 1, given the 2 beam options (MI-10, MI-60), the two LAr FD options (800 and 4850) and the FD technology decision (WCD or LAr). (No real content in SVN yet 8/25/11 AH)

Volume 2: Beamline

  • Volume technical/scientific editor is Byron Lundberg.


  • Recent PDF of Vol 2 for Beam (MI-10) : volume-2-beam.pdf NOT READY FOR OUTSIDE REVIEW (Anne H, 1/26/12)

Volume 3: Near Detector Complex

  • Volume technical/scientific editor is Cas Milner (LANL).

Volume 4: Water Cherenkov Detectors

  • Volume technical/scientific editor is Steve Kettell.
  • WCD CDR contains details for authors (beyond "Getting the source text" and "Guidance", above).
  • CDR-vol4-status shows the current status (How complete is each chapter and section?).

Note: if this file exists it means the build failed.

Volume 5: Liquid Argon

  • Volume technical editor is Marvin Marshak
  • CDR-vol5-status shows the current status (How complete is each chapter and section?).


Note: if this file exists it means the build failed.

Whitepaper draft

See Whitepaper

Getting the source text

The LaTeX source files are kept in SVN. You can browse it and download files from:

https://lbne.bnl.gov/svn/documents/cdr

Dealing with SVN

Initial checkout

svn checkout https://lbne.bnl.gov/svn/documents/cdr

Regardless of which volume you edit (4 or 5) you need to check out the full cdr/ area as the style files are shared.

Update your copy

svn update

Add new files (also need commit).

svn add mynewfile.tex

Commit changes (only need --username the first time). If no files specified, will commit all modifications.

svn commit --username=USERNAME [file.tex ...]


See the SVN_Repository topic for more information about SVN including how to gain access.

Guidance

See DocDB 4053. (AH needs to augment this)

  • There is a document that provides guidance on producing quality figures as well as some LaTeX examples. It is available in the same SVN area as the volumes. A recent build is available here:
http://www.phy.bnl.gov/~bviren/lbne/cdr/volume-X-dummy.pdf
  • The LaTeX source for this document can be used if you need examples. See the files here.

LaTeX issues

Anne wrote a document called "sample" that you can use instead. Docdb 3830. Both TeX source and resulting PDF are given. The PDF provides instructions and the pair serves as an example.

To build the CDR volumes 4 and 5 (and Guidance document) you need pdflatex, bibtex and a few packages and fonts.

Building

From the command line (unix or mac os X)

To build a document from the Unix shell command line you need to do the following, taking volume 4 as an example:

rm -f bu*.aux
pdflatex volume-4-WCD
bibtex volume-4-WCD
for n in bu*.aux
do 
  bibtex $(basename $n .aux)
done
pdflatex volume-4-WCD
pdflatex volume-4-WCD

Note: if you use "latexmk" you can do the slightly briefer:

rm -f bu*.aux
latexmk volume-4-WCD
for n in bu*.aux
do 
  bibtex $(basename $n .aux)
done
latexmk volume-4-WCD

If you haven't changed any bibliography related material then subsequent to the above it is sufficient to simply do:

pdflatex volume-4-WCD


Bibliography

We use Bibtex and bibunit to provide per-chapter and global per-volume bibliography. All references for volumes 4 and 5 are collected in refs.bib. The existing entries should give enough examples. Take note to:

  • Start an entry with an @ followed by a a key word giving the type of the entry followed the body.
  • The body starts with a "{" and the reference name followed by type-specific key/value pairs and ending with a "}"
  • Enclose values in braces: {}
  • Separate key/value pairs with commas: ,
  • Anything outside of "@TYPE{...}" is a comment, no need to use latex comment: %


Packages

These packages may not be part of the default install; you can choose to install them or not.

  • lineno (puts in line numbers; useful for reviewing)
  • tocbibind (gives contents, biblio, index)
  • bibunit (allows biblio references by chapter)

Fonts

Any extra fonts needed should be provided in SVN. If you get messages like:

!pdfTex error: pdflatex (file ugmm8a.pfb): cannot open type 1 font file for reading

let the editors know.

Texlive (Linux & Mac)

Most of the required packages are available in the base install. You may need:

sudo apt-get install texlive-latex-extra texlive-fonts-extra texlive-humanities

to get the few that are not.

MiKTeX (Windows)

Install MiKTeX v2.8 (at least). If you want a GUI/IDE install TeXnicCenter. When you install MiKTeX make sure you select "Yes" when asked if it should automatically download missing packages. Even with this on you may need to install some packages listed above manually. You can do this from the menu: MiKTeX->Maintenance->Package Manager.