.. krypton documentation master file, created by
   sphinx-quickstart on Sun Jul  1 14:52:43 2012.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

krypton (kr)
=============

Noble, colorless, oderless, and tasteless.

The name for this project was inspired by mercurial (i.e. laziness
and lack of creativity by me).  An element from the periodic table 
was chosen for a name: *krypton*.  Th actual Python package name is 
**kr**.  

The project contains a verification framework, mainly for signal 
processing (dsp) FPGA cores.  This package uses `MyHDL`_ to implement
the cores.  Initially, the project is reimplementing the GnuRadio 
USRP HDL completely in Python/`MyHDL`_.  But the project is going 
slightly further and will make each of the DSP modules as generic and 
parameterizable as possible.  It is the goal that the project will 
grow and support many different FPGA DSP systems.

.. _MyHDL : http://www.myhdl.org

.. toctree::
   :maxdepth: 2

   intro
   getting_started
   under_construction
   tutorial

   blocks/blocks.rst
   signal/signal.rst
   cores/cores.rst
   testing/testing.rst



Indices and tables
==================

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