Metadata-Version: 2.4
Name: XiBIF
Version: 5.0.2
Summary: XiBIF – Xilinx Board Interface
Author-email: Janik Witzig <janik.witzig@ost.ch>, Lukas Leuenberger <lukas.leuenberger@ost.ch>
Project-URL: Homepage, https://xibif.ch
Project-URL: Repository, https://gitlab.com/xibif/xibif
Project-URL: Issues, https://gitlab.com/xibif/xibif/-/issues
Project-URL: Documentation, https://docs.xibif.ch
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: colorama
Requires-Dist: loguru
Requires-Dist: pydantic
Requires-Dist: pydantic_extra_types
Requires-Dist: psutil
Requires-Dist: corsair==1.0.4
Requires-Dist: GitPython
Requires-Dist: jinja2
Requires-Dist: reportlab
Requires-Dist: xibif-connection
Provides-Extra: testbench
Requires-Dist: hdltbgen; extra == "testbench"
Provides-Extra: simulation
Requires-Dist: vunit-hdl>=5.0.0.dev6; extra == "simulation"
Provides-Extra: all
Requires-Dist: xibif[simulation,testbench]; extra == "all"
Dynamic: license-file

# XiBIF

<p align="center">
  <img src="doc/logo/export/xibif_logo.svg" alt="XiBIF Logo" width="300">
</p>

XiBIF is a command line tool and a software package that aims to facilitate FPGA design. It reduces the barrier of entry for hardware design by simplifying the processes of interfacing with the FPGA from a host.

### Features
- Streamlined FPGA design flow in command-line
- Out-of-the-box communication to hardware over Ethernet
- Bitstream flashing over Ethernet
- Easy register and driver generation from configuration file
- Direct AXI Access from the Python API
- Debugging Information over UART

### Block Diagram

![xibif_block_diagram](doc/source/img/xibif-block-diagram.drawio.png)

# Installation

To install the XiBIF toolkit, use the following command:

```bash
pip install xibif 
```

Optional command dependencies:

- `xibif testbench` requires the optional package group `testbench`
- `xibif simulation` requires the optional package group `simulation`

Install options:

```bash
# only testbench support
pip install xibif[testbench] 

# only simulation support
pip install xibif[simulation]

# install all optional command dependencies
pip install xibif[all]
```

***Try your first FPGA build***

```bash
xibif new --name MyFirstProject --path SomePathYouLike --xilinx /c/Xilinx --version 2024.2 --board zedboard
```

### Install a Development build
Feeling adventurous? Install a development build of xibif using this command!
```bash
pip install --pre xibif --index-url https://gitlab.com/api/v4/groups/126602301/-/packages/pypi/simple
```

# Creators, Contributors & Complainers
Like any project, there would be no XiBIF without the people who (try) to keep it running. Thanks for your contributions and patience!
- Lukas Leuenberger
- Janik Witzig
- Dorian Amiet
- Flavio Peter
- Simon Walker
- Eric Walser
- Jan Wendler
- Roman Willi
- Flavio Grepper
- Roy Seitz
