Skip to main content

Basel 3.1 Credit Risk RWA Calculator compliant with PRA PS1/26

Project description

[!IMPORTANT] This package is still in active development and is not production ready - release 1.0.0 will confirm when ready for current CRR and 2.0.0 for Basel 3.1

UK Credit Risk (CR) & Counterparty Credit Risk (CCR) RWA Calculator

Documentation

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

Documentation: https://OpenAfterHours.club/rwa_calculator/

Installation

Install with uv (recommended)

uv add rwa-calc

Or with pip

pip install rwa-calc

The web UI and REST API ship with the base package — no extra required.

Optional Dependencies

Extra Description
ui Legacy alias — UI deps are now included in the base install
dev Development tools (pytest, ruff, ty, 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 — server-rendered web interface (calculator, results, CRR vs Basel 3.1 comparison) plus a REST API and an editable Marimo workbench:

uv add rwa-calc
rwa-ui
# Open http://localhost:8000 in your browser (REST API + OpenAPI at /docs)

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.club/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

Test fixtures are parquet files generated from Python builders and are not checked into the repo (they are gitignored). Generate them once before running the test suite for the first time, and again whenever a fixture builder under tests/fixtures/ changes:

# Generate all test fixtures (parquet output, 8 groups)
uv run python tests/fixtures/generate_all.py
# 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.25.tar.gz (3.6 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.25-py3-none-any.whl (720.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for rwa_calc-0.2.25.tar.gz
Algorithm Hash digest
SHA256 90edaf573073d17679b995535a2c2d99c6b1deffe13add63a482de173ee12f24
MD5 69c755f45581bd6594245e1c5a30c703
BLAKE2b-256 1dd27764f973c326a9cf25e65317f33e44e9fa87481f03ed62f8ed2a8f37197e

See more details on using hashes here.

Provenance

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

File metadata

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

File hashes

Hashes for rwa_calc-0.2.25-py3-none-any.whl
Algorithm Hash digest
SHA256 1e41a47b2d342bbd8dc7dab03c4e6747114ed6d77507e429cbaed9e41b4c354e
MD5 bed13afdaf353d78dc5b8ecc6faed575
BLAKE2b-256 290e45d0d6a0724e4d2434f7e84c22c5802c98f23b5e0389c5499b3b1f4befa7

See more details on using hashes here.

Provenance

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