Metadata-Version: 2.4
Name: xrtm
Version: 0.7.0
Summary: The xRtm Framework (Generative Forecasting).
Author-email: XRTM Team <moy@xrtm.org>
License-Expression: Apache-2.0
Project-URL: Repository, https://github.com/xrtm-org/xrtm
Project-URL: Documentation, https://xrtm.org
Project-URL: Issues, https://github.com/xrtm-org/xrtm/issues
Requires-Python: <3.13,>=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click>=8.0.0
Requires-Dist: rich>=13.0.0
Requires-Dist: xrtm-data>=0.2.6
Requires-Dist: xrtm-eval>=0.2.6
Requires-Dist: xrtm-forecast>=0.6.10
Requires-Dist: xrtm-train>=0.2.7
Dynamic: license-file

# XRTM: AI for event forecasting

[![PyPI](https://img.shields.io/pypi/v/xrtm?style=flat-square)](https://pypi.org/project/xrtm/)
[![License](https://img.shields.io/badge/license-Apache%202.0-blue?style=flat-square)](LICENSE)

**XRTM** is the product-first shell for running event-forecasting workflows,
inspecting the scored artifacts, and reviewing the latest run in the WebUI or
TUI.

## Start here

If you arrived from xrtm.org, PyPI, or this repository, use the authoritative
first-success guide: [docs/getting-started.md](docs/getting-started.md).

That guide walks the released `xrtm==0.7.0` journey in one place:

1. install XRTM
2. run `xrtm start`
3. inspect the latest run
4. open the editable workflow workbench
5. clone, safely edit, validate, run, and compare a workflow
6. choose your next path

This README intentionally stays short so the first-run commands live in one
place.

## After your first successful run

- **Researcher:** use the [researcher workflow on xrtm.org](https://xrtm.org/docs/workflows/researcher-model-eval)
- **Operator:** continue with the [Operator Runbook](docs/operator-runbook.md)
- **Developer:** move to the [Python API Reference](docs/python-api-reference.md) and [integration examples](examples/integration/)

## Documentation

- [Getting Started Guide](docs/getting-started.md)
- [Operator Runbook](docs/operator-runbook.md)
- [Python API Reference](docs/python-api-reference.md)
- [Integration Examples](examples/integration/)
- [Next-release Feature Track](docs/next-release-feature-track.md) for source-only work that is not part of the published `xrtm==0.7.0` package
- Full documentation: [xrtm.org](https://xrtm.org)

## License

Apache 2.0 — see [LICENSE](LICENSE) for details.
