Add gdml-to-dot and improve celer-geo

app/celer-geo/GeoInput.cc

@@ -61,11 +61,11 @@ void from_json(nlohmann::json const& j, ModelSetup& v)
 
 void from_json(nlohmann::json const& j, TraceSetup& v)
 {
-    if (auto iter = j.find("geometry"); iter != j.end())
+    if (auto iter = j.find("geometry"); iter != j.end() && !iter->is_null())
     {
         v.geometry = to_geometry(iter->get<std::string>());
     }
-    if (auto iter = j.find("memspace"); iter != j.end())
+    if (auto iter = j.find("memspace"); iter != j.end() && !iter->is_null())
     {
         v.memspace = to_memspace(iter->get<std::string>());
     }

app/celer-geo/celer-geo.cc

@@ -204,7 +204,8 @@ void run(std::istream& is)
         {
             CELER_LOG(error)
                 << "Invalid trace setup; expected structure written "
-                   "to stdout";
+                   "to stdout ("
+                << e.what() << ")";
             json temp = TraceSetup{};
             temp["image"] = ImageInput{};
             std::cout << json(temp).dump() << std::endl;

scripts/user/.gitignore

@@ -0,0 +1,2 @@
+*.dot
+*.pdf

scripts/user/gdml-to-dot.py

@@ -0,0 +1,106 @@
+#!/usr/bin/env python3
+# Copyright 2023 UT-Battelle, LLC, and other Celeritas developers.
+# See the top-level COPYRIGHT file for details.
+# SPDX-License-Identifier: (Apache-2.0 OR MIT)
+"""
+Generate a GraphViz DAG of GDML logical volume relationships.
+
+The resulting output file can be converted to a PDF file with, e.g.::
+
+    dot -Tpdf:quartz demo.gdml.dot -o demo.pdf
+
+"""
+
+import json
+import re
+import xml.etree.ElementTree as ET
+import networkx as nx
+
+from collections import defaultdict
+from pathlib import Path
+
+class PointerReplacer:
+    sub = re.compile(r'0x[0-9a-f]{4,}').sub
+
+    def __init__(self):
+        self.addrs = {}
+
+    def repl(self, match):
+        val = self.addrs.setdefault(match.group(0), len(self.addrs))
+        return f"@{val:d}"
+
+    def __call__(self, s):
+        return self.sub(self.repl, s)
+
+class Graph:
+    def __init__(self):
+        self.nodes = []
+        self.edges = defaultdict(int)
+        self.replace_pointers = PointerReplacer()
+
+    def add_volume(self, el):
+        edges = self.edges
+
+        pname = self.replace_pointers(el.attrib["name"])
+        self.nodes.append(pname)
+        for vrel in el.iter("volumeref"):
+            dname = self.replace_pointers(vrel.attrib["ref"])
+            edges[(pname, dname)] += 1
+
+    def add_world(self, vrel):
+        pname = self.replace_pointers(vrel.attrib["ref"])
+        self.nodes.append(pname)
+
+    @property
+    def weighted_edges(self):
+        for ((u, v), weight) in self.edges.items():
+            yield (u, v, weight)
+
+    @property
+    def labeled_edges(self):
+        for ((u, v), weight) in self.edges.items():
+            yield (u, v, ("" if weight == 1 else f"×{weight}"))
+
+    @property
+    def pointer_addresses(self):
+        return self.replace_pointers.addrs
+
+def read_graph(filename):
+    tree = ET.parse(filename)
+    structure = next(tree.iter("structure"))
+
+    g = Graph()
+    for el in structure:
+        if el.tag in ('volume', 'assembly'):
+            g.add_volume(el)
+        else:
+            raise ValueError(f"Unrecognized structure tag: {el!r}")
+    g.add_world(tree.findall("./setup/world")[0])
+
+    return g
+
+def write_graph(g, filename):
+    graph = nx.DiGraph()
+    graph.add_nodes_from(reversed(g.nodes))
+    graph.add_weighted_edges_from(g.labeled_edges, weight='label')
+    graph.graph['graph']={'rankdir':'LR'}
+    nx.nx_pydot.write_dot(graph, filename)
+
+    with open(filename, 'a') as f:
+        f.write("// Pointer mapping:\n")
+        addrs = g.pointer_addresses.items()
+        for (idx, addr) in sorted((v, k) for (k, v) in addrs):
+            f.write(f"// {idx:04d}: {addr}\n")
+
+def main(*args):
+    from argparse import ArgumentParser
+    parser = ArgumentParser(description=__doc__, prog="gdml-to-dot")
+    parser.add_argument('-o', '--output')
+    parser.add_argument('input')
+    ns = parser.parse_args(*args)
+    input = Path(ns.input)
+    g = read_graph(input)
+    write_graph(g, ns.output or (input.stem + ".dot"))
+
+if __name__ == "__main__":
+    main()

scripts/user/orange-csg-to-dot.py

@@ -74,7 +74,7 @@ def main():
     if not args.output:
         outfile = sys.stdout
     else:
-        outfile = open(args.output)
+        outfile = open(args.output, 'w')
 
     run(infile, outfile)
 

src/geocel/rasterize/Image.cc

@@ -32,9 +32,6 @@ ImageParams::ImageParams(ImageInput const& inp)
     CELER_VALIDATE(ArraySoftUnit{real_type{0.001}}(inp.rightward),
                    << "rightward axis " << repr(inp.rightward)
                    << " is not a unit vector");
-    CELER_VALIDATE(!(inp.lower_left == inp.upper_right),
-                   << "lower left corner " << repr(inp.lower_left)
-                   << " and upper right corner cannot be the same");
     CELER_VALIDATE(inp.vertical_pixels > 0,
                    << "number of pixels must be positive");
     CELER_VALIDATE(inp.horizontal_divisor > 0,
@@ -66,7 +63,8 @@ ImageParams::ImageParams(ImageInput const& inp)
     // Calculate length along each axis
     real_type width_x = dot_product(diagonal, scalars.right);
     real_type width_y = -dot_product(diagonal, scalars.down);
-    CELER_ASSERT(width_x > 0 && width_y > 0);
+    CELER_VALIDATE(width_x > 0 && width_y > 0,
+                   << "window coordinates result in a degenerate window");
     scalars.max_length = width_x;
 
     // Set number of pixels in each direction.

test/orange/Orange.test.cc

@@ -17,7 +17,6 @@
 
 #include "OrangeGeoTestBase.hh"
 #include "TestMacros.hh"
-#include "celeritas_test.hh"
 
 using celeritas::constants::sqrt_two;
 

test/orange/OrangeGeant.test.cc

@@ -13,7 +13,6 @@
 
 #include "OrangeGeoTestBase.hh"
 #include "TestMacros.hh"
-#include "celeritas_test.hh"
 
 namespace celeritas
 {

test/orange/OrangeJson.test.cc

@@ -20,7 +20,6 @@
 
 #include "OrangeGeoTestBase.hh"
 #include "TestMacros.hh"
-#include "celeritas_test.hh"
 
 namespace celeritas
 {

test/orange/OrangeShift.test.cc

@@ -19,7 +19,6 @@
 
 #include "OrangeGeoTestBase.hh"
 #include "TestMacros.hh"
-#include "celeritas_test.hh"
 
 namespace celeritas
 {