init commit

This commit is contained in:
Ayzen
2026-03-05 14:42:33 +03:00
commit fd4618b20d
964 changed files with 325114 additions and 0 deletions
+22
View File
@@ -0,0 +1,22 @@
# Python App Documentation
## Назначение
Каталог `python_app/docs` содержит техническую документацию по Python-части радарной системы: GUI, orchestration, storage, hardware adapters и эксплуатационные сценарии.
## Карта документов
- `architecture_overview.md`: общая модульная архитектура и границы ответственности.
- `runtime_data_flow.md`: потоки данных от acquisition до отображения и snapshot.
- `gui_architecture.md`: структура GUI, mixin-контроллеры, plotting/runtime helpers.
- `hardware_layer.md`: слой работы с LibreVNA и переключателями.
- `storage_formats.md`: форматы NPZ/binary/numpy snapshot и naming.
- `shm_protocol_and_readers.md`: shared-memory ring контракт и декодирование payload.
- `preprocessing_and_capture_workflow.md`: калибровка/референс и последовательный захват.
- `operations_runbook.md`: запуск, диагностика, типовые инциденты.
- `module_reference.md`: справочник ключевых Python-модулей.
## Границы
- Документация описывает Python-часть проекта в `python_app`.
- C++ конвейер (`data_acq_and_processing`) описывается только в части интеграционных точек с Python.
## Версия документации
Актуально для состояния репозитория после рефакторинга: разделения `models`, `storage/npz`, `orchestration/shm`, `gui/plotting`, `gui/runtime`, `gui/controllers/sections`.