.. annie documentation master file, created by
   sphinx-quickstart on Sun Nov  5 19:50:01 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Annie simulator framework
=========================

The annie package is a high-fidelity Chandra Aspect Camera Assembly (ACA) star tracking
simulator developed with the goal of operational use within ACA load review and weekly
planning, and PEA background subtraction patch algorithm development.

The annie package is designed to reproduce the key behavior of OBC Pointing Control and
Aspect Determination (PCAD) and ACA subsystems. The package can be used to: simulate
hardware (CCD characteristics, CCD dark current background), identify or reject stars,
count glitches due to bad flags or lost stars, track stars (predict next image readout
window location, and predict state transitions), update attitude based on a combination of
star data and simple PCAD attitude law.

Annie requires the Ska runtime environment and at least Python 3.6 to run.

.. toctree::
   :maxdepth: 2

   design
   tutorial
   api