Getting Started

Complete guide to installing RoASt, configuring executions, and running your first synthesis.

1. Installation

Install Rust using the official instructions:
https://rust-lang.org/tools/install

This project uses Rust 1.83.0 or later.

# Clone the repository
git clone https://github.com/luminousrobots/RoASt.git
cd RoASt

2. Configuration

Default Configuration Available

A default config.json is already included in the project (Exec1 | Algo1 | Pole | Goals1 | Main config). You can skip this step and proceed directly to execution.

If you want to customize the configuration, use the online Configuration Wizard:

Configuration Wizard →

The wizard includes execution presets that you can choose from and modify. Follow the instructions to adjust your parameters, then download the generated config.json file and replace the existing one in the RoASt project folder.

View pre-configured execution presets on the Executions page.

3. Execution

Run RoASt:

cargo run --release

You'll see progress logs:

user@PC:~/RoASt$ cargo rel
   Compiling RoAst v0.1.0 (/home/user/RoASt)
    Finished `release` profile [optimized + debuginfo] target(s) in 0.03s
     Running `target/release/RoAst`
╔══════════════════════════════════════════════════════════════════════════════╗
║                           CONFIGURATION DISPLAY                           ║
╚══════════════════════════════════════════════════════════════════════════════╝

Results are saved in timestamped folders:

results/Execution_YYYY-MM-DD_HH-MM-SS/

See the Results Guide to understand the output structure and viewers.

4. Advanced

RoASt provides additional command line options for caching, classification, validation, and more. Run cargo run --release -- --help to see all available options.

Next Steps

Explore the Results Guide to understand execution outputs and viewers.