Packages and architecture
The easiest way to understand XRTM is to separate the product shell from the package stack underneath it.
Source of truth boundaries
This section is a repo map, not the canonical package manual. Change shipped CLI behavior in xrtm-org/xrtm, change package APIs or examples in the owning package repo, and change schemas or compatibility rules in xrtm-org/governance.
Start with the product shell
For most newcomers, the right first step is the top-level xrtm product experience on the released 0.3.1 surface:
- run
xrtm start - inspect the created run with
xrtm runs show latest --runs-dir runs,xrtm artifacts inspect --latest --runs-dir runs, andxrtm report html --latest --runs-dir runs - open the same run in the WebUI or TUI
- move into repeatable workflows with profiles, compare/export, and monitor commands
See Getting started for that path.
The package map
| Layer | Package | What it gives you today | Canonical reference |
|---|---|---|---|
| Product shell | xrtm | Provider-free demo path, reports, canonical artifacts, WebUI, TUI, profiles, compare/export, and local monitoring | README.md, docs/python-api-reference.md |
| Runtime | xrtm-forecast | Forecasting agents, orchestration, provider integrations, and source examples | README.md, docs/index.md |
| Evaluation | xrtm-eval | Brier scoring, calibration-focused evaluation, and verification utilities | xrtm-org/eval |
| Data | xrtm-data | Schemas and temporal snapshot foundations for zero-leakage evaluation | xrtm-org/data |
| Training | xrtm-train | Backtesting, replay, calibration demos, and optimization loops | xrtm-org/train |
How the pieces fit
xrtmis the newcomer-facing product shell.xrtm-forecasthandles the runtime and orchestration layer.xrtm-evalandxrtm-dataprovide the scoring and snapshot foundations.xrtm-traincloses the loop for replay, calibration, and evaluation harnesses.
Fast entry-point rule
- Choose
xrtmwhen you want the honest released workflow and provider-free first success. - Choose
xrtm-forecastwhen you want to call forecasting APIs directly from your own code.
What xrtm.org does here
- explain the package boundaries in one place
- send you to the right owning repo quickly
- keep released docs, next-release summaries, and governance policy clearly separated
It does not replace the owning repo's README, API docs, examples, or policy files.
When to update this site vs a sibling repo
- Update
xrtm.orgfor newcomer framing, navigation, and cross-repo pointers. - Update the owning repo for shipped behavior, package APIs, example code, or release notes.
- Update governance first for schema or compatibility policy changes, then mirror the accepted outcome here if newcomers need the summary.