5.1 KiB
5.1 KiB
FQBM Recommendations and Suggestions
Consolidated list of additional recommendations and suggestions for the FQBM project. See also GAPS_AND_MISSING.md and MISSING_COMPONENTS_AND_DOCUMENTATION.md.
1. Code and framework (white paper / FQBM)
| Item | Status / note |
|---|---|
| Full CCP balance-sheet dynamics | Part VIII: margin flows and default waterfall exist; full clearing balance sheet is not modeled. Future work. |
| Full IPSAS compliance at entity level | FQBM provides presentation structures; the reporting entity must maintain recognition/measurement per IPSAS (e.g. 41, 46), prepare cash flow statement (IPSAS 2) and statement of financial performance, populate budget (IPSAS 24) with variance analysis, and apply IPSAS 4 for FX. See IPSAS_COMPLIANCE.md §9. |
| Cash flow by activity (IPSAS 2) | No classification of cash flows by operating/investing/financing from FQBM; use cash_flow_from_state_changes() for inferred amounts and templates for disclosure. |
| FX translation and disclosure | Add explicit translation of foreign-currency assets/liabilities and FX gain/loss in a performance statement; fx_translate() and state S support analysis. |
| Financial instrument measurement and ECL | No measurement bases (amortised cost, FVOCI, FVPL) or impairment model; use financial_instruments_measurement_structure() and maturity_risk_disclosure_structure(); extend with user-supplied data. |
| Budget data | Budget columns (original/final) must be supplied by the reporting entity; use budget_actual_from_state(state, budget) to fill actuals from state. |
| GGS boundary | General government sector boundary and entity list to be defined by the reporting jurisdiction; FQBM supports sectoral structure. |
| RPG 1 (long-term sustainability) | Partial (e.g. debt sustainability r−g in sovereign module); full RPG 1 disclosure not implemented. |
2. Documentation
| Item | Priority / note |
|---|---|
| Canonical white paper in repo | High. Replace WHITE_PAPER.md placeholder with full FQBM white paper (Markdown or PDF) versioned with the code. |
| Sphinx or MkDocs API docs | Medium (optional). API_REFERENCE.md exists; automated API docs could be added via Sphinx or MkDocs. |
| README | Quick start and table of contents in place; Optional features in a single section. |
| framework_summary | One sentence per Part (I–XVI) and module mapping in place; can be expanded. |
| REFERENCES weblinks | IPSASB, IPSASB Handbook, BIS, BIS bulk, IMF, IMF Data, Fed H.4.1, Fed Data Download linked in REFERENCES.md. |
| Inline docstrings | Add “Part X” references and “Required columns” for regression DataFrames where missing. |
3. Contributing and process
| Item | Location |
|---|---|
| Keep PRs focused; prefer smaller, reviewable changes | CONTRIBUTING.md |
| Ensure tests pass; add coverage where practical | CONTRIBUTING |
| Update USER_GUIDE, API_REFERENCE, DATA_DICTIONARY when adding public API | CONTRIBUTING |
| Update IPSAS_COMPLIANCE and GAPS_AND_MISSING when adding IPSAS/matrix features | CONTRIBUTING |
| Add changelog entry under [Unreleased] in CHANGELOG.md | CONTRIBUTING |
| When adding a sheet: optionally add Excel export for the new result key | CONTRIBUTING |
When adding a scenario: optionally add narrative in get_case_narrative() |
CONTRIBUTING |
4. Data and empirical
| Item | Note |
|---|---|
| Real data pipelines | fqbm.data.pipelines: fetch_fed_h41, fetch_bis_series, fetch_imf_series. Can be extended (e.g. more series, caching, retries). See USER_GUIDE.md and DATA_DICTIONARY.md. |
| IMF API key | Optional; programmatic IMF fetch benefits from registration and api_key. |
5. IPSAS and reporting (entity-level)
| Item | Note |
|---|---|
| Recognition and measurement per IPSAS (e.g. 41, 46) | Reporting entity responsibility. |
| Prepare cash flow statement (IPSAS 2) and statement of financial performance | Reporting entity; FQBM provides structure and cash flow from Δstate. |
| Populate budget (IPSAS 24) and provide variance analysis | Reporting entity; FQBM provides template and budget_actual_from_state. |
| Apply IPSAS 4 for FX and other standards | Reporting entity. |
| Disclosure: extend maturity, interest rate sensitivity, credit risk with user-supplied data | Use maturity_risk_disclosure_structure() and related templates. |
6. White paper
| Item | Note |
|---|---|
| Publish full white paper in repo (Markdown or PDF) and link from README and framework_summary | See WHITE_PAPER.md; link already in README. |
References
- GAPS_AND_MISSING.md — Full IPSAS and FQBM gap list
- IPSAS_COMPLIANCE.md — Scope and use of the IPSAS layer
- MISSING_COMPONENTS_AND_DOCUMENTATION.md — Checklist and documentation status