How newton-school/systems-simulator works
NS System Design Simulator is a visual distributed-system modeling and discrete-event simulation application, available as a browser app and Electron desktop shell. The primary workflow is to build and configure a topology, run it in a worker, then inspect aggregate, per-node, bottleneck, and replay results before iterating. It also includes question authoring and evaluation capabilities, plus a CLI for scripted runs. README-described workflow links are cited; some internal engine and authoring relationships are only loosely supported by the sampled excerpts, so those links are dashed or omitted.
Main entry points: engine.ts DES engine · simulation.worker.ts Simulation worker · index.ts Scripted CLI · validator.ts Topology validator
Components 22
Build and configure
- Topology canvas
src/renderer/src/components/canvas/FlowCanvas.tsx - Component library
src/renderer/src/components/library/LibrarySidebar.tsx - Topology state
src/renderer/src/store/useStore.ts - Node properties
src/renderer/src/components/properties/PropertiesPanel.tsx - Topology files
src/renderer/src/hooks/useFileHandlers.ts
Simulation runtime
- Simulation controls
src/renderer/src/components/simulation/SimulationControls.tsx - Topology serializer
src/renderer/src/hooks/useTopologySerializer.ts - Topology validator
src/engine/validation/validator.ts - Simulation worker
src/engine/worker/simulation.worker.ts - DES engine
src/engine/engine.ts - G/G/c/K queues
src/engine/nodes/GGcKNode.ts - Request routing
src/engine/routing.ts
Results and analysis
- Metrics and replay
src/engine/metrics.ts - Simulation output
src/engine/analysis/output.ts - Results tray
src/renderer/src/components/simulation/ResultsTray.tsx
Question authoring
- Question studio
src/renderer/src/components/authoring/QuestionStudioShell.tsx - Question compiler
src/engine/analysis/questionAuthoringCompiler.ts - Question project
src/engine/analysis/questionAuthoringProject.ts - Question evaluation
src/engine/analysis/evaluate.ts
Desktop and CLI
- File service
src/renderer/src/services/FileService.web.ts - Scripted CLI
src/cli/index.ts
Other components
- System designer
Connections 25
- System designer → Component library: selects components
README.md - Component library → Topology canvas: adds nodes
README.md - Topology canvas → Topology state: updates topology
README.md - System designer → Node properties: configures nodes
README.md - Node properties → Topology state: updates configuration
README.md - System designer → Topology files: saves or opens
README.md - Topology files → File service: loads or saves
src/renderer/src/hooks/useFileHandlers.ts - System designer → Simulation controls: starts a run
README.md - Simulation controls → Topology serializer: requests topology
README.md - Topology serializer → Topology validator: validates topology
README.md - Topology validator → Simulation worker: sends topology
README.md - Simulation worker → DES engine: runs simulation
src/engine/worker/simulation.worker.ts - DES engine → G/G/c/K queues: processes requests
src/engine/engine.ts - DES engine → Request routing: resolves routes
src/engine/engine.ts - DES engine → Metrics and replay: collects metrics
src/engine/engine.ts - DES engine → Simulation output: generates output
src/engine/engine.ts - Simulation worker → Results tray: returns run results
README.md - Results tray → System designer: shows analysis
README.md - System designer → Question studio: authors questions
- Question studio → Question project: edits project
- Question project → Question compiler: compiles package
- Question compiler → Question evaluation: prepares evaluation
- System designer → Scripted CLI: runs scripted jobs
README.md - Scripted CLI → Topology validator: validates topology
src/cli/index.ts - Scripted CLI → DES engine: runs simulation
src/cli/index.ts