https://github.com/devbisme/myhdlpeek

Monitor and display signal waveforms from your MyHDL/nMigen digital design in a Jupyter notebook.
https://github.com/devbisme/myhdlpeek

Last synced: 10 months ago
JSON representation

Monitor and display signal waveforms from your MyHDL/nMigen digital design in a Jupyter notebook.

• Host: GitHub
• URL: https://github.com/devbisme/myhdlpeek
• Owner: devbisme
• License: mit
• Created: 2017-06-12T01:24:52.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2024-02-01T14:45:45.000Z (over 2 years ago)
• Last Synced: 2025-07-24T17:31:00.287Z (10 months ago)
• Language: Python
• Homepage:
• Size: 9.31 MB
• Stars: 40
• Watchers: 2
• Forks: 9
• Open Issues: 3
• Metadata Files:
  • Readme: README.rst
  • Changelog: HISTORY.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE
  • Authors: AUTHORS.rst

Awesome Lists containing this project

README

          
===============================

myhdlpeek

===============================

.. image:: https://img.shields.io/pypi/v/myhdlpeek.svg

        :target: https://pypi.python.org/pypi/myhdlpeek

A module that lets you monitor signals in a 

`MyHDL `_ or `Amaranth `_

digital system simulation and display them as waveforms in a Jupyter notebook.

Make changes to your digital design and see the results reflected immediately in the

waveforms of your notebook!

`myhdlpeek` implements a `Peeker` object that monitors a signal and records

the time and value when it changes.

Just add multiple Peekers where you want to monitor something (even at sub-levels

of a hierarchical design) and then view the collected timing waveforms

with a single command.

You can also select which signals are shown, set the beginning and

ending times of the display, and much more.

`[This Jupyter notebook] `_ 

shows how to use myhdlpeek.

|

* Free software: MIT license

* Documentation: http://devbisme.github.io/myhdlpeek

Features

--------

* Captures timing traces of signals in a MyHDL/Amaranth digital design.

* Works at the top-level and sub-levels of a hierarchical design.

* All signals or a selected subset can be displayed.

* The beginning and ending points of the waveform display can be set.

* Timing marks can be turned on or off.

* Titles and captions are supported.

* Tabular output in Jupyter and console.

* Trigger expressions allow the display of a selected portion of traces.