Skip to content

Getting Started

Oguzhan KAYNAK edited this page Nov 15, 2026 · 2 revisions

Getting started

Requirements: Linux, a C++17 compiler (GCC 11+ or Clang 14+), CMake 3.25+, Ninja. Python 3 with numpy for the comparisons with the reference (optional; without it those tests are skipped).

Build and test

git clone https://github.com/oguzhankynk/gridlane.git && cd gridlane
cmake --preset debug && cmake --build --preset debug && ctest --preset debug

The layers are fetched at their tagged releases (pushseg v0.1.0, pairring v0.1.0, wireforge v0.5.1). To work on a layer at the same time, point CMake at your checkout:

cmake --preset debug -DFETCHCONTENT_SOURCE_DIR_PUSHSEG=../pushseg \
                     -DFETCHCONTENT_SOURCE_DIR_PAIRRING=../pairring

Run the demonstrator

cmake --preset release && cmake --build --preset release

# 2 targets (simulated by processes) × 1 application × 4 workers, over TCP
scripts/run_local.sh --bin build/release/apps --layout 0:0:4,1:0:4 \
    --sim 6 --analysis 2 --link tcp --out /tmp/gs --compare

# the same over shared memory, and a byte comparison of the two
scripts/portability_demo.sh --bin build/release/apps

# an image of the V field
python3 python/render.py --run /tmp/gs --out v.png

Options of run_local.sh: --width, --height, --steps, --every (snapshot interval), --seed. Each worker's log is in worker-<target>-<application>.log in the output directory.

Change the control messages

pip install wireforge==0.5.1
# edit model/project.yaml
scripts/regenerate.sh

Checks

scripts/run_checks.sh runs everything CI runs: formatting, clang-tidy, cppcheck, documentation coverage, tests in debug, ASan + UBSan, TSan, coverage, and an install with find_package(gridlane).

Clone this wiki locally