Skip to main content
Help us improve Python packaging – donate today!

Hardware Design Framework based on python and MyHDL

Project Description

pihdf: Python Hardware Design Framework based on MyHDL

.. image::

A very preliminary documentation (work-in-progress) is available at:

Install ``pihdf`` using pip

You can install the latest release of ``pihdf`` from pypi: ::

$ sudo pip install pihdf

**Note:** If you do not have ``pip`` installed: ::

$ sudo apt-get install python-pip python-dev build-essential
$ sudo pip install --upgrade pip

Install ``pihdf`` from source

If you plan to contribute to ``pihdf``, then install it from source: ::

$ git clone
$ cd pihdf
$ sudo python develop

Option *develop* installs ``pyhdf`` in *editable* mode.
This is very convenient because your changes are immediately reflected into the installed ``pihdf`` package.
This means that you do not need to re-install ``pihdf`` in order your changes to take effect.

Dependences on Python packages

``pihdf`` requires the following python packages: **myhdl, myhdl_lib, simplejson, coverage, nose**.
These packages will be installed during the installation of ``pihdf`` if not present on your system.

**Note:** These packages will **not** be un-installed if you un-install ``pyhdf``.

Co-simulation, waveform and dotty viewers

For co-simulations, ``pihdf`` uses the **Icarus iverilog** simulator. **GTKWave** is the waveform viewer used in ``pihdf``. For structured designs, ``pihdf`` generates also the design topology (i.e., HW modules interconnections) as a ``.dot`` file. To viasualize it, you can use the ``xdot`` program. Install all programs by executing: ::

$ sudo apt-get install iverilog gtkwave xdot

Create ``myhdl.vpi``

For co-simuations, myhdl uses a ``.vpi`` interface. To create the ``myhdl.vpi`` file used with **Icarus**, you need the source of ``myhdl``: ::

$ git clone
$ make -C myhdl/cosimulation/icarus
$ sudo mkdir /.pihdf
$ sudo cp myhdl/cosimulation/icarus/myhdl.vpi /.pihdf

**Note:** ``pihdf`` expects file ``myhdl.vpi`` to be in folder ``/.pihdf``


Un-installing ``pihdf`` (should you decide to do so) is easy. Depending on how you installed it, you can:

Un-install ``pihdf`` using ``pip``: ::

$ sudo pip uninstall pihdf

Or, un-install ``pihdf`` if installed from source: ::

$ cd pihdf
$ sudo python develop --uninstall

To remove the command-line tool ``module`` from its location: ::

$ which module | xargs sudo rm


The command-line tool ``module`` makes use of the very convenient package ``docopt`` (, which is copied in the ``pihdf`` repository.

Release history Release notifications

This version
History Node


History Node


History Node


History Node


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
pihdf-0.1.3.tar.gz (49.4 kB) Copy SHA256 hash SHA256 Source None Apr 30, 2016

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page