Metadata-Version: 2.4
Name: pycde
Version: 0.12.1
Summary: Python CIRCT Design Entry
Author-email: John Demme <John.Demme@microsoft.com>
Project-URL: Homepage, https://circt.llvm.org/docs/PyCDE/
Project-URL: Changelog, https://github.com/llvm/circt/blob/main/frontends/PyCDE/CHANGELOG.md
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: numpy
Requires-Dist: executing

# Python CIRCT Design Entry (PyCDE)

PyCDE is a Python API for designing hardware with
[CIRCT](https://circt.llvm.org/), the Circuit IR Compilers and Tools project.
It provides Python syntax for constructing hardware modules, connecting typed
signals, and generating SystemVerilog using CIRCT's compiler infrastructure.

## Installation

PyCDE requires Python 3.10 or newer.

```sh
pip install pycde
```

## Getting started

See the [PyCDE documentation](https://circt.llvm.org/docs/PyCDE/) for a
hello-world example, and the
[basics guide](https://circt.llvm.org/docs/PyCDE/basics/) for modules, signals,
types, and interoperability with existing hardware.

For building from source, see the
[compilation guide](https://circt.llvm.org/docs/PyCDE/compiling/).
PyCDE is developed as part of the
[CIRCT repository](https://github.com/llvm/circt/tree/main/frontends/PyCDE).
