.. rst-class:: break_before



This chapter serves as documentation for the XiBIF package.


XiBIF API
=========

.. code-block:: python

    from xibif import XibifAPI

to import ``XibifAPI`` into your Python script.


api.init
--------
The ``init`` API lets you create the foundation for a XiBIF project. It creates the folder structure and the ``.xibif`` project file.

**Commands**

.. automodule:: xibif.api.init
    :members:
    :undoc-members:

api.setup
---------
The ``setup`` API populates an initialized XiBIF workspace with a valid project file.

.. warning::
    Some of the APIs depend on files being present that are created through different API calls.

**Commands**

.. automodule:: xibif.api.setup
    :members:
    :undoc-members:


api.register
------------
The ``register`` API interfaces with ``Corsair`` and let's you generate project-specific register files.

**Commands**

.. automodule:: xibif.api.register
    :members:
    :undoc-members:

api.build
---------
The ``build`` API allows you to build your project in Vivado and Vitis.

**Commands**

.. automodule:: xibif.api.build
    :members:
    :undoc-members:

api.flash
---------
The ``flash`` API allows you to flash an FPGA.

.. warning::
    The flashed bitstream is not persistent.

**Commands**

.. automodule:: xibif.api.flash
    :members:
    :undoc-members:

api.simulate
------------
The ``simulate`` API allows you to simulate your design in vunit.

**Commands**

.. automodule:: xibif.api.simulate
    :members:
    :undoc-members:

api.shell
---------
The ``shell`` API allows you to connect to a XiBIF board in an interactive shell.

**Commands**

.. automodule:: xibif.api.shell
    :members:
    :undoc-members:
    :exclude-members: XibifShell

api.testbench
-------------
The ``testbench`` API allows you to generate testbenches for your design.

**Commands**

.. automodule:: xibif.api.testbench
    :members:
    :undoc-members:

api.upgrade
-----------
The ``upgrade`` API allows you to upgrade the project to the latest version of XiBIF.

**Commands**

.. automodule:: xibif.api.upgrade
    :members:
    :undoc-members: