LaurentCabaret / pyVhdl2Sch

pyVhdl2sch is a python based VHDL to (pdf) schematic converter

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

pyVhdl2Sch

pyVhdl2Sch is a documentation generator tool. It takes a VHDL file (.vhd) as an entry and generates a corresponding pdf/svg/ps/png schematic.

pyVhdl2Sch is based on Python and is a rewrite of the QT/Latex based Vhdl2Sch.

How to use

type:

./pyV2S.py myVhdlfile.vhd

pyVhdl2Sch parses your file, find the entity and creates the coresponding schematic based on the Cairo API.

The result is a pdf file with a very narrow bounding box so you can import it in a latex document (for example) easily.

Full usage

  • -v : verbose mode

  • -fgcolor : define contour color (based on https://github.com/vaab/colour)

    • example -fgred or -fg#caf or -fg#cafe42
  • -bgcolor : replace the transparent background by a colored one

  • -ftformat : specify the output format

    • -ftpdf --> pdf
    • -ftpng --> png
    • -ftsvg --> psvg
    • -ftps --> ps
  • -winteger : specify the width of png file

    • -w1000 --> width of png = 1000px

Supported OS

  • Linux
  • Windows (obsolete)
  • MacOs (obsolete)

Requirements

  • python
  • jura font installed (or change font in pdfdrawer.py)
  • cairocffi
  • coulour

Install

Debian like

git clone https://github.com/LaurentCabaret/pyVhdl2Sch.git

in order to install all the dependencies

sh reqs/linux.sh
sh reqs/update_pip_packages

Windows (obsolete)

OSX (obsolete)

  • Install XQuartz from https://xquartz.macosforge.org/landing/
  • brew install cairo
  • brew install pkg-config libffi
  • export PKG_CONFIG_PATH=/usr/local/Cellar/libffi/3.0.13/lib/pkgconfig/
  • pip install -r reqs/requirements.txt
  • python pyVhdl.py yourfile.vhd

How to help

  • Install on windows or MacOs and update the installation instructions

About

pyVhdl2sch is a python based VHDL to (pdf) schematic converter

License:BSD 2-Clause "Simplified" License


Languages

Language:Python 88.2%Language:VHDL 11.5%Language:Shell 0.2%Language:Makefile 0.1%