Skip to main content

Basel 3.1 Credit Risk RWA Calculator compliant with PRA PS9/24

Project description

[!IMPORTANT] This package is still in development and is not production ready

UK Credit Risk RWA Calculator

Documentation

A high-performance Risk-Weighted Assets (RWA) calculator for UK credit risk, supporting both current regulations and future Basel 3.1 implementation. Built with Python using Polars for vectorized performance.

Documentation: https://OpenAfterHours.github.io/rwa_calculator/

Installation

# Install from PyPI
pip install rwa-calc

# Or with uv
uv add rwa-calc

# With UI support (web-based calculator interface)
pip install rwa-calc[ui]

Optional Dependencies

Extra Description
ui Interactive web UI via Marimo
dev Development tools (pytest, mypy, zensical)
all All optional dependencies

Quick Start

from datetime import date
from rwa_calc.api import CreditRiskCalc

response = CreditRiskCalc(
    data_path="/path/to/data",
    framework="CRR",
    reporting_date=date(2026, 12, 31),
    permission_mode="irb",
).calculate()

if response.success:
    print(f"Total RWA: {response.summary.total_rwa:,.0f}")
    df = response.collect_results()

IRB Mode — set permission_mode="irb" and provide a model_permissions input table to route exposures to FIRB, AIRB, or slotting based on per-model approvals. Exposures without a matching model permission fall back to SA. See the Data Model docs for the model permissions schema.

Interactive UI — web-based calculator interface:

pip install rwa-calc[ui]
rwa-calc-ui
# Open http://localhost:8000 in your browser

Regulatory Scope

This calculator supports two regulatory regimes:

Regime Effective Period UK Implementation Status
CRR (Basel 3.0) Until 31 December 2026 UK CRR (EU 575/2013 as onshored) Active
Basel 3.1 From 1 January 2027 PRA PS1/26 Implemented

A configuration toggle allows switching between calculation modes for:

  • Current regulatory reporting under UK CRR
  • Impact analysis and parallel running ahead of Basel 3.1 go-live
  • Seamless transition when Basel 3.1 becomes effective

Key Features

  • Dual-Framework Support: Single codebase for CRR and Basel 3.1 with UK-specific deviations
  • High Performance: Polars LazyFrames for vectorized calculations (50-100x improvement over row iteration)
  • Complete Coverage: Standardised (SA), IRB (F-IRB & A-IRB), and Slotting approaches
  • Credit Risk Mitigation: Collateral, guarantees, and provisions with RWA-optimized allocation
  • Complex Hierarchies: Multi-level counterparty and facility hierarchy support
  • Audit Trail: Full calculation transparency for regulatory review
  • Framework Comparison: Side-by-side CRR vs Basel 3.1 impact analysis
  • COREP Output: Export results to COREP regulatory templates
  • Multiple Export Formats: Parquet, CSV, Excel, and COREP

Supported Approaches

Approach Description
Standardised (SA) Risk weights based on external ratings and exposure characteristics
Foundation IRB (F-IRB) Bank-estimated PD, supervisory LGD
Advanced IRB (A-IRB) Bank-estimated PD, LGD, and EAD
Slotting Category-based approach for specialised lending

Supported Exposure Classes

Sovereign / Central Bank, Institution, Corporate, Corporate SME, PSE, MDB, RGLA, Retail Mortgage, Retail QRRE, Retail Other, Specialised Lending, Equity, Covered Bond, Residential Mortgage, Commercial Mortgage (Basel 3.1 RE split), High Risk, Defaulted, Other

Documentation

Comprehensive documentation is available at OpenAfterHours.github.io/rwa_calculator

Section Description
Getting Started Installation and first calculation
User Guide Regulatory frameworks, methodology, exposure classes
Architecture System design and pipeline
Data Model Input schemas and validation
API Reference Complete technical documentation
Development Testing, benchmarks, contributing
Plans Development roadmap and status

Running Tests

# Run all tests
uv run pytest -v

# Run with coverage
uv run pytest --cov=src/rwa_calc

# Run benchmarks (10K + 100K, excludes 1M/10M)
uv run pytest tests/benchmarks/ -m "benchmark and not slow" -k "not 1m" -o "addopts=" --benchmark-only -v

Test Results: ~5,500 tests (~4,675 unit + ~500 acceptance + ~165 contract + ~145 integration + ~30 benchmark)

License

Apache-2.0 license

References

Current Regulations (CRR / Basel 3.0)

Basel 3.1 Implementation (January 2027)

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rwa_calc-0.2.3.tar.gz (2.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rwa_calc-0.2.3-py3-none-any.whl (468.0 kB view details)

Uploaded Python 3

File details

Details for the file rwa_calc-0.2.3.tar.gz.

File metadata

  • Download URL: rwa_calc-0.2.3.tar.gz
  • Upload date:
  • Size: 2.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for rwa_calc-0.2.3.tar.gz
Algorithm Hash digest
SHA256 24609ced32f66ce932b936ddb1e17f0ae9ac47b01ad855db44f6af0c79629376
MD5 8c95b2dc08d49fb066576e881bf911fe
BLAKE2b-256 6d24627a408b31dd6d6d34bcd4b58d3c97b90d70ce389dc8d8046dfc44685314

See more details on using hashes here.

Provenance

The following attestation bundles were made for rwa_calc-0.2.3.tar.gz:

Publisher: publish.yml on OpenAfterHours/rwa_calculator

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file rwa_calc-0.2.3-py3-none-any.whl.

File metadata

  • Download URL: rwa_calc-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 468.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for rwa_calc-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 4f8ab390698bb7964e2baa6d80de8ea3742f9a680b62f8c4468fa4db51d439ec
MD5 73663e639c17797a824a7a4c4e1fa298
BLAKE2b-256 420c7f0d1df2343b5f0e5fb4a262e75940e85e74aa9a0cfc04909b0e2d3cfcb5

See more details on using hashes here.

Provenance

The following attestation bundles were made for rwa_calc-0.2.3-py3-none-any.whl:

Publisher: publish.yml on OpenAfterHours/rwa_calculator

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page