circuit 1.0.0

Minimal native Python library for building and working with logical circuits.

Minimal native Python library for building and working with logical circuits.

Package Installation and Usage

The package is available on PyPI:

python -m pip install circuit

The library can be imported in the usual way:

import circuit
from circuit import *

Examples

This library make it possible to programmatically construct logical circuits consisting of interconnected logic gates. The functions corresponding to individual logic gates are represented using the logical library. In the example below, a simple conjunction circuit is constructed, and its input and output gates (corresponding to the logical unary identity function) are created and designated as such:

>>> from circuit import circuit, op
>>> c = circuit()
>>> g0 = c.gate(op.id_, is_input=True)
>>> g1 = c.gate(op.id_, is_input=True)
>>> g2 = c.gate(op.and_, [g0, g1])
>>> g3 = c.gate(op.id_, [g2], is_output=True)
>>> c.count() # Number of gates in the circuit.
4

The circuit accepts two input bits (represented as integers) and can be evaluated on any list of two bits using the evaluate method. The result is a bit vector that includes one bit for each output gate:

>>> c.evaluate([0, 1])
[0]
>>> [list(c.evaluate(bs)) for bs in [[0, 0], [0, 1], [1, 0], [1, 1]]]
[[0], [0], [0], [1]]

Note that the order of the output bits corresponds to the order in which the output gates were originally introduced using the gate method. It is possible to specify the signature of a circuit (i.e., the organization of input gates and output gates into distinct bit vectors of specific lengths) at the time the circuit object is created:

>>> from circuit import signature
>>> c = circuit(signature([2], [1]))
>>> g0 = c.gate(op.id_, is_input=True)
>>> g1 = c.gate(op.id_, is_input=True)
>>> g2 = c.gate(op.not_, [g0])
>>> g3 = c.gate(op.not_, [g1])
>>> g4 = c.gate(op.xor_, [g2, g3])
>>> g5 = c.gate(op.not_, [g4])
>>> g6 = c.gate(op.id_, [g4], is_output=True)
>>> [list(c.evaluate([bs])) for bs in [[0, 0], [0, 1], [1, 0], [1, 1]]]
[[[0]], [[1]], [[1]], [[0]]]

It is also possible to remove all internal gates from which an output gate cannot be reached (such as g5 in the example above). Doing so does not change the order of the input gates or the order of the output gates:

>>> c.count()
7
>>> c.prune_and_topological_sort_stable()
>>> c.count()
6

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 pytest (see setup.cfg for configuration details):

python -m pip install pytest pytest-cov
python -m pytest

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

python circuit/circuit.py -v

Style conventions are enforced using Pylint:

python -m pip install pylint
python -m pylint circuit

Contributions

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

Versioning

Beginning with version 0.2.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.

Publishing

This library can be published as a package on PyPI by a package maintainer. Install the wheel package, remove any old build/distribution files, and package the source into a distribution archive:

python -m pip install wheel
rm -rf dist *.egg-info
python setup.py sdist bdist_wheel

Next, install the twine package and upload the package distribution archive to PyPI:

python -m pip install twine
python -m twine upload dist/*