B-ASIC - Better ASIC Toolbox

B-ASIC is an ASIC toolbox for Python 3 that simplifies circuit design and optimization.

The latest documentation can be viewed at: https://da.gitlab-pages.liu.se/B-ASIC/index.html

Development

How to build and debug the library during development.

Prerequisites

The following packages are required in order to build the library:

• Python 3.10+
• Python dependencies (install with pip install -r requirements.txt or they will be installed as part of the installation process):
  • Graphviz
  • Matplotlib
  • NumPy
  • QtPy
  • setuptools_scm
  • NetworkX
  • QtAwesome
• Qt 6, with Python bindings, one of:
  • pyqt6
  • pyside6

To build a binary distribution, the following additional packages are required:

• Python:
  • wheel

To run the test suite, the following additional packages are required:

• Python (install with pip install -r requirements_test.txt):
  • pytest
  • pytest-qt
  • pytest-mpl
  • pytest-cov (for testing with coverage)
  • pytest-xvfb (for testing without showing windows on Linux, you will also need to install xvfb)
  • pytest-xdist (for parallel testing)

To generate the documentation, the following additional packages are required:

• Python (install with pip install -r requirements_doc.txt):
  • Sphinx
  • Furo
  • numpydoc
  • Sphinx-Gallery
  • mplsignal
  • sphinx-copybutton

Using setuptools to create a package

How to create a package using setuptools that can be installed using pip.

Setup (Binary distribution)

In B-ASIC:

python3 setup.py bdist_wheel

The output gets written to B-ASIC/dist/b_asic-<version>-<python_tag>-<abi_tag>-<platform_tag>.whl.

Setup (Source distribution)

In B-ASIC:

python3 setup.py sdist

The output gets written to B-ASIC/dist/b-asic-<version>.tar.gz.

Installation (Binary distribution)

In B-ASIC/dist:

pip install b_asic-<version>-<python_tag>-<abi_tag>-<platform_tag>.whl

Installation (Source distribution)

In B-ASIC/dist:

pip install b-asic-<version>.tar.gz

Running tests

How to run the tests using pytest in a virtual environment.

Linux/OS X

In B-ASIC:

python3 -m venv env
source env/bin/activate
pip install .
pytest

Windows

In B-ASIC (as admin):

python3 -m venv env
.\env\Scripts\activate.bat
pip install .
pytest

Test with coverage

pytest --cov=b_asic --cov-report=html test

Generate new baseline images for the tests

In B-ASIC:

pytest      # The image comparison tests will fail
cp -a result_images/* test/baseline_images/

Generating documentation

sphinx-build -b html docs_sphinx docs_sphinx/_build

or in B-ASIC/docs_sphinx:

make html

The output gets written to B-ASIC/docs_sphinx/_build.

Usage

How to build and use the library as a user.

Installation

pip install .

Importing

python3
>>> import b_asic as asic
>>> help(asic)

License

B-ASIC is distributed under the MIT license. See the included LICENSE file for more information.