Command Cheatsheet

Compact command list for the full path: dataset → simulation (kub-simulate) → dashboard.

--cemdb-root can be omitted in many cases:

  • If the current directory contains ./cemdb, kub-dataset and kub-simulate use the default cemdb/locations.

  • kub-dashboard auto-detects ./cemdb.

CEMDB_ROOT environment variable:

  • kub-dashboard uses CEMDB_ROOT as its default CEMDB path.

  • For kub-dataset and kub-simulate, use --cemdb-root when your data is not under ./cemdb/locations.

1. Dataset

kub-dataset list-dmps
kub-dataset list-locations --show-versions
kub-dataset pull arz --version 0.1.0 --cemdb-root cemdb/locations --dmp girder-unistra --api-key "$GIRDER_API_KEY"
kub-dataset pull-simulator --version 0.2.0 --cemdb-root cemdb --force
kub-dataset summary arz --cemdb-root cemdb/locations

2. Simulation Config (kub-simulate)

kub-simulate config init
kub-simulate config set cemdb_root cemdb/locations
APPT=/opt/apptainer/latest/bin/apptainer
$APPT pull kub-master.sif oras://ghcr.io/feelpp/ktirio-urban-building:master-sif
kub-simulate config set launcher slurm --profile-target apptainer-slurm
kub-simulate config set partition public --profile-target apptainer-slurm
kub-simulate config set runtime apptainer --profile-target apptainer-slurm
kub-simulate config set apptainer_exec $APPT --profile-target apptainer-slurm
kub-simulate config set apptainer_image ./kub-master.sif --profile-target apptainer-slurm
kub-simulate config set launcher local --profile-target apptainer-local
kub-simulate config set runtime apptainer --profile-target apptainer-local
kub-simulate config set apptainer_exec $APPT --profile-target apptainer-local
kub-simulate config set apptainer_image ./kub-master.sif --profile-target apptainer-local
kub-simulate config show
# Keep dataset version explicit in commands: --version 0.1.0

3. Simulation (kub-simulate, Apptainer)

kub-simulate preprocess arz --version 0.1.0 --profile apptainer-slurm --partitions 32 64 128
kub-simulate preprocess arz --version 0.1.0 --profile apptainer-local --partitions 32 64 128
kub-simulate run arz --version 0.1.0 --profile apptainer-slurm --np 128
kub-simulate run arz --version 0.1.0 --profile apptainer-local --np 128
kub-simulate status arz --version 0.1.0 --cemdb-root cemdb/locations --last 10

4. Validation

kub-dataset manifest-validate --strict cemdb/locations/arz/v0.1.0/simulations/single/run_YYYY-MM-DD_HH-MM-SS/manifest.json

5. Dashboard

kub-dashboard index --cemdb-root cemdb --refresh
kub-dashboard serve --cemdb-root cemdb --host 127.0.0.1 --port 8050

6. Useful Links