Installing
===========
The krypton project is currently under development.  There are
no releases for the project (5-Jan-2013) and the project is 
under development.

USE AT YOUR OWN RISK

To use a current
development snapshot the project needs to be checked out 
from the bitbucket repository using mercurial.

   >> hg clone https://bitbucket.org/cfelton/krypton
  
After the project has been retrieved it can be installed into
the Python environment:

   >> python setup.py install

In the kr/test directory is a collection of tests that can be
run with the `nose`_ test framework.  Before running the tests
see the next section and make sure dependencies are installed.

   >> cd kr/test
   >> nosetests

As mentioned in the intro, most of the tests are intended to 
be run with pypy (else they will be really slow).  The above
*quick test* doesn't address setting up an environment that 
can run pypy and cpython.  Ideally, there would be a small 
set of tests that would run in a reasonable amount of time 
with cpython that can be run.


Dependencies
=============
The following is a list of dependencies for the krypton project.

  * `MyHDL`_.  MyHDL is used for the core simulation engine.
  * `nose`_.  The nose.tools are used for verification.

Optional (kr.blocks verification framework and kr.signal tools)

  * `networkx`_.  Networkx is used to create graphics of the 
    system created.
  * `matplotlib`_.  Used to generate plots.

.. _MyHDL : http://www.myhdl.org
.. _nose : https://nose.readthedocs.org/en/latest/
.. _networkx : http://networkx.lanl.gov/
.. _matplotlib : http://matplotlib.org/