README FILE

ad9xDds
Benoit Dubois
January 7th, 2021


CONTENTS OF THIS FILE
---------------------

* Introduction
* Requirements
* Installation


INTRODUCTION
------------

Ad9xDds is a library dedicated to handle AD9854, AD9912 and AD9915 DDS development board.


REQUIREMENTS
------------

Preferably a Linux system with a Debian distribution (not tested with others OS
nor others distributions). The program requires the folowing packages:
 * Python 3
          $ [sudo] apt-get install python3
 * The firmware loader 'fxload' for ad9912dev board
          $ [sudo] apt-get install fxload

Packages:
 * iopy (with pyusb for AD9912 board)
 * PyQt5 (optional: for Qt signal/slot support)
 * signalslot (optional: for pure Python signal/slot support)
 * pyparallel (optional: for AD9854 board)

'firm_manager' installed (Manage loading of firmware in FX2 device through Udev capabilities).
-> Need support of shell script and Udev.


INSTALLATION
------------

1.1 Install firm_manager
          $ tar xvfz firm_manager.tar.gz
          $ cd firm_manager
          $ sudo sh ./install.sh

1.2 Restart udev service
          $ sudo service udev restart

2. Install ad9xdds
   * PyPi
          $ python3 -m pip install --user ad9xdds

   * From source
          $ python3 -m pip install --user ad9xdds-x.x.tar.gz

