Setup Guide

Obtaining the Software

If you just want to use the software without modifying/building it, you can download a pre-built package from the GitHub releases page or the corresponding repo at JLab. Builds on JLab machines are also available, see the general software wiki for setting up your environment to use them.

If you would rather build and install it yourself, git clone the repository, then skip to the next section below.

For anything more, see the "General Developer Documentation" link on that software wiki, which points here.

The troubleshooting wiki page may also still be useful but likely outdated.

Dependencies

• Java
• Maven

Maven will automatically obtain all other dependencies.

Building and Installing

Run the installation script:

./build-coatjava.sh

For more usage guidance, run:

./build-coatjava.sh --help

The software will then be installed within the top-level repository directory, in a subdirectory named coatjava/, which contains:

Directory	Description
bin	Executables for the user, such as recon-util
etc	Various supplementary files, such as bank schema and magnetic field maps
lib	JAR files
libexec	Internal scripts

Troubleshooting

If you want to cleanly rebuild, use the --clean option for build-coatjava.sh.

If you need to clean your Maven cache, which by default is stored in ~/.m2/repository, you can try either removing that directory, or renaming it, so that it is recreated. Then try to build coatjava again.