Skip to content

Latest commit

 

History

History
34 lines (24 loc) · 1.59 KB

README.md

File metadata and controls

34 lines (24 loc) · 1.59 KB
Raw

Iguana: Implementation Guardian of Analysis Algorithms

The primary goal of Iguana is to preserve and centralize common analysis algorithms, such as fiducial cuts, momentum corrections, and kinematics reconstruction.

Support is focused on HIPO data for CLAS12, but extending support to other data formats (experiments) may be feasible.

Iguana is not a framework for reading data, rather it is a set of algorithms to mutate the data. For HIPO data, algorithms mutate banks. See the API documentation for the list of available algorithms.

Caution

Iguana is still in the early stages of development. Please see the issues page for known issues and development plans.

Documentation

For Users

  1. Iguana User's Guide
  2. Setup Guide - how to build and install Iguana
  3. Configuring the Algorithms
  4. Troubleshooting

Language Bindings

  1. Python
  2. All others: see the Iguana User's guide

For Developers

  1. Design Notes
  2. Developing a new Algorithm
  3. Algorithm Tests and Validators
  4. Repository Maintenance
  5. Building for cvmfs or ifarm

Status

  1. Coverage Report