Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 21 additions & 5 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,10 +101,12 @@ export TORC_API_URL="http://localhost:8080/torc-service/v1"

# Quick workflow execution (convenience commands)
./target/release/torc run examples/sample_workflow.yaml # Create and run locally
./target/release/torc submit examples/sample_workflow.yaml # Create and submit to scheduler
./target/release/torc submit examples/sample_workflow.yaml # Submit (requires scheduler actions)
./target/release/torc submit-slurm --account myproject examples/sample_workflow.yaml # Auto-generate Slurm schedulers

# Or use explicit workflow management
./target/release/torc workflows create examples/sample_workflow.yaml
./target/release/torc workflows create-slurm --account myproject examples/sample_workflow.yaml # With Slurm schedulers
./target/release/torc workflows submit <workflow_id> # Submit to scheduler
./target/release/torc workflows run <workflow_id> # Run locally

Expand Down Expand Up @@ -287,12 +289,15 @@ List endpoints support `offset` and `limit` query parameters:
5. Launch interactive UI: `torc tui`

### Submitting a Workflow to Scheduler
**Quick method:**
- `torc submit <spec_file>` - Create from spec and submit to scheduler (requires on_workflow_start/schedule_nodes action)
**Quick method (Slurm with auto-generated schedulers):**
- `torc submit-slurm --account <account> <spec_file>` - Auto-generate Slurm schedulers, create workflow, and submit

**Quick method (pre-configured schedulers):**
- `torc submit <spec_file>` - Create from spec and submit (requires on_workflow_start/schedule_nodes action in spec)
- `torc submit <workflow_id>` - Submit existing workflow to scheduler

**Explicit method:**
1. Create workflow: `torc workflows create <spec_file>`
1. Create workflow: `torc workflows create <spec_file>` or `torc workflows create-slurm --account <account> <spec_file>`
2. Submit workflow: `torc workflows submit <workflow_id>`

### Debugging
Expand Down Expand Up @@ -337,10 +342,12 @@ sqlite3 server/db/sqlite/dev.db

**Quick Workflow Execution** (convenience commands):
- `torc run <spec_file|id>` - Create from spec and run locally, or run existing workflow
- `torc submit <spec_file|id>` - Create from spec and submit to scheduler, or submit existing workflow
- `torc submit <spec_file|id>` - Submit workflow to scheduler (requires pre-configured scheduler actions)
- `torc submit-slurm --account <account> <spec_file>` - Auto-generate Slurm schedulers and submit

**Workflow Management**:
- `torc workflows create <file>` - Create workflow from specification
- `torc workflows create-slurm --account <account> <file>` - Create workflow with auto-generated Slurm schedulers
- `torc workflows new` - Create empty workflow interactively
- `torc workflows list` - List all workflows
- `torc workflows submit <id>` - Submit workflow to scheduler (requires on_workflow_start/schedule_nodes action)
Expand All @@ -349,6 +356,14 @@ sqlite3 server/db/sqlite/dev.db
- `torc workflows status <id>` - Check workflow status
- `torc workflows cancel <id>` - Cancel workflow

**Slurm/HPC Commands**:
- `torc slurm generate --account <account> <spec_file>` - Generate Slurm schedulers for a workflow
- `torc hpc list` - List available HPC profiles
- `torc hpc detect` - Detect current HPC system
- `torc hpc show <profile>` - Show profile details
- `torc hpc partitions <profile>` - List partitions for a profile
- `torc hpc match <profile> --cpus N --memory SIZE` - Find matching partitions

**Job Management**:
- `torc jobs list <workflow_id>` - List jobs for workflow
- `torc jobs get <job_id>` - Get job details
Expand All @@ -357,6 +372,7 @@ sqlite3 server/db/sqlite/dev.db
**Execution**:
- `torc run <workflow_spec_or_id>` - Run workflow locally (top-level command)
- `torc submit <workflow_spec_or_id>` - Submit workflow to scheduler (top-level command)
- `torc submit-slurm --account <account> <spec_file>` - Submit with auto-generated Slurm schedulers
- `torc tui` - Interactive terminal UI

**Utilities**:
Expand Down
1 change: 1 addition & 0 deletions docs/book.toml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ create-missing = true
[output.html]
default-theme = "light"
preferred-dark-theme = "navy"
favicon = "images/torc_icon_256.png"
git-repository-url = "https://github.com/NREL/torc"
edit-url-template = "https://github.com/NREL/torc/edit/main/docs/{path}"
site-url = "/torc/"
Expand Down
7 changes: 7 additions & 0 deletions docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
- [Getting Started](./getting-started.md)
- [Installation](./installation.md)
- [Quick Start](./quick-start.md)
- [Quick Start (Local)](./quick-start-local.md)
- [Quick Start (HPC)](./quick-start-hpc.md)

# Understanding Torc

Expand All @@ -21,6 +23,7 @@
- [Dependency Resolution](./explanation/dependencies.md)
- [Parallelization Strategies](./explanation/parallelization.md)
- [Workflow Actions](./explanation/workflow-actions.md)
- [Slurm Workflows](./explanation/slurm-workflows.md)
- [Design](./explanation/design/README.md)
- [Server API Handler](./explanation/design/server.md)
- [Central Database](./explanation/design/database.md)
Expand All @@ -32,10 +35,12 @@
- [Configuration Files](./how-to/configuration-files.md)
- [Creating Workflows](./how-to/creating-workflows.md)
- [Working with Slurm](./how-to/slurm.md)
- [HPC Profiles](./how-to/hpc-profiles.md)
- [Job Checkpointing](./how-to/checkpointing.md)
- [Resource Monitoring](./how-to/resource-monitoring.md)
- [Terminal UI (TUI)](./how-to/tui.md)
- [Web Dashboard](./how-to/dashboard.md)
- [Visualizing Workflow Structure](./how-to/visualizing-workflows.md)
- [Debugging Workflows](./how-to/debugging.md)
- [Debugging Slurm Workflows](./how-to/debugging-slurm.md)
- [Authentication](./how-to/authentication.md)
Expand All @@ -49,6 +54,7 @@
- [Workflow Specification Formats](./reference/workflow-formats.md)
- [Job Parameterization](./reference/parameterization.md)
- [Resource Requirements](./reference/resources.md)
- [HPC Profiles](./reference/hpc-profiles.md)
- [Resource Monitoring](./reference/resource-monitoring.md)
- [OpenAPI Specification](./reference/openapi.md)
- [Configuration](./reference/configuration.md)
Expand All @@ -68,6 +74,7 @@
- [Multi-Stage Workflows with Barriers](./tutorials/multi-stage-barrier.md)
- [Map Python functions across workers](./tutorials/map_python_function_across_workers.md)
- [Filtering CLI Output with Nushell](./tutorials/filtering-with-nushell.md)
- [Custom HPC Profile](./tutorials/custom-hpc-profile.md)

---

Expand Down
Loading