User Guide¶
This section provides comprehensive guidance on using DisruptSC for your research and analysis needs.
Overview¶
DisruptSC is designed to be flexible and configurable for different use cases. The user guide covers:
- Basic Usage - Command-line interface and simulation types
- Parameters - Configuration options and settings
- Criticality Analysis - Scenario list vs flow-ranked loop, watermark + resume, caching
- Data Modes - Current MRIO data mode
- Input Data - Required data files and formats
- Output Files - Understanding and interpreting results
Simulation Types¶
The current v2 runtime supports these simulation modes:
| Type | Purpose | Use Case |
|---|---|---|
initial_state |
Baseline equilibrium | Understand normal operations |
disruption |
Single disruption scenario | Analyze specific events |
criticality |
Infrastructure assessment | Identify critical links |
Configuration Workflow¶
graph LR
A[Choose Scope] --> B[Set Data Mode]
B --> C[Configure Parameters]
C --> D[Validate Inputs]
D --> E[Run Simulation]
E --> F[Analyze Results]
Key Concepts¶
- Scope
- The geographic region of analysis (e.g., Cambodia, Ecuador, Global)
- Regions
- Sub-national administrative units within the scope
- Sectors
- Economic activity categories based on ISIC/NAICS classifications
- Agents
- Economic actors: firms (producers), households (consumers), countries (trade partners)
Best Practices¶
Performance Optimization
- Use caching for repeated runs with
--cacheoptions - Filter small firms/sectors to reduce computational load
- Consider parallel execution for large-scale analysis
Data Quality
- Always validate inputs before running simulations
- Check MRIO table balance and consistency
- Verify transport network connectivity
Reproducibility
- Save parameter files with your results
- Document any data preprocessing steps
- Use version control for configuration changes