Skip to content

Commit be3fbaf

Browse files
docs: update query commands for scenario_id migration
- Replace --population-id/--network-id with --scenario/-s - Add --run-id option for resolving scenario from run - Update examples to show new flag usage
1 parent 60671c0 commit be3fbaf

2 files changed

Lines changed: 30 additions & 20 deletions

File tree

AGENTS.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,9 +83,12 @@ extropy persona -s ai-adoption -y
8383
Export raw data for downstream processing:
8484

8585
```bash
86-
# Agents as JSONL
86+
# Agents as JSONL (auto-resolves scenario from latest run)
8787
extropy query agents --to agents.jsonl
8888

89+
# Explicit scenario
90+
extropy query agents -s congestion-tax --to agents.jsonl
91+
8992
# Network edges
9093
extropy query edges --to edges.jsonl
9194

docs/commands.md

Lines changed: 26 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -357,34 +357,39 @@ Query and export raw data from the study database.
357357
Dump agent attributes.
358358

359359
```bash
360-
extropy query agents # print to stdout
361-
extropy query agents --to agents.jsonl # write JSONL file
360+
extropy query agents # print to stdout (uses latest run's scenario)
361+
extropy query agents --to agents.jsonl # write JSONL file
362+
extropy query agents -s congestion-tax # explicit scenario
362363
```
363364

364-
| Flag | Type | Default | Description |
365-
|------|------|---------|-------------|
366-
| `--to` | path | | Write JSONL to file |
367-
| `--population-id` | string | `default` | Population ID |
365+
| Flag | Short | Type | Default | Description |
366+
|------|-------|------|---------|-------------|
367+
| `--to` | | path | | Write JSONL to file |
368+
| `--scenario` | `-s` | string | auto | Scenario name (resolved from latest run if not specified) |
369+
| `--run-id` | | string | | Simulation run ID (used to resolve scenario if not specified) |
368370

369371
### extropy query edges
370372

371373
Dump network edges.
372374

373375
```bash
374376
extropy query edges --to edges.jsonl
377+
extropy query edges -s congestion-tax --to edges.jsonl
375378
```
376379

377-
| Flag | Type | Default | Description |
378-
|------|------|---------|-------------|
379-
| `--to` | path | | Write JSONL to file |
380-
| `--network-id` | string | `default` | Network ID |
380+
| Flag | Short | Type | Default | Description |
381+
|------|-------|------|---------|-------------|
382+
| `--to` | | path | | Write JSONL to file |
383+
| `--scenario` | `-s` | string | auto | Scenario name (resolved from latest run if not specified) |
384+
| `--run-id` | | string | | Simulation run ID (used to resolve scenario if not specified) |
381385

382386
### extropy query states
383387

384388
Dump agent states for a simulation run.
385389

386390
```bash
387391
extropy query states --to states.jsonl
392+
extropy query states --run-id abc123 --to states.jsonl
388393
```
389394

390395
| Flag | Type | Default | Description |
@@ -398,26 +403,28 @@ Show study entity counts (agents, edges, simulation states, timesteps, events).
398403

399404
```bash
400405
extropy query summary
406+
extropy query summary -s congestion-tax
401407
```
402408

403-
| Flag | Type | Default | Description |
404-
|------|------|---------|-------------|
405-
| `--run-id` | string | latest | Simulation run ID |
406-
| `--population-id` | string | `default` | Population ID |
407-
| `--network-id` | string | `default` | Network ID |
409+
| Flag | Short | Type | Default | Description |
410+
|------|-------|------|---------|-------------|
411+
| `--run-id` | | string | latest | Simulation run ID |
412+
| `--scenario` | `-s` | string | auto | Scenario name (resolved from latest run if not specified) |
408413

409414
### extropy query network
410415

411416
Show network statistics (edge count, average weight, top-degree nodes).
412417

413418
```bash
414419
extropy query network
420+
extropy query network -s congestion-tax
415421
```
416422

417-
| Flag | Type | Default | Description |
418-
|------|------|---------|-------------|
419-
| `--network-id` | string | `default` | Network ID |
420-
| `--top` | int | 10 | Number of top-degree nodes to show |
423+
| Flag | Short | Type | Default | Description |
424+
|------|-------|------|---------|-------------|
425+
| `--scenario` | `-s` | string | auto | Scenario name (resolved from latest run if not specified) |
426+
| `--run-id` | | string | | Simulation run ID (used to resolve scenario if not specified) |
427+
| `--top` | | int | 10 | Number of top-degree nodes to show |
421428

422429
### extropy query network-status \<network-run-id\>
423430

0 commit comments

Comments
 (0)