Walkthrough: Obtaining the Tools - rg2/xreg GitHub Wiki

The software may either be built from source or obtained in the form of pre-compiled binaries available from the release section. Although either approach is acceptable for proceeding through the walkthrough, it is recommended to use the pre-compiled releases for those who are unfamiliar with CMake C++ build pipelines. For those building the software, the main repository readme provides details on building the software and example build scripts are provided for MacOS/Linux and Windows.

It is recommended to add the directory of executables to the search path in order to better follow the walkthrough. This will enable the commands from the walkthrough to be mostly cut-and-pasted. When compiling from source, it is suggested to run the install target (e.g. make install , ninja install , etc.) and add the executable directory to your PATH variable. Windows releases include a setup-xreg-vars.bat file to facilitate this. Running setup-xreg-vars.bat in a command prompt will perform the PATH update and remain in effect for the remainder of that prompt's session.

Each program typically provides a command line interface for specifying input/output data and processing parameters. A general description of what each program does, along with a detailed description of the parameter flags and positional arguments may be obtained by passing the help flag (--help or -h). If you are following this walkthrough on a machine with multiple GPUs and need to select a specific device, see the following page for details on selecting processing backends and devices.

Windows Users

Windows users may need to install the Visual Studio C++ runtime in order to run the pre-compiled Windows executables. The runtime may be downloaded here or here (under the "Other Tools and Frameworks" section choose x64).

When running each pre-compiled binary for the first time, several "Virus & threat protection" dialogs may appear and indicate that a security scan will be conducted. This scan slows down the speed of each program's initial execution, but subsequent runs are much quicker.