dusk

dusk is an OCCT-based replacement for the legacy dawn detector visualization tool. It reads STEP files (.stp) and produces SVG vector graphics of cross-section and perspective/isometric views.

A companion tool duskcut mirrors the dawncut cutting-plane utility.

mkdir build && cd build
cmake .. -DCMAKE_BUILD_TYPE=Release
make -j$(nproc)

dusk -d detector.stp [options]

View parameters are read from .DAWN_1.history in the current directory (same format as dawn, so dawn_tweak can be used directly). CLI flags override the history file:

duskcut nx ny nz d input.stp [output.stp]

Same interface as dawncut. The plane n·x = d (mm) cuts the geometry; the half n·x ≤ d is retained.

Example — cross-section at x=0 keeping negative-x half:

duskcut -1 0 0 0 detector.stp half.stp

The existing generate_eps scripts in eic/epic/scripts/view*/ can be adapted by replacing:

• dawncut → duskcut
• dawn -d file.prim → dusk -d file.stp
• .prim input → .stp input (from convert-to-step CI job)

The dawn_tweak script works unchanged.

Requires OpenCASCADE 7.x (tested with 7.9.1). In the EIC software environment (eic-shell) it is available at /opt/software/linux-x86_64_v2/opencascade-7.9.1-*/.

Unit tests cover parser and SVG writer logic and do not require OCCT.

cmake -S . -B build-tests -DDUSK_BUILD_APPS=OFF -DDUSK_ENABLE_TESTS=ON
cmake --build build-tests --target unit_tests
ctest --test-dir build-tests --output-on-failure

To enable gcov/lcov instrumentation locally:

cmake -S . -B build-tests \
  -DDUSK_BUILD_APPS=OFF \
  -DDUSK_ENABLE_TESTS=ON \
  -DDUSK_ENABLE_COVERAGE=ON \
  -DCMAKE_BUILD_TYPE=Debug

CI runs these tests and uploads coverage via Codecov.

dusk uses clang-format, clang-tidy, and pre-commit in CI.

Set up local hooks:

pip install pre-commit
pre-commit install

Run formatting and checks locally before pushing:

pre-commit run --all-files

CI behavior:

• pre-commit enforces formatting and hygiene checks.
• For same-repository pull requests, CI auto-commits pre-commit fixes back to the PR branch.
• clang-tidy runs in CI and posts fix suggestions as pull request comments.

LGPL 2.1

Docs are served with Docsify at:

• https://eic.github.io/dusk/

The CI-generated NIST sample gallery is published at:

• https://eic.github.io/dusk/reports/geometry-images.html