Skip to main content

crml-engine

Reference runtime/simulation engine for CRML.

Depends on crml-lang for the CRML models and validation.

Install

pip install crml-engine

CLI

Validate a scenario/portfolio document:

crml-lang validate examples/scenarios/data-breach-simple.yaml
crml-lang validate examples/portfolios/portfolio.yaml

Run a simulation:

crml simulate examples/scenarios/data-breach-simple.yaml --runs 10000
crml simulate examples/portfolios/portfolio.yaml --runs 10000
crml simulate examples/portfolio_bundles/portfolio-bundle-documented.yaml --runs 10000

Notes:

  • The crml simulate command auto-detects scenario vs portfolio vs portfolio-bundle inputs.
  • Portfolio simulation uses crml_lang.plan_portfolio and applies portfolio semantics.

Python

from crml_engine.runtime import run_simulation

result = run_simulation("examples/scenarios/data-breach-simple.yaml", n_runs=10000)
print(result.metrics.eal)

Metadata

Release files for crml-engine 1.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for crml-engine 1.2.0
File Size Uploaded Provenance
crml_engine-1.2.0.tar.gz 41.8 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for crml-engine 1.2.0
File Interpreter ABI Platform
crml_engine-1.2.0-py3-none-any.whl Python 3 none any Details

Total release size: 89.4 kB

Release files / crml_engine-1.2.0.tar.gz

Download URL crml_engine-1.2.0.tar.gz
Size 41.8 kB
Tags Source
SHA-256 checksum
How to use checksums
bbd45336b99dcb8245f85c9a0d10007eb1d9da40d6ba7dc1f9918ce8649dd422
BLAKE2b-256 checksum
How to use checksums
32cf99b9e878b0bbdd36094907009252d499eec03c218ab7ee8df4cbbf943a91
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.6

Release files / crml_engine-1.2.0-py3-none-any.whl

Download URL crml_engine-1.2.0-py3-none-any.whl
Size 47.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
14b2090fc111a73166b7ca08889b861d151c7c38dc2c49074c1554467edf49b6
BLAKE2b-256 checksum
How to use checksums
d92f806e46ffdec1c3ab2489de4e396bec74f3ce750d49e96dba06c1d6a6ae7f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.6

Security for crml-engine 1.2.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Release history Release notifications | RSS feed

This release

1.2.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page