.. WNI Reflect Array Radar documentation master file, created by
   sphinx-quickstart on Mon Apr 10 13:28:27 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to WNI Reflect Array Radar's documentation!
===================================================

Welcome!  Hopefully this documentation will guide you to using the radar and
understanding how all the software fits together.

High-level view
---------------

From a software perspective, the core of the system is the `MicroZed`_.  It
contains a commercial `Zynq 7020`_, which is an integrated FPGA/ dual-core ARM
processor.  It runs Linux.  The software running on Linux is responsible for
setting the registers in the custom FPGA code, configuring the `AD9361
transceiver`_, and moving the Rx data from the AD9361 to the outside world.
Additionally, the Microzed controls the motor via the `R356 motor controller`_
and the actuator via the `linear actuator control board`_.  The MicroZed pushes
I/Q data to a dedicated processing computer, calculates moment data which can
consumed by another application.

For more information about how all the software bits fit together, check out
the :doc:`software_overview` page.  For usage instructions, see the
:doc:`user_guide`.  If you're actually working on development of the system
itself, see the :doc:`low_level_development`.

For configuring a scan using the high level interface, see
:doc:`scan_configuration`.

Table of Contents
-----------------

.. toctree::
   :maxdepth: 2

   scan_configuration
   software_overview
   output_data_format
   client_program
   user_guide
   updating
   low_level_development
   tagging_pointing_angle
   installing-clients
   system_setup


API reference
-------------

.. toctree::
   :maxdepth: 3

   modules/modules



Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

.. _MicroZed: http://zedboard.org/product/microzed
.. _Zynq 7020: https://www.xilinx.com/products/silicon-devices/soc/zynq-7000.html
.. _AD9361 transceiver: http://www.analog.com/en/products/rf-microwave/integrated-transceivers-transmitters-receivers/wideband-transceivers-ic/ad9361.html#product-overview
.. _R356 motor controller: https://www.linengineering.com/products/drivers-controllers/r356/
.. _linear actuator control board: https://www.actuonix.com/LAC-Board-p/lac.htm