Skip to main content

Converts a subset of python generator functions into synthesizable sequential SystemVerilog

Project description

Open In Colab pypi py versions pypi downloads pytest

python2verilog

  • This tool facilitates the conversion of select Python functions (including generators!) into synthesizable sequential SystemVerilog
  • Ideal for quickly translating higher-level "CPU code" into hardware descriptions for use on FPGAs, without needing to interface with or including a CPU in the design
  • Testbenches can be automatically generated if the user uses the function within their Python code or provides explicit test cases
from python2verilog import verilogify

@verilogify
def hrange(base, limit, step):
    i = base
    while i < limit:
        yield i
        i += step
print(list(hrange(0, 10, 3)))

A live transpile demo can be found here.

Specifications

Some constrains on Python functions include:

  • Supports only signed integral input/output and operations
  • Must be a pure function

Unsupported Python paradigms include but are not limited to the following:

  • Global (nonlocal) variables, instead declare them within the function with minimal overhead
  • Keyword parameters and default arguments, instead use explicit positional arguments

Usage and Installation

Try it in Google Collab or check out examples/!

python3 -m pip install --upgrade pip

python3 -m pip install python2verilog

Tested Generations

You may find the output of the integration testing as a Github Artifact available for download.

For Developers

To setup pre-commit, run pre-commit install.

Github Issues are used for tracking.

Sphinx is used for the docs. Follow the sphinx workflow to generate a local copy.

Testing

Requirements

For most up-to-date information, refer to the pytest workflow or the packaging workflow.

A Ubuntu environment (WSL2 works too, make sure to have the repo on the Ubuntu partition, as os.mkfifo is used to avoid writing to disk)

Install required python libraries with python3 -m pip install -r tests/requirements.txt

For automatic Verilog simulation and testing, install Icarus Verilog and its dependencies with sudo apt-get install iverilog expected (uses the unbuffer in expected).

The online simulator EDA Playground can be used as a subsitute if you manually copy-paste the module and testbench files to it.

Running Tests

To run tests, use python3 -m pytest.

CLI arguments for test configuration can be found in tests/conftest.py.

Use git clean -dxf to remove gitignored and generated files.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

python2verilog-0.4.2.tar.gz (57.2 kB view details)

Uploaded Source

Built Distribution

python2verilog-0.4.2-py3-none-any.whl (68.4 kB view details)

Uploaded Python 3

File details

Details for the file python2verilog-0.4.2.tar.gz.

File metadata

  • Download URL: python2verilog-0.4.2.tar.gz
  • Upload date:
  • Size: 57.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for python2verilog-0.4.2.tar.gz
Algorithm Hash digest
SHA256 0d369f5c5c02e99f46013ae2f935a4b7204dab24b55b97016d8b295d13286b66
MD5 de2634a65dc65c22ed04133484e5399e
BLAKE2b-256 1d2c0c2a8c8f93026b9f67e99fa46ca41c4c11475c84e0d6ab2096f9bd28a9b9

See more details on using hashes here.

File details

Details for the file python2verilog-0.4.2-py3-none-any.whl.

File metadata

File hashes

Hashes for python2verilog-0.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1526fa2e726a9d7eff278620635e37300d105ade67f28f43344c3a4fd120c6b6
MD5 2339dcf9017e0210b417200a87daf14a
BLAKE2b-256 d6d5721b2f37fb38a2f838d861c300678e431d6ed744c2fd696cb08f01da2939

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page