|
| 1 | +[](https://github.com/ktok07b6/polyphony/actions/workflows/test.yml) |
| 2 | +[](https://badge.fury.io/py/polyphony) |
| 3 | +[](https://github.com/ktok07b6/polyphony) |
| 4 | +[](https://github.com/ktok07b6/polyphony/blob/main/LICENSE) |
| 5 | + |
| 6 | +# polyphony |
| 7 | + |
| 8 | +Polyphony is a Python-based High-Level Synthesis (HLS) compiler that generates synthesizable Verilog HDL from a Python subset. |
| 9 | + |
| 10 | +## Requirements |
| 11 | + |
| 12 | +- Python >= 3.12 |
| 13 | +- Icarus Verilog (for HDL simulation) |
| 14 | + |
| 15 | +## Installation |
| 16 | + |
| 17 | +```bash |
| 18 | +pip install polyphony |
| 19 | +``` |
| 20 | + |
| 21 | +## Usage |
| 22 | + |
| 23 | +``` |
| 24 | +polyphony [-h] [-o FILE] [-d DIR] [-c CONFIG] [-v] [-D] [-hd] [-q] |
| 25 | + [-vd] [-vm] [-op PREFIX] [-t TARGETS [TARGETS ...]] [-V] |
| 26 | + source |
| 27 | +``` |
| 28 | + |
| 29 | +| Option | Description | |
| 30 | +|--------|-------------| |
| 31 | +| `-o FILE, --output FILE` | output filename (default is "polyphony_out") | |
| 32 | +| `-d DIR, --dir DIR` | output directory | |
| 33 | +| `-c CONFIG, --config CONFIG` | set configuration (JSON literal or file) | |
| 34 | +| `-v, --verbose` | verbose output | |
| 35 | +| `-D, --debug` | enable debug mode | |
| 36 | +| `-hd, --hdl_debug` | enable HDL debug mode | |
| 37 | +| `-q, --quiet` | suppress warning/error messages | |
| 38 | +| `-vd, --verilog_dump` | output VCD file in testbench | |
| 39 | +| `-vm, --verilog_monitor` | enable $monitor in testbench | |
| 40 | +| `-V, --version` | print the Polyphony version number | |
| 41 | + |
| 42 | +## Examples |
| 43 | + |
| 44 | +See [tests](https://github.com/ktok07b6/polyphony/tree/main/tests) |
| 45 | + |
| 46 | +## License |
| 47 | + |
| 48 | +MIT License. See [LICENSE](LICENSE) for details. |
0 commit comments