Using CVS for writing inspiral papers
Since the LSC and Virgo have joined forces on data analysis activities, these pages are now frozen. Ongoing searches for gravitational waves from compact binary systems are performed under the Compact Binary Coalescence group. Please look at that web site for more information about the group, mail lists, and cvs access and other resources.
The inspiral groups uses CVS -- Concurrent Version-control System -- as a document control and collaboration system. It is a tool to allow multiple developers to manipulate the same files, merging differences and identifying conflicts between changes if they arise. Obtain the Inspiral Working Group papers from the CVS repository as follows.-
Identify the local directory where you wish to store the papers and change
into that directory. Here, I use /home/patrick/papers as
that directory:
cd /home/patrick/papers
- Getting the files
Log in by typing the following line where anonymous
is replaced by your username:
cvs -d :pserver:anonymous@gravity.phys.uwm.edu:/usr/local/cvs/lscdocs login
Now download the papers:
cvs -d :pserver:anonymous@gravity.phys.uwm.edu:/usr/local/cvs/lscdocs co iulgroup
This will take a while to complete since the archive is quite large. If you only want to get the papers subdirectories and forego the E7 and S1 reports, you can do
cvs -d :pserver:anonymous@gravity.phys.uwm.edu:/usr/local/cvs/lscdocs co iulgroup/papers
Once this finishes, you can enter the papers directory by typing
cd iulgroup/papers/
There are several sub-directories s1, s2-bns, etc. Each directory will contain a number of TeX, postscript, and PDF files. In general, there will also be a Makefile to simplify the compilation of the paper. To see the S1 paper, for example, type
cd s1
make
to latex the file and produce both dvi and pdf output. The Makefile currently uses pdflatex to produce the pdf file. You can then view the result by acroread s1short.pdf or xdvi s1short.dvi
- Making changes and committing them to the CVS archive.
Edit the tex source, e.g.
vi paper.tex
Once you've made your changes and checked that everything latex's ok, you want to commit the modified file to the CVS repository. To do this, first remove any auxilliary files by typing
make realclean
then commit the modified file to the CVS repository:
cvs commit paper.tex
You will be asked to provide a comment for the change log. This does not need to be detailed, but should give some indication of the work you were doing.
- Updating your copy with changes made by another person.
To update your entire directory simply type:
cvs update -Ad
from the .../iulgroup/papers directory. This will download and merge changes into the files from the repository. If you have been working on a local copy and your changes conflict with those made by the other person, you will receive a warning and will need to manually edit the file to remove the conflicts. It is usually good practice to update your local copy of the archive before working on the files; this avoids conflicts. It is also good practice to commit changes reasonably often.
- Adding postscript or pdf figures to the archive To add a postscript or
pdf figure to the archive, first place it in the directory containing
the tex file that needs it. Suppose the filename is
figure.ps. Type:
cvs add -kb figure.ps
cvs commit figure.ps
The -kb flags are very important. They prevent certain substitutions from being done by CVS. If you commit postscript or PDF without these options, let Patrick Brady know and we'll get it fixed.
- Adding tex or text files To add a text file to the archive,
first place it in the appropriate directory. For convenience, let the
filename be myfile.tex. Type:
cvs add myfile.tex
cvs commit myfile.tex
$Id: lscdocs-cvs.html,v 1.1 2005/02/07 06:44:08 patrick Exp $