db_query / documentations /dump_analysis_doc.py
DavMelchi's picture
feat: improve streamlit docs and clean navigation icons
4d0d437
import streamlit as st
st.markdown(
"""
# Dump Analytics Documentation
## 1. Objective
Explain the analytics dashboard displayed after generating full databases with stats.
## 2. When to use this tool
Use this documentation when reviewing post-generation charts and metrics for GSM/WCDMA/LTE (FDD/TDD).
## 3. Input files and accepted formats
No direct upload in this module.
It is fed by the `Generate All DBs and Show Stats` flow from `Apps > Generate Databases`.
## 4. Required fields
The analytics rely on precomputed structures in `utils.utils_vars` (site, GSM, WCDMA, LTE metrics).
## 5. Step-by-step usage
1. Open `Apps > Generate Databases`.
2. Upload a full dump `.xlsb`.
3. Click `Generate All DBs and Show Stats`.
4. Open Data and Chart tabs.
5. Use this page to interpret the displayed indicators.
## 6. Outputs generated
Displayed analytics include:
- site counts and band distributions
- GSM controller/LAC/TRX distributions
- WCDMA RNC/LAC/admin-state distributions
- LTE FDD/TDD distributions (bands, PCI, TAC, admin-state)
## 7. Frequent errors and fixes
- Empty analytics sections.
- Fix: ensure full dump criteria are met before stats generation.
- Missing distributions.
- Fix: verify source dump has required technology sheets.
- Inconsistent counts.
- Fix: regenerate all DBs and ensure no parsing errors occurred.
## 8. Minimal reproducible example
- Input: full dump `.xlsb` containing 2G/3G/LTE sheets.
- Action: run `Generate All DBs and Show Stats`.
- Expected result: populated Data and Chart tabs with multi-technology metrics.
## 9. Known limitations
- Not exposed as a standalone top-level app page.
- Availability depends on successful preprocessing in database workflow.
- Large dumps can impact rendering speed.
## 10. Version and update date
- Documentation version: 1.0
- Last update: 2026-02-23
"""
)