db_query / documentations /ciq_2g_doc.py
DavMelchi's picture
feat: improve streamlit docs and clean navigation icons
4d0d437
import streamlit as st
st.markdown(
"""
# CIQ 2G Generator Documentation
## 1. Objective
Generate CIQ 2G deliverables from OML dump and CIQ raw input, including optional free BCF extraction.
## 2. When to use this tool
Use this page when preparing or validating 2G CIQ before deployment.
## 3. Input files and accepted formats
- Required: dump file (`.xlsb`)
- Required for CIQ generation: CIQ raw 2G file (`.xlsx` or `.xls`)
- Optional: forbidden BCF list (`.xlsx`, `.xls`, `.xlsb`)
## 4. Required columns/fields
Forbidden BCF file should include one of these pairs:
- `BSC` and `BCF`
- or `BSCID` and `BCFID`
Optional parameters:
- `MCC` (default: 610)
- `MNC` (default: 2)
## 5. Step-by-step usage
1. Open `Apps > CIQ 2G Generator`.
2. Upload dump `.xlsb`.
3. Optionally generate and download `BCF libre`.
4. Upload CIQ brut 2G file.
5. Set MCC/MNC if needed.
6. Click `Generate` and review sheet tabs.
7. Download final CIQ Excel.
## 6. Outputs generated
- optional `BCF_LIBRE.xlsx`
- generated CIQ 2G workbook (download as `CIQ_2G.xlsx`)
- in-app sheet preview tabs
## 7. Frequent errors and fixes
- Missing dump file.
- Fix: upload `.xlsb` first.
- CIQ generation blocked.
- Fix: upload CIQ brut 2G file.
- Forbidden BCF mismatch.
- Fix: verify expected column names.
## 8. Minimal reproducible example
- Input: valid dump `.xlsb` + `samples/CIQ_2G.xlsx`.
- Action: click `Generate` with default MCC/MNC.
- Expected result: sheet tabs and downloadable `CIQ_2G.xlsx`.
## 9. Known limitations
- Processing time depends on dump size.
- Source CIQ template quality directly affects output.
- Forbidden list handling depends on expected BSC/BCF column format.
## 10. Version and update date
- Documentation version: 1.0
- Last update: 2026-02-23
"""
)