RUA

🇺🇸 English · 🇷🇺 Русский

RUA downloads the history of territorial control changes from DeepStateMap, builds a trend forecast, and generates an interactive HTML report.

View the published report

Install and run

RUA is a command-line application. It has one required option: the path to a configuration file.

Prebuilt binaries

Download the archive for your system from the latest GitHub release:

System	Archive
Linux x86_64 (most distributions)	rua-linux-x86_64-gnu.tar.gz
Linux x86_64 (musl, including Alpine)	rua-linux-x86_64-musl.tar.gz
Windows x86_64	rua-windows-x86_64-msvc.zip
macOS Apple Silicon	rua-macos-aarch64.tar.gz

Each archive contains the executable only. Download the example config.toml, place it in your working directory, and extract the archive there.

On Linux or macOS, run:

./rua --config config.toml

On Windows PowerShell, run:

.\rua.exe --config .\config.toml

Install from source

Install the latest version from GitHub with a stable Rust toolchain:

cargo install --git https://github.com/hexqnt/rua --locked
rua --config config.toml

Cargo installs rua into its binary directory, which must be included in PATH. The configuration file is not installed automatically; download config.toml separately.

Configuration

The repository includes a ready-to-use config.toml. Its mode field selects the operation:

Mode	Result
run	Download history, build a forecast, and generate the HTML report
download	Download history to CSV only
forecast	Read a history CSV and write a forecast CSV
render	Generate the HTML report from history and forecast CSV files

Relative paths in the configuration file are resolved from the directory in which RUA is launched. With the example configuration, the complete report is written to dist/index.html. The generated page loads Plotly and country flags from a CDN, so it needs an internet connection when opened.

Set archive_csv = true to compress generated CSV files as .csv.gz. Chart, forecast, and output settings can be adjusted in their corresponding sections of the configuration file.

Library use

The rua::deepstatemap module provides a typed asynchronous client for loading DeepStateMap history. To use it without the CLI and reporting dependencies:

[dependencies]
rua = { git = "https://github.com/hexqnt/rua", default-features = false }

Technical notes about the forecast model are available in Model.md (in Russian).

License

Licensed under either the Apache License 2.0 or the MIT License, at your option.