genesispy

Python port of the Genesis2 Chip Generator (see https://github.com/StanfordVLSI/Genesis2). Replaces the Perl runtime with a pure-Python implementation while keeping the template hierarchy (now .vpy / .svpy). Configuration is JSON; legacy Genesis2 .xml configs convert via the bundled genesispy-xml2json helper.

Editor support

Filetype detection and syntax highlighting for .vpy / .svpy / .gvpy files is available from the genesis-editors repository (Vim/Neovim, Emacs, VS Code). Install each per its own README.

Install

From PyPI

pip install genesispy

Installs the genesispy, gvpy, genesispy-vp2vpy, genesispy-xml2json, genesispy-json2xml and genesispy-jinja2j2 commands. There are no mandatory dependencies; three optional extras:

pip install 'genesispy[xml]'        # lxml: pretty-printed genesispy-json2xml
pip install 'genesispy[color]'      # colorama: coloured diagnostics
pip install 'genesispy[import-j2]'  # jinja2: required by genesispy-jinja2j2

From a checkout, with pip

pip install -e .
# or
pip install --target /path/to/install-dir .

For developers: from a checkout, without pip -- use bin/ launchers

The repo ships shell launchers in bin/ (bin/genesispy, bin/gvpy) that set PYTHONPATH to the sibling src/ and exec python3 -m genesispy.cli. No build step, no pip -- just run from a checkout:

./bin/genesispy --input top.vpy --top top --json-cfg config.json

To "install" to a destination, copy bin/ and src/ together (the launchers resolve src/ as ../src relative to their own directory):

DEST=/path/to/install-dir
mkdir -p "$DEST"
cp -a bin src "$DEST/"
export PATH="$DEST/bin:$PATH"

Tests

Against the in-tree source, no install required:

PYTHONPATH=src pytest tests/

Against an installed copy (pip install -e . or pip install genesispy):

pytest tests/

Documentation

Each entry links to the rendered copy on GitHub; the local link resolves in a source checkout.

• doc/user-guide.md (local) -- .vpy syntax, walkthrough, CLI reference for genesispy and gvpy, migrating from Genesis2.
• doc/code-structure.md (local) -- pipeline, dedup, control flags.
• doc/interfaces.md (local) -- module-boundary interfaces.
• doc/genesis2-incompatibilities.md (local) -- non-obvious behavior differences from Perl Genesis2.
• CHANGELOG.md (local) -- notable changes per version.