db_query / documentations /database_doc.py
DavMelchi's picture
feat: improve streamlit docs and clean navigation icons
4d0d437
import streamlit as st
st.markdown(
"""
# Databases Documentation
## 1. Objective
Generate telecom databases and KML outputs from a dump file (`.xlsb`) using the `Database processing` page.
## 2. When to use this tool
Use this page when you need one or several outputs from the same dump:
- 2G / 3G / LTE databases
- NEI database
- INVUNIT database
- ADJL / ATL / Nice datasets (when full dump is available)
- 2G / 3G / LTE KML files
## 3. Input files and accepted formats
- Required: one dump file in `.xlsb`
- Optional behavior toggle: `Exclude decommissioned 2G BSCs` (enabled by default)
## 4. Required sheets
Depending on selected outputs, the dump should contain:
- 2G: `BTS`, `BCF`, `TRX`, `MAL`
- 3G: `WCEL`, `WBTS`, `WNCEL`
- LTE: `LNBTS`, `LNCEL`, `LNCEL_FDD`, `LNCEL_TDD`
- Neighbors: `ADCE`, `ADJS`, `ADJI`, `ADJG`, `ADJW`, `BTS`, `WCEL`
- INVUNIT: `INVUNIT`
- Full dump extras: `MRBTS` and related full-dump dependencies
## 5. Step-by-step usage
1. Open `Apps > Generate Databases`.
2. Upload your `.xlsb` dump.
3. Review available buttons (enabled according to detected sheets).
4. Click the needed generation button (`Generate 2G DB`, `Generate All DBs`, etc.).
5. Wait for completion message and download the generated file.
## 6. Outputs generated
The page can generate downloadable files such as:
- `2G database_<timestamp>.xlsx`
- `3G database_<timestamp>.xlsx`
- `LTE database_<timestamp>.xlsx`
- `All databases_<timestamp>.xlsx`
- `Neighbors databases_<timestamp>.xlsx`
- `INVUNIT database_<timestamp>.xlsx`
- KML files for 2G/3G/LTE
## 7. Frequent errors and fixes
- Error: required sheets missing.
- Fix: verify the dump contains the required tabs listed above.
- Error: unsupported file type.
- Fix: upload only `.xlsb`.
- Long processing or timeout feeling.
- Fix: generate one dataset at a time for very large dumps.
## 8. Minimal reproducible example
- Input: one valid full dump `.xlsb` containing 2G/3G/LTE sheets.
- Action: click `Generate All DBs`.
- Expected result: download button appears for `All databases_<timestamp>.xlsx`.
## 9. Known limitations
- Processing time increases with dump size.
- Behavior depends on source dump consistency.
- Some outputs are only available when full dump requirements are met.
## 10. Version and update date
- Documentation version: 1.0
- Last update: 2026-02-23
"""
)