Quick Start Guide

This is a quick guide on how to compile and run the rebinning software. This system requires cmake which may not be in the production path.

== Get, Compile and Install ==

1. ''Checkout'': svn co https://flathead.ornl.gov/repos/Binner/trunk/binner
2. Create a build directory separate from the checkout area
3. ''Configure'': See the [wiki:cmake cmake] page for configuration options.
4. Do make and make install

The result of this process will place the executables into /path/to/install/area/binner/version_number/bin. This path will need to be added to your $PATH. Running the rebinner requires having run the ''DGS'' data reduction first.

== Configuration Files ==

Running the rebinning code requires two configuration files. The first is the experimental and rebinning grid. The file should look something like this.

INST:CNCS
RUN:800-860
# Each axis should be specified in min, max, width
XAXIS:-1.5,2.0,0.1
YAXIS:-0.4,0.4,0.1
ZAXIS:0.0,2.4,0.1

The second file is the angle mapping and should have two columns of run number and rotation angle in degrees.

800     10
801     7
802     4
803     1
804     -2
805     -5
...

== Running ==

To run the rebinner, you need to execute the rebinit command. This is currently not installed via the build system. The command is available in the checked out source code under the script directory. The minimal execution incantation is

./rebinit /path/to/rebin_info /path/to/angle_map.

Currently the jobs are run in the ''asg'' queue to avoid the instrument computers. An option flag, {{{--make-vtk}}}, will make VTK file from the resulting rebinned ASCII data.