README.md

Synergistic Image Reconstruction Framework

This software is the main output of SyneRBI, the Collaborative Computational Platform for Synergistic Reconstruction for Biomedical Imaging (formerly CCP PETMR).

Please start with our latest User's Guide. See our Wiki page for installation instructions.

You can also download a VM with SIRF and related software preinstalled.

Where is everything installed?

SIRF largely follows the usual directory structure with some minor tweaks. When using the default options when building SIRF, you will get (most of the) following, depending what was found/built:

<install-dir>/
    bin/            # executables
    lib/            # libraries
    python/         # Python files
    matlab/         # MATLAB files
    share/SIRF-V.v/ # versioned location (e.g. SIRF-3.0)
       doc/         # doxumentation
          doxygen/  # C++ documentation files generated by doxygen
          examples/ # example scripts
       data/        # data used in example scripts