circuitry 0.3.0

Embedded domain-specific combinator library for assembling abstract definitions of logic circuits.

Embedded domain-specific combinator library for assembling abstract definitions of logic circuits.

Purpose

This embedded domain-specific language (DSL) makes it possible to write an algorithm in Python that operates over bit vectors, and then to interpret that algorithm implementation as a circuit definition in order to synthesize a logic circuit represented using the circuit library. Additional background information and examples can be found in a relevant report.

Package Installation and Usage

The package is available on PyPI:

python -m pip install circuitry

The library can be imported in the usual ways:

import circuitry
from circuitry import *

Documentation

The documentation can be generated automatically from the source files using Sphinx:

cd docs
python -m pip install -r requirements.txt
sphinx-apidoc -f -E --templatedir=_templates -o _source .. ../setup.py && make html

Testing and Conventions

All unit tests are executed and their coverage is measured when using nose (see setup.cfg for configution details):

python -m pip install nose coverage
nosetests --cover-erase

Alternatively, all unit tests are included in the module itself and can be executed using doctest:

python circuitry/circuitry.py -v

Style conventions are enforced using Pylint:

python -m pip install pylint
pylint circuitry

Contributions

In order to contribute to the source code, open an issue or submit a pull request on the GitHub page for this library.

Versioning

Beginning with version 0.1.0, the version number format for this library and the changes to the library associated with version number increments conform with Semantic Versioning 2.0.0.