Python bindings for the LimeDriver
Go to file
Kumi bee60673fb
Add README with setup and usage instructions for
Python bindings

Introduce a comprehensive README for the Python bindings project of the
LimeDriver library. The README includes required dependencies for both
Debian/Ubuntu and Arch Linux systems, and a step-by-step guide to
creating a virtual environment, installing the package using pip, and a
basic usage example with Python code demonstrating how to interact with
the LimeDriver library. Documentation facilitates easier onboarding and
usage of the Python bindings for new users.
2024-02-10 14:56:32 +01:00
.github/workflows Update Ubuntu workflow to include liblimesuite-dev 2024-02-09 15:16:54 +01:00
extern Updated limedriver to latest commit 2024-02-10 14:55:59 +01:00
src/limedriver Fixed main branch 2024-02-09 13:47:11 +01:00
.gitignore Enhance package build process 2024-02-08 15:19:25 +01:00
.gitmodules Added limedriver as submodule. 2024-02-07 16:40:02 +01:00
LICENSE Initial project config and implement build process 2024-02-07 18:18:44 +01:00
MANIFEST.in Enhance package build process 2024-02-08 15:19:25 +01:00
pyproject.toml Updated limedriver subproject and Python 2024-02-09 12:41:57 +01:00
README.md Add README with setup and usage instructions for 2024-02-10 14:56:32 +01:00
setup.py Removed static HDF5 library linkage in build 2024-02-09 15:43:27 +01:00

Python Bindings for LimeDriver

This is a Python package for the LimeDriver library.

Dependencies

To build the Python bindings, you will need to have the dependencies for LimeDriver installed, as well as the Python development headers.

Debian/Ubuntu

sudo apt-get install g++ cmake libhdf5-dev liblimesuite-dev python3-dev python3-pip python3-venv

Arch Linux

sudo pacman -S gcc cmake hdf5 limesuite python python-pip

Installation

It is recommended to install the Python bindings in a virtual environment. To create a new virtual environment, run the following commands:

python3 -m venv venv
source venv/bin/activate

The Python bindings can be installed using pip:

pip install .

Usage

The Python bindings provide a high-level interface to the LimeDriver library:

# Import the LimeDriver module
import limedriver

# Set the number of pulses to generate
Npulses = 1000

# Create a new PyLimeConfig object
config = limedriver.PyLimeConfig(Npulses)

# Modify the config as needed
config.srate = 1e6

# Execute the config on the LimeSDR
config.run()

# Get the path to the output file
filename = config.get_path()

# Use the built-in HDF5 reader to read the output file
data = limedriver.hdf_reader.HDF(filename)
data.print_params()