Quickstart

This page is the shortest path from a fresh checkout to a validated run. If you are new to PILOTS, build the executable, validate a small config, then move to Configuration, Selections, and Measures Reference.

Build

PILOTS uses CMake.

cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
cmake --build build -j

The executable will be available as build/pilots.

Run

PILOTS is configured with an INI file.

./build/pilots --config path/to/run.ini

Useful first-run commands:

List the currently registered measure types:
```
./build/pilots --list-measures
```
Validate a configuration before processing the trajectory:
```
./build/pilots --config run.ini --validate-config
```

Run with an explicit thread count:

./build/pilots --config run.ini --threads 8

View the manual

This repository contains a prebuilt manual under docs/manual/. Open docs/manual/index.html in a browser.

Rebuild the manual locally

To rebuild the HTML manual with Sphinx:

python -m pip install -r docs/sphinx/requirements.txt
sphinx-build -b html docs/sphinx/source docs/manual

Python integration

If you prefer a Python-first workflow for config generation and result loading, see Python.