pyproject.toml and package

This commit is contained in:
G gael 2025-09-23 15:15:02 -04:00
parent 2cdbefb4be
commit 44dfd22a8a
6 changed files with 103 additions and 0 deletions

53
README.md Normal file
View File

@ -0,0 +1,53 @@
# Gain-Viz
![Python](https://img.shields.io/badge/python-3.8%2B-blue)
![Flask](https://img.shields.io/badge/flask-2.x-orange)
![License](https://img.shields.io/badge/license-MIT-green)
**Gain-Viz** is an interactive SDR (Software Defined Radio) web application that lets you **adjust transmitter/receiver gains** and **visualize the effects in real time**.
---
## Features
- Adjust **USRP Tx/Rx** and **SCM Tx/Rx** gains dynamically.
- Real-time **time-domain IQ visualization**.
- Real-time **spectrum analysis** with fast refresh.
- Automatically maintains last signal if no new data arrives.
- Web-based interface using **Flask**.
- Responsive design for desktop and tablet use.
---
## Installation
Make sure you have **Python 3.8+** installed.
1. Clone the repository:
```bash
git clone https://github.com/yourusername/gain-viz.git
cd gain-viz ```
2. Build and install
```bash
pip install --upgrade build
python -m build
pip install dist/gain_viz-0.1.0-py3-none-any.whl
```
## Usage
Run the application
```bash
gain-viz
```
Open your browser at http://localhost:5000
- Toggle the gain switches to enable input fields.
- Enter new gain values and press Update Gains.
- Observe the effect on the time-domain IQ plot and spectrum.

0
gain-viz/static/plot.png Normal file
View File

50
pyproject.toml Normal file
View File

@ -0,0 +1,50 @@
[build-system]
requires = ["setuptools>=61.0"]
build-backend = "setuptools.build_meta"
[project]
name = "gain-viz"
version = "0.1.0"
description = "Interactive srsRAN_Project gnb gain control and spectrum visualization tool"
authors = [
{ name = "Qoherent Inc.", email = "info@qoherent.ai" }
]
maintainers = [
{ name = "Gael Kamga", email = "gael@qoherent.ai" },
{ name = "Ashkan Beigi", email = "ash@qoherent.ai" },
]
keywords = [
"radio",
"rf",
"sdr",
"software-defined radio",
"5G",
"gnb",
"gNodeB",
"srsRAN_Project",
"SCM",
"SignalCraft Conditioning Mpdule",
"USRP"
]
readme = "README.md"
requires-python = ">=3.8"
dependencies = [
"flask",
"matplotlib",
"numpy",
"pyzmq",
"pyserial"
]
[project.scripts]
gain-viz = "gain-viz.app:main"
[tool.setuptools.packages.find]
where = ["."]
include = ["gain-viz*"]
[tool.setuptools.package-data]
"gain-viz" = ["templates/*", "static/*"]