hackfin/myhdl_testing repository overview

⁠MyHDL 0.11-yosys

This is simply left as a demo of for direct hardware synthesis from a Jupyter Notebook browser based development environment. To run, hit binder button below.

Note The further development of this branch is suspended for the time being. Proof of concept only!

Next generation evolution is expected to take place on a 'v2we' kernel. Sneak peek⁠

See also 'Docker support' below. This specific branch builds a Binder environment from the provided Dockerfile.

⁠What is MyHDL?

MyHDL is a free, open-source package for using Python as a hardware description and verification language.

To find out whether MyHDL can be useful to you, please read:

• http://www.myhdl.org/start/why.html⁠

⁠License

MyHDL is available under the LGPL license. See LICENSE.txt.

⁠Website

The project website is located at http://www.myhdl.org⁠

⁠Documentation

The manual is available on-line:

• http://docs.myhdl.org/en/stable/manual⁠

⁠What's new

To find out what's new in this release, please read:

• http://docs.myhdl.org/en/stable/whatsnew/0.11.html⁠

⁠Installation

It is recommended to install MyHDL (and your project's other dependencies) in a virtualenv.

Installing the latest stable release:

pip install myhdl

To install the development version from github:

pip install -e 'git+https://github.com/myhdl/myhdl#egg=myhdl

To install a local clone of the repository:

pip install -e path/to/dir

To install a specific commit hash, tag or branch from git:

pip install -e 'git+https://github.com/myhdl/myhdl@f696b8#egg=myhdl

You can test the proper installation as follows:

cd myhdl/test/core
py.test

To install co-simulation support:

Go to the directory cosimulation/<platform> for your target platform and following the instructions in the README.txt file.

⁠Docker support

This experimental branch supports continuous integration with Docker. If you want to use a pre-built docker container, you can just run

docker run -it hackfin/myhdl_testing:yosys

on your local Linux system with docker service running, or using the Windows environment (see https://docs.docker.com/docker-for-windows/⁠). You can also run it in the browser, thanks to the docker playground (https://labs.play-with-docker.com⁠).

When inside the running container, this command will check out the default branch of this fork, build and run the conversion tests:

make -f scripts/recipes/myhdl.mk all test

Note: Even though the Docker tests may be marked as failing for the time being, the container is still usable.