PropFlow Handbook

The handbook collects operational guidance, deployment playbooks, and day-to-day workflows for running PropFlow in production-like environments. Start here if you need to understand how the platform is organised, how to set up infrastructure, and how to troubleshoot simulations.

• Conceptual Overview
  • 1. What PropFlow Solves
  • 2. Core Runtime Concepts
  • 3. Creation Pipeline (Top-Down)
  • 4. Directory Layout
  • 5. Data Flow Through an Engine Step
  • 6. Extensibility Points
  • 7. Operational Roles
• System Setup & Dependencies
  • 1. Supported Platforms
  • 2. Core Dependencies
  • 3. Environment Bootstrapping
  • 4. Verifying Installation
  • 5. External Services & Data
  • 6. File System Expectations
• Running Simulations & Tools
  • 1. Quick Smoke Test (main.py)
  • 2. Using the Simulator API
  • 3. Command-Line Interface (bp-sim)
  • 4. Snapshot Capture & Analysis
  • 5. Examples Directory
  • 6. Testing & Validation
  • 7. Logging & Artefacts
• Deployment Playbooks
  • 1. Local Workstation or Lab Server
  • 2. Containerised Deployment (Docker)
  • 3. HPC / Batch Scheduling
  • 4. Web Service / API Integration
  • 5. Packaging & Distribution
  • 6. Configuration Management
  • 7. Logging & Monitoring
• Development Workflow
  • 1. Repository Hygiene
  • 2. Tooling
  • 3. Coding Guidelines
  • 4. Testing Strategy
  • 5. Adding New Features
  • 6. Release Process
  • 7. Documentation Maintenance
  • 8. Collaboration
• Reference Tables
  • 1. Modules & Key Entrypoints
  • 2. Configuration Defaults (global_config_mapping.py)
  • 3. CLI & Scripts
  • 4. Environment Variables
  • 5. File & Directory Conventions
  • 6. Glossary
• Troubleshooting & FAQ
  • 1. Installation Issues
  • 2. Runtime Errors
  • 3. Performance & Resource Usage
  • 4. Visualisation Problems
  • 5. Snapshot Recorder Questions
  • 6. Deployment Questions
  • 7. Getting Support
• Analyzer and Reporting Workflows
  • 1. Capturing Snapshots
  • 2. Parsing Snapshot Payloads
  • 3. Running the Snapshot Analyzer
  • 4. Generating Reports and Artefacts
  • 5. Command Line Interface
  • 6. Worked Examples
  • 7. Best Practices

Additional architecture diagrams live alongside the chapters:

• ARCHITECTURE_TREE.md: High-level component breakdown

• README.md: Handbook contribution guidelines and context