@@ -10,51 +10,82 @@ coordination, while clients create workflows and job runners execute tasks on co
1010
1111Choose the interface that fits your workflow:
1212
13- - ** Dashboard** — Web UI ([ torc-dash] ( ./how-to/dashboard.md ) ) for visual monitoring
13+ - ** CLI** — Primary interface which provides access to all torc functionality
14+ - ** Dashboard** — Web UI ([ torc-dash] ( ./how-to/dashboard.md ) ) for visual configuration and
15+ monitoring
16+ - ** TUI** — Terminal User Interface (` torc tui ` ) for visual monitoring in a terminal
1417- ** AI Assistants** — Use [ Claude Code] ( https://claude.ai/code ) or GitHub Copilot to manage
1518 workflows through natural language. _ "Create a workflow with 10 parallel jobs"_ or _ "Why did job 5
1619 fail?"_
17- - ** TUI** — Terminal User Interface (` torc tui ` ) for visual monitoring in a terminal
18- - ** CLI** — The ` torc ` command for scripting and automation
1920- ** Spec Files** — YAML, KDL, or JSON5 files for version-controlled workflow definitions
2021- ** Python/Julia APIs** — Libraries for programmatic workflow generation
2122
22- All interfaces work with the same server— mix and match as needed.
23+ All interfaces work with the same server — mix and match as needed.
2324
2425## Architecture
2526
26- ```
27- ┌─────────────────────────────────────────────────────────────────┐
28- │ Torc Server │
29- │ (REST API + SQLite DB) │
30- └─────────────────────────────────────────────────────────────────┘
31- ▲ ▲ ▲ ▲
32- │ │ │ │
33- ┌────┴────┐ ┌─────┴─────┐ ┌────┴────┐ ┌─────┴─────┐
34- │ CLI │ │ Dashboard │ │ AI │ │ Python │
35- │ torc │ │ torc-dash │ │Assistant│ │ API │
36- └─────────┘ └───────────┘ └─────────┘ └───────────┘
27+ ``` mermaid
28+ flowchart TB
29+ subgraph ai["AI Integration"]
30+ AI_CLIENTS["AI Clients<br/>(Claude Code, Copilot)"]
31+ MCP["torc-mcp-server"]
32+ AI_CLIENTS -->|"MCP"| MCP
33+ end
34+
35+ subgraph clients["Client Applications"]
36+ TUI["torc tui"]
37+ DASH["torc-dash<br/>(web UI)"]
38+ PY["Python Client"]
39+ JL["Julia Client"]
40+ end
41+
42+ CLI["torc CLI"]
43+
44+ subgraph server["Server"]
45+ HTTP["HTTP API<br/>(torc-server)"]
46+ DB[(SQLite)]
47+ HTTP --> DB
48+ end
49+
50+ subgraph workers["Workers (local, remote, or HPC)"]
51+ LOCAL["Local Runner"]
52+ SLURM["Slurm Runner"]
53+ end
54+
55+ TUI -->|"executes"| CLI
56+ DASH -->|"executes"| CLI
57+ MCP -->|"executes"| CLI
58+
59+ CLI -->|"HTTP"| HTTP
60+ TUI -->|"HTTP"| HTTP
61+ DASH -->|"HTTP"| HTTP
62+ MCP -->|"HTTP"| HTTP
63+ PY -->|"HTTP"| HTTP
64+ JL -->|"HTTP"| HTTP
65+
66+ LOCAL -->|"HTTP"| HTTP
67+ SLURM -->|"HTTP"| HTTP
3768```
3869
3970** Key components:**
4071
41- - ** Server** — REST API service managing workflow state via SQLite
72+ - ** Server** — HTTP API service managing workflow state via SQLite
4273- ** Job Runners** — Worker processes that execute jobs on compute resources
4374- ** Clients** — CLI, dashboard, AI assistants, or API libraries
4475
4576## Features
4677
47- - ** AI-Assisted Management** — Create, debug, and manage workflows through conversation
4878- ** Declarative Workflow Specifications** — Define workflows in YAML, JSON5, JSON, or KDL
49- - ** Automatic Dependency Resolution** — Dependencies inferred from file and data relationships
5079- ** Job Parameterization** — Create parameter sweeps and grid searches with simple syntax
80+ - ** Automatic Dependency Resolution** — Dependencies inferred from file and data relationships
5181- ** Distributed Execution** — Run jobs across multiple compute nodes with resource tracking
5282- ** Slurm Integration** — Native support for HPC cluster job submission
5383- ** Automatic Failure Recovery** — Detect OOM/timeout failures and retry with adjusted resources
5484- ** Workflow Resumption** — Restart workflows after failures without losing progress
5585- ** Change Detection** — Automatically detect input changes and re-run affected jobs
56- - ** Resource Management** — Track CPU, memory, and GPU usage across all jobs
86+ - ** Resource Management** — Track CPU and memory across all jobs
5787- ** RESTful API** — Complete OpenAPI-specified REST API for integration
88+ - ** AI-Assisted Management** — Create, debug, and manage workflows through conversation
5889
5990## Next: Quick Start
6091
0 commit comments