Choose an Analysis Path
OpenEntropy analysis is exposed through two execution surfaces:
| Surface | Entry point | What it controls |
|---|---|---|
| Dispatcher API | openentropy_core::dispatcher::analyze | forensic, entropy, chaos, trials, cross_correlation |
| CLI analyze command | openentropy analyze | Dispatcher modules plus CLI-only toggles: --temporal, --statistics, --synchrony, --chaos-extended |
Use this page as the hub, then jump to focused deep-dive pages.
Quick Start
Section titled “Quick Start”openentropy analyze --profile quickopenentropy analyze --profile deepopenentropy analyze --profile securityfrom openentropy import analyzereport = analyze([("my_source", data)], profile="deep")use openentropy_core::dispatcher::{analyze, AnalysisProfile};let report = analyze(&[("my_source", &data)], &AnalysisProfile::Deep.to_config());Profiles at a glance
Section titled “Profiles at a glance”CLI profiles (openentropy analyze):
| Profile | Forensic | Entropy | Chaos Core | Chaos Extended | Temporal | Statistics | Synchrony | Trials | Cross-Corr |
|---|---|---|---|---|---|---|---|---|---|
quick | ✓ | — | — | — | — | — | —* | — | — |
standard | ✓ | — | — | — | — | — | —* | — | — |
deep | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | —* | ✓ | ✓ |
security | ✓ | ✓ | — | — | — | — | —* | — | — |
Dispatcher profiles (openentropy_core::dispatcher::AnalysisProfile and Python analyze(profile=...)):
| Profile | Forensic | Entropy | Chaos | Trials | Cross-Corr |
|---|---|---|---|---|---|
quick | ✓ | — | — | — | — |
standard | ✓ | — | — | — | — |
deep | ✓ | ✓ | ✓ | ✓ | ✓ |
security | ✓ | ✓ | — | — | — |
* Synchrony always requires 2+ streams and is enabled explicitly with --synchrony (CLI) or direct synchrony APIs.
Which analysis should I use?
Section titled “Which analysis should I use?”Start with the question you are trying to answer:
| If your question is… | Use | Why |
|---|---|---|
| ”Is this source healthy at a basic level?” | Forensic Analysis | Baseline checks: autocorrelation, spectral flatness, bias, distribution, stationarity, runs |
| ”How much entropy density does this source have?” | Entropy Breakdown | Multi-estimator min-entropy view and grade |
| ”Are two sources independent enough to combine?” | Cross-Correlation | Pairwise correlation matrix and flagged pairs |
| ”Do I trust PASS/WARN/FAIL quickly?” | Verdict System | Threshold model used by CLI and reports |
| ”Is behavior drifting over time?” | Temporal Analysis | Change points, anomalies, bursts, shifts, drift |
| ”Are there formal dependence/goodness-of-fit issues?” | Statistics Analysis | Cramer-von Mises, Ljung-Box, gap, group tests |
| ”Are two streams coupled or event-synchronized?” | Synchrony Analysis | Mutual information, coherence proxy, cross-sync, global events |
| ”Is this random-looking output actually structured/chaotic?” | Chaos Theory Analysis | Core + extended entropy/complexity methods |
| ”How stable is deviation across repeated 200-bit trials?” | Trial Analysis Methodology | PEAR-style trial framing and Stouffer combination |
Recommended Workflow
Section titled “Recommended Workflow”For most users:
- Start with
openentropy analyze --profile securityfor security validation or--profile deepfor research. - Review Forensic Analysis and Entropy Breakdown first.
- Use Verdict System for triage, then inspect raw metrics on any WARN/FAIL.
- Add advanced modules only when needed: temporal/statistics/synchrony/chaos/trials.
Analysis pages
Section titled “Analysis pages”- Forensic Analysis
- Entropy Breakdown
- Verdict System
- Cross-Correlation
- Trial Analysis Methodology
- Chaos Theory Analysis
- Temporal Analysis
- Statistics Analysis
- Synchrony Analysis
Attribution
Section titled “Attribution”The expanded analysis inventory in OpenEntropy was informed by the open-source work in vikingdude81/qrng-analysis-toolkit.