KUB CLI Tutorial

This tutorial is a practical, command-first path for Ktirio Urban Building users: prepare datasets with kub-dataset, run simulations with kub-simulate, and inspect outputs with kub-dashboard.

The simulation execution path in this tutorial is kub-simulate only. Do not run feelpp_kub_cem directly in this end-user workflow.

1. At a Glance

Item Value

Target location

arz

Target dataset version

0.1.0

Target simulator dataset version

0.2.0

CEMDB locations root

cemdb/locations

Default MPI tasks in examples

128

2. Workflow Map

tutorial-flow

3. Step Cards

1. Dataset Setup
Use kub-dataset to list sources, pull a location version, and validate manifests before submission.

2. Simulation Submit
Use kub-simulate preprocess and kub-simulate run; do not run feelpp_kub_cem directly in this workflow.

3. Runtime Choice
This tutorial uses Apptainer runtime only (kub-simulate --runtime apptainer) with either Slurm or local launchers.

4. Dashboard Review
Use kub-dashboard index and kub-dashboard serve to inspect run outputs and location summaries.

4. What You Will Build

  • A local, versioned dataset under cemdb/locations/<location>/vX.Y.Z

  • A simulation run tracked under simulations/single/run_*

  • A browsable dashboard view for runs and location-level data

5. Tutorial Path

  1. Check prerequisites and environment

  2. Prepare dataset and verify local state

  3. Submit preprocessing and simulation with kub-simulate (Apptainer profiles)

  4. Run kub-simulate with Apptainer local/slurm launchers

  5. Index and serve dashboard pages

  6. Validate manifests and troubleshoot

  7. Use the compact command cheatsheet