Getting Started

Welcome to the documentation for the PB-[S]AM software suite! The theory underlying this code can is presented in [LoHe06], [YaHe10], [YaHe13]

Installation

To install the software suite, first clone the github repository:

$ git clone https://github.com/davas301/pb_solvers.git

Next, navigate to the pb_solvers directory and follow the instructions below:

$ mkdir build
$ cd build
$ cmake ..
$ make pbam pbsam

This will make executables for pbam and pbsam. Both executables can then be found in ./build/bin/

Running

To run the programs, simply execute the following on the command line:

For PB-AM

$ ./build/bin/pbam <input_file>

For PB-SAM

$ ./build/bin/pbsam <input_file>

where <input_file> is a PB-[S]AM input file described in detail in the proceeding sections of this documentation