Skip to content

Latest commit

 

History

History
60 lines (39 loc) · 1.86 KB

introduction.rst

File metadata and controls

60 lines (39 loc) · 1.86 KB
Raw

Introduction

Basil is a modular readout framework intended to allow simple and fast data acquisition systems (DAQ) design. It consists of different hardware components, FPGA firmware modulus and a Python based control software.

Features

Firmware:
Software:
  • layer structure following hardware
  • generation based on yaml file
  • register abstract layer (RAL)
  • simulator interface allows software test against simulated RTL (thanks to cocotb )

Installation

From host folder run:

python setup.py install

or

pip install -e "git+https://github.com/SiLab-Bonn/basil.git#egg=basil&subdirectory=host"

Simulation

Thank to Chris Higgs basil has a simulation interface (SiSim) with allow communication with simulator as if talking to real hardware.

To make simulation one need:
  • verilog simulator (ex. Icarus )
  • cocotb library
  • set interface type to SiSim

Basil unit tests make extensive use of this feature. See tests folder.

License

If not stated otherwise.

Host Software:
The host software is distributed under the BSD 3-Clause (“BSD New” or “BSD Simplified”) License.
FPGA Firmware:
The FPGA software is distributed under the GNU Lesser General Public License, version 3.0 (LGPLv3).