* INSTALL, README.md [rtj]

   - add references to the wiki HOWTO to the package documentation
     sources.

* g4py/cobrems.py [rtj]
   - add pydoc documentation to the undocumented methods in cobrems.py

Author: rjones30

INSTALL

@@ -77,7 +77,7 @@ initialized.
 
 Before attempting the build, go into the src directory of the HDGeant4
 distribution and create a symlink called G4fixes pointing to the directory
-G4<.X.Y-P>fixes where X,Y,P are the version, release, and patch numbers
+G4<.X.Y.P>fixes where X,Y,P are the version, release, and patch numbers
 of the G4 libraries to which you will be linking in your build.
 
 The general procedure for building hdgeant4 is:

README.md

@@ -46,16 +46,37 @@ See VERSIONS file in the project directory.
 
 ## Usage synopsis
 
+Usage: hdgeant4 [options] [<batch.mac>]
+ where options include:
+    -v : open a graphics window for visualization
+    -tN : start N worker threads, default 1
+    -rN : set run to N, default taken from control.in
+
 ## Dependencies
 
+See https://halldweb.jlab.org/wiki/index.php/HOWTO_install_and_run_HDGeant4
+for detailed information regarding external package dependencies.
+
 ## Building instructions
 
+See INSTALL file in the project directory, or for more detailed building
+instructions, 
+see https://halldweb.jlab.org/wiki/index.php/HOWTO_install_and_run_HDGeant4
+on the gluex wiki.
+
 ## Documentation
 
+See https://halldweb.jlab.org/wiki/index.php/HOWTO_install_and_run_HDGeant4
+on the gluex wiki.
+
 ## Troubleshooting
 
+See https://halldweb.jlab.org/wiki/index.php/HOWTO_install_and_run_HDGeant4
+section on visualization, found on the gluex wiki.
 ## Bugs
 
 ## How to contribute
 
 ## Contact the authors
+
+Write to richard.t.jones at uconn.edu, or to davidl at jlab.org.

g4py/cobrems.py

@@ -42,6 +42,10 @@
 generator = CobremsGenerator(E0, Epeak)
 
 def usage():
+   """
+   Print a brief summary of the internal configuration variables
+   that regulate the behavior of the CobremsGenerator and exit.
+   """
    print """
    Usage: cobrems.init(key=value, ...)
      where key should be one of the following, [defaults in backets]:
@@ -322,18 +326,48 @@ def plotPolarization(collimated=1):
    return polarH1
 
 def acceptance(vars):
+   """
+   TF1 user function that can be used to plot the collimator acceptance
+   for photons emitted at lab polar angle vars[0] relative to the incident
+   electron beam direction at the radiator. Both beam emittance and
+   multiple-scattering in the target contribute to smearing of the angular
+   acceptance at the the collimator edge. The scattering angle is contained
+   in list argument vars[0], expressed in units of (me/fBeamEnergy).
+   """
    return generator.Acceptance(vars[0] ** 2)
 
 def polarization(vars):
-   return generator.Polarization(vars[0])
+   """
+   TF1 user function that can be used to plot the linear polarization of
+   the photon beam at energy k = vars[0] * fBeamEnergy, and production angle
+   vars[1] expressed in units of (me/fBeamEnergy).
+   """
+   return generator.Polarization(vars[0], vars[1] ** 2)
 
 def dRtdx(vars):
+   """
+   TF1 user function that can be used to plot the total beam flux spectrum
+   of the collimated coherent bremsstrahlung photon beam at photon energy
+   k = vars[0] * fBeamEnergy, in units of (/GeV/s).
+   """
    return generator.Rate_dNtdx(vars[0]) * cur / 1.6e-13
 
 def dRcdx(vars):
+   """
+   TF1 user function that can be used to plot the beam flux spectrum
+   (coherent component only) of the collimated coherent bremsstrahlung
+   photon beam at photon energy k = vars[0] * fBeamEnergy, in units
+   of (/GeV/s).
+   """
    return generator.Rate_dNcdx(vars[0]) * cur / 1.6e-13
 
 def dRidx(vars):
+   """
+   TF1 user function that can be used to plot the beam flux spectrum
+   (incoherent component only) of the collimated coherent bremsstrahlung
+   photon beam at photon energy k = vars[0] * fBeamEnergy, in units
+   of (/GeV/s).
+   """
    return generator.Rate_dNidx(vars[0]) * cur / 1.6e-13
 
 def plotTotal_rc(rchist, collimated=1):