Process Risk Consequence Toolkit

23 discoverable Python calculations, strict SI contracts, reproducible receipts, JSON Schemas and dependency-traced workflows. Apache-2.0.

The toolkit covers release/source screening, passive dispersion, fire and explosion effects, normalized exposure, conditional risk, optional SLABx dense-gas histories and an explicitly restricted coupled-layer research model.

This is an independent project. It is not an official CCPS/AIChE product, an endorsed standard implementation, or a safety certification. The legacy ccps_consequence import and schema IDs are compatibility identifiers. No purchased standards, book text, tables, figures, worked examples or external engine source are distributed. Rights review.

Start here

python -m pip install process-risk-consequence-toolkit
# Optional features, installed explicitly:
python -m pip install 'process-risk-consequence-toolkit[http,coupled,dense]'

Publication status: Zenodo 0.1.0 is available. PyPI publication is pending. The optional pinned slabx==1.0.8 engine was locally tested but is not currently published on PyPI; the dense extra cannot yet be installed from PyPI alone. Base, HTTP and coupled features do not require it. Public CI runs without the native engine and reports native tests as skips. Do not substitute another version silently.

Python 3.12+. Base dependency: Pydantic. coupled adds NumPy, dense adds the pinned separate slabx==1.0.8 engine, and http adds FastAPI/Uvicorn.

from ccps_consequence import Context, calculate, verify_receipt

context = Context(asset_id="T1", scenario_id="leak", operating_case_id="normal")
receipt = calculate("source/inventory", {
    "mass_rate_kg_s": 2.0, "duration_s": 8.0, "inventory_kg": 10.0
}, context=context)
assert receipt.outputs["released_mass_kg"] == 10.0
verify_receipt(receipt)

Human and machine interfaces

prct catalog
prct schema --calculation source/liquid
prct workflow examples/ccps_screening.workflow.json
prct capabilities
prct serve --host 127.0.0.1 --port 8765

CLI results are JSON on stdout, errors are JSON on stderr with a nonzero exit code. HTTP calculation failures use 422; no silent fallback engine/model.

Model map

All 23 calculations and their parameters are documented individually in the generated module reference. Inputs use Pa absolute, K, kg, m and s. Molecular weight for native dense contracts is kg/mol. Evidence, applicability literals and basis fields are part of the contract, not optional engineering judgments inferred by the software.

Three different dense-gas routes

The coupled route is not a 2D/thermal/two-layer solver or a validated replacement for SLAB/TWODEE. Entrainment and wind-relaxation closures require explicit user qualification. Software conservation/refinement tests are not field validation. Passive Gaussian routes do not become dense models because a screen is passed.

Examples and interoperability

python examples/ccps_dense_history.py
python examples/ccps_release_history.py --mode variable
python examples/ccps_coupled_layer.py --compare-independent

All examples are newly authored synthetic data. PRISM left-held rows, API-581 release receipts and PHA LOC-frequency boundaries preserve source hashes and ownership. External engine/software source is not included. The optional ccps_consequence.pha_adapter requires a separately installed compatible PHA Core; this distribution does not relicense or ship PHA Core or its UI/database. Integration manual.

Development and release

git clone https://github.com/lyullee/process-risk-consequence-toolkit.git
cd process-risk-consequence-toolkit
python -m pip install -e '.[dev,dense]'
python scripts/build_ccps_contracts.py
python scripts/build_manual.py
python -m pytest -q
python -m build
python -m twine check dist/*
python scripts/release_audit.py --dist

See implementation history, limitations, contribution rules and release checklist. Validation counts in this portable distribution are reported separately from the earlier host PHA integration runs. Do not reuse old counts as release proof.

License and citation

Copyright 2026 Ugwiyeon Lee. Apache-2.0; NOTICE and third-party boundaries apply. Referenced organizations' names and marks remain theirs; no logo or endorsement rights are granted. Use CITATION.cff for citation metadata. DOI and index publication links are added only after their publication is verified.