SOTER
SOTER Fact Simulator & Ledger Cookbooks
To better serve different audiences, the SOTER Fact Simulator and Cryptographic Ledger (soter_sim) documentation has been split into two targeted, comprehensive cookbooks:
📘 User & Analyst Guide (GuideCookbookSimulatorUser.md)
Designed for business analysts, system operators, and general users wanting to model processes, run simulations, and perform integrity checks.
- Key Topics Covered:
- High-Level Concept: Component architecture, including the Thin Ledger visual mirroring design.
- Specifications: Format specifications for Fact Payload (
*.fact) and Ledger Block Pointers (*.ledger) files. - Simulation Configuration: Comprehensive guide to the Logos-native
.scenariosyntax and parameters. - Built-in Scenarios: recruitment agency, administrative decision, and warehouse fulfillment processes.
- CLI Commands: Detailed syntax for establishing ledgers, running simulation loops, executing auditor checks, and generating compliance reports.
- Audit Reports: Understanding verification JSON outputs and AI-optimized reports.
🛠️ Developer & Operator Guide (GuideCookbookSimulatorDev.md)
Designed for software engineers, developers, and platform maintainers who need to install, build, extend, or run test suites.
- Key Topics Covered:
- Setup: Development environment setup using Python venv and editable package installs.
- Cryptographic Mechanics: Detailed hash formulas and hashchain generation mathematics.
- Simulation Tuning: Detailed breakdown of custom anomaly types and rates (e.g., duplicate events, out-of-order execution, wrong actor, tamper attempts).
- Test Suite Execution: Target syntax for executing specific pipeline tests (
test_loader.py,test_multitenancy.py, and code coverage).
Related Documents
- DocumentationStyleGuide.md - writing profile and document-type rules.
- OverviewTemplate.md - overview document template.
- ManualsIndex.md - guide and manual index.