Skip to content

API and Module Reference

GCBM Assistant is primarily a desktop UI application, but its internal module structure is stable enough for extension workflows.

Document Control

Field Value
Author Geraldson Muluh
Owner GCBM Assistant maintainers
Audience Developers and integrators
Last reviewed 2026-03-27
Review cadence Monthly

Entry Points

  • CLI script: gcbm-assistant
  • Python module entry: python -m gcbm_assistant.app
  • Script target: gcbm_assistant.app:main

Core Modules

| Module | Responsibility | | gcbm_assistant.app | App bootstrap, routing, global page registration | | gcbm_assistant.pages.simulation | Simulation UI, config validation, run orchestration | | gcbm_assistant.pages.compile | Compilation workflow UI and output generation | | gcbm_assistant.pages.visualize | Chart and spatial visualization orchestration | | gcbm_assistant.pages.spatial | Raster processing, map rendering helpers, spatial scanning | | gcbm_assistant.pages.data | Database access helpers for visualization and reporting | | gcbm_assistant.pages.reports | Report generation and export UI |

Stable Interface Expectations

  • Internal function signatures are not versioned as public SDK interfaces.
  • Extensions should prefer page-level hooks and existing state access patterns.
  • Any custom integration should pin to a release tag and re-validate on upgrade.

Repository and Contribution Context