myhdlpeek 0.0.3

===============================
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 <http://myhdl.org>`_ 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 set other options.

Below are some examples of Jupyter notebooks using myhdlpeek.
Unfortunately, the Github Notebook viewer doesn't render the waveform displays
so you'll have to download and run the notebooks locally or click on the static HTML
link to see what myhdlpeek can do.

* Simple multiplexer: `[Notebook] <https://github.com/xesscorp/myhdlpeek/blob/master/examples/peeker_simple_mux.ipynb>`_ `[HTML] <http://www.xess.com/static/media/pages/peeker_simple_mux.html>`_
* Hierarchical adder: `[Notebook] <https://github.com/xesscorp/myhdlpeek/blob/master/examples/peeker_hier_add.ipynb>`_ `[HTML] <http://www.xess.com/static/media/pages/peeker_hier_add.html>`_
* Other Peeker options: `[Notebook] <https://github.com/xesscorp/myhdlpeek/blob/master/examples/peeker_options.ipynb>`_ `[HTML] <http://www.xess.com/static/media/pages/peeker_options.html>`_

|

* Free software: MIT license
* Documentation: http://xesscorp.github.io/myhdlpeek

Features
--------

* Captures timing traces of signals in a MyHDL 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.




History
-------

0.0.3 (2017-06-23)
______________________

* Made compatible with Python 2.7.
* Added tabular output of Peeker data traces.

0.0.2 (2017-06-12)
______________________

* Added static HTML pages to display what myhdlpeek can do. (Notebook rendering with nbconvert won't show waveforms.)

0.0.1 (2017-06-10)
______________________

* First release on PyPI.