Install and build

Build from the workspace or use its local release bundle. Neither crate has been published to a package registry. The source uses Rust edition 2024; the verified toolchain is Rust 1.97.1 on x86_64 Linux. Other toolchains and targets require their own validation.

Source checkout

You need Rust and Cargo, a C compiler for bundled SQLite, and Python for the integration example and release tools. The release and documentation scripts require Python 3.11+. The books use mdBook 0.5.2.

CARGO_TARGET_DIR=target cargo build --workspace --locked
python3 examples/agent_demo.py

The core supercast crate has no runtime or development dependencies. supercast-agent adds Serde/JSON, Schemars, and rusqlite with SQLite bundled. The lockfile fixes the resolved dependency versions for reproducible builds.

With dependencies cached, use --offline. On a fresh connected machine, fetch them first:

cargo fetch --locked
cargo install mdbook --version 0.5.2 --locked
bash scripts/check.sh

The check script forces compilation into the checkout’s target directory unless SUPERCAST_TARGET_DIR is set. This prevents an inherited CARGO_TARGET_DIR pointing to an unavailable shared location from breaking the documented checks.

Rust dependency

For another local Rust project, add a path dependency:

[dependencies]
supercast = { path = "/path/to/supercast" }

Call the numerical and workflow modules directly. The core is synchronous and does not select an async runtime. For the adapter’s Store and protocol executor, depend on the separate crates/supercast-agent path.

Release bundle

Extract the host-specific archive and read RUN.md. The executable is optimized for the build host’s target and uses its system libraries; it is not a universal static binary. SQLite itself is bundled.

./supercast-agent --version
./supercast-agent --schema
python3 examples/agent_demo.py --binary ./supercast-agent
./supercast-agent --db forecasts.sqlite3

Use --memory when persistence is intentionally unnecessary. The database path is explicit; the process does not select an implicit home-directory database. Opening a new database initializes its schema, even before the first request.

Build the books

CARGO_TARGET_DIR=target cargo build --workspace --locked --offline
python3 scripts/docs.py

This executes all operation examples, generates the API chapters, builds both books, tests their Rust snippets, and checks rendered local links. Open the resulting local HTML files or serve them with mdBook during editing. python3 scripts/docs.py --check verifies generated source without rewriting it.