QFP58

#!/bin/sh
# Run the QFP-58 workflows in the build container; the only host requirement is Docker.
#
#   ./run.sh [--build] [--sim] [--fullsim] [options]     named workflows, run in the order given
#   ./run.sh [options] <command...>                       anything else, e.g. ./run.sh bash
#   ./run.sh                                              same as --build
#
#   --build        boards (RHCP feed in the root, the rest in kicad/), DRC, Gerbers, docs/     (~10 s)
#   --sim          quick check: full model (SMA to far field), coarse mesh, 3.4 Mcells       (~4 min)
#                  gain/S11 within ~0.1 dB of --fullsim, axial ratio only within ~0.4 dB
#   --fullsim      reference: full model, medium mesh, 7.6 Mcells; the README numbers      (~10 min)
#
#   --hand RHCP|LHCP   polarization for the simulations (default RHCP)
#   --res R            override the mesh (coarse|medium|fine) for --sim/--fullsim
#   --tag T            result suffix (default: timestamp, so runs never overwrite each other)
#   --cpus N           use N cores (keeps the machine usable; openEMS gains little beyond ~5)
#   --name N           container name (default qfp58-build; -2, -3, ... appended while that one is running)
#   --detach           run in the background; follow with `docker logs -f <name>`, stop with `docker stop <name>`
#
# Simulation results go to sim_out/full_<hand>_<res>_<tag>/, the log to sim_out/<tag>.log.
# The image is rebuilt when Dockerfile, pyproject.toml or uv.lock change (Docker layer cache otherwise).
set -e
cd "$(dirname "$0")"
IMAGE=qfp58-build

usage() { sed -n '2,21p' "$0" | sed 's/^# \{0,1\}//'; exit "${1:-0}"; }

STEPS= HAND=RHCP RES= TAG=$(date +%Y%m%d-%H%M%S) CPUS= DETACH= NAME=
while [ $# -gt 0 ]; do
    case "$1" in
        --build|--sim|--fullsim) STEPS="$STEPS ${1#--}" ;;
        --hand)   HAND=$2; shift ;;
        --res)    RES=$2; shift ;;
        --tag)    TAG=$2; shift ;;
        --cpus)   CPUS=$2; shift ;;
        --name)   NAME=$2; shift ;;
        --detach) DETACH=1 ;;
        -h|--help) usage ;;
        --) shift; break ;;
        -*) echo "unknown option: $1" >&2; usage 1 >&2 ;;
        *) break ;;
    esac
    shift
done
[ -n "$STEPS" ] && [ $# -gt 0 ] && { echo "give either workflow flags or a command, not both" >&2; exit 1; }
[ -z "$STEPS" ] && [ $# -eq 0 ] && STEPS=build

# the in-container command: one shell line so combined steps share one container (and one log)
if [ -n "$STEPS" ]; then
    THREADS=${CPUS:+--threads $CPUS}
    CMD="set -e"
    for s in $STEPS; do
        case $s in
            build)   CMD="$CMD; echo '== build'; python src/generate.py" ;;
            sim)     CMD="$CMD; echo '== sim: full model, ${RES:-coarse} mesh'
                      python src/qfp_sim.py full --res ${RES:-coarse} --hand $HAND --out sim_out --tag _$TAG $THREADS" ;;
            fullsim) CMD="$CMD; echo '== fullsim: full model, ${RES:-medium} mesh'
                      python src/qfp_sim.py full --res ${RES:-medium} --hand $HAND --out sim_out --tag _$TAG $THREADS" ;;
        esac
    done
    mkdir -p sim_out
    set -- bash -c "set -o pipefail; { $CMD; } 2>&1 | tee sim_out/$TAG.log"
fi

docker image inspect "$IMAGE" >/dev/null 2>&1 || echo "building $IMAGE (first time: ~15 min, openEMS is compiled)" >&2
out=$(docker build -q -t "$IMAGE" . 2>&1) || { echo "$out" >&2; exit 1; }   # instant when cached; output only on failure

# --cpuset-cpus rather than --cpus: openEMS sizes its thread pool from the visible cores
# container name: fixed and recognizable in `docker ps`; the default steps aside for a run already in progress
taken() { docker container inspect "$1" >/dev/null 2>&1; }
if [ -n "$NAME" ]; then
    if taken "$NAME"; then echo "container name '$NAME' is in use (docker ps -a)" >&2; exit 1; fi
else
    NAME=$IMAGE; i=2
    while taken "$NAME"; do NAME=$IMAGE-$i; i=$((i + 1)); done
fi

LIMIT=${CPUS:+--cpuset-cpus=0-$((CPUS - 1))}
run() { docker run --rm --name "$NAME" --user "$(id -u):$(id -g)" -v "$PWD":/work -w /work ${LIMIT:+"$LIMIT"} "$@"; }
if [ -n "$DETACH" ]; then
    run -d "$IMAGE" "$@" >/dev/null
    echo "started $NAME: follow with 'docker logs -f $NAME', stop with 'docker stop $NAME'"
    if [ -n "$STEPS" ]; then echo "log also in sim_out/$TAG.log"; fi
else
    [ -t 0 ] && [ -t 1 ] && TTY=-t || TTY=
    run -i $TTY "$IMAGE" "$@"
fi