Skip to main content

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

Project description

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

Quickest Start — one call does everything:

from rwa_calc.api import quick_calculate

response = quick_calculate("/path/to/data")
print(f"Total RWA: {response.summary.total_rwa:,.0f}")

More Control — choose framework, IRB approach, and reporting date:

from datetime import date
from rwa_calc.api import create_service, CalculationRequest

service = create_service()
response = service.calculate(
    CalculationRequest(
        data_path="/path/to/data",
        framework="CRR",
        reporting_date=date(2026, 12, 31),
        irb_approach="full_irb",
    )
)

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

Per-Model IRB Permissions — for banks with multiple approved IRB models, place a config/model_permissions.parquet file in your data directory to control IRB approach at the model level. Counterparties link to models via model_id. See the Data Model docs for schema details.

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 PS9/24 Active Development

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, Institution, Corporate, Corporate SME, Retail Mortgage, Retail QRRE, Retail Other, Specialised Lending, Equity

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: ~1,915 tests (1,485 unit + 275 acceptance + 123 contract + ~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.1.47.tar.gz (1.1 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.1.47-py3-none-any.whl (286.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for rwa_calc-0.1.47.tar.gz
Algorithm Hash digest
SHA256 aa8ea5f541b2a1f46eafd0024826081a6b6fa1624ad42e22ab524904e4f157c0
MD5 9323a99f0b0f17598dec650ed410e706
BLAKE2b-256 03117ccce47f516cdac25e6021f4949596caf1ecfe8c002cb9b402e28d0ac431

See more details on using hashes here.

Provenance

The following attestation bundles were made for rwa_calc-0.1.47.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.1.47-py3-none-any.whl.

File metadata

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

File hashes

Hashes for rwa_calc-0.1.47-py3-none-any.whl
Algorithm Hash digest
SHA256 2823cea4b6ee18ac11184b60ebc9087c49237ac4cef471d1a099cbec41fd6320
MD5 0d5c23c305d88b16855e9f82580261d2
BLAKE2b-256 a258ef90ff00d198d57aa309bfd73ddb82867fadafda275d2e71a1ba6877bfc1

See more details on using hashes here.

Provenance

The following attestation bundles were made for rwa_calc-0.1.47-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