Merge pull request #483 from beomki-yeo/default-simulation

Add a General Simulator

Author: beomki-yeo

README.md

@@ -277,7 +277,7 @@ cmake --build <build_directory> <options>
 
 ### Running a partial chain with simplified simulation data
 
-Users can generate muon-like particle simulation data by running following example commands:
+Users can generate muon-like particle simulation data with the pre-built detray geometries:
 
 ```sh
 # Generate telescope geometry data
@@ -292,6 +292,13 @@ Users can generate muon-like particle simulation data by running following examp
 
 The simulation will also generate the detector json files (geometry, material and surface_grid) in the current directory. It is user's responsibility to move them to an appropriate place (e.g. `<detector_directory>`) and match them to the input file arguments of reconstruction chains.
 
+If users have a geometry json file already, it is also possible to run simulation with `traccc_simulate` application 
+
+```sh
+# Given that users have a geometry json file
+<build_directory>/bin/traccc_simulate  --output_directory=<output_directory>  --detector_file=<geometry_file> --material_file=<material_file> --grid_file=<grid_file>  --event=10 --constraint-step-size-mm=1
+```
+
 There are three types of partial reconstruction chain users can operate: `seeding_example`, `truth_finding_example`, and `truth_fitting_example` where their algorithm coverages are shown in the table below. Each of them starts from truth measurements, truth seeds, and truth tracks, respectively.
 
 | Category                | Clusterization | Seeding | Track finding | Track fitting |

examples/options/CMakeLists.txt

@@ -8,6 +8,7 @@
 traccc_add_library( traccc_options options TYPE SHARED
   # header files
   "include/traccc/options/common_options.hpp"
+  "include/traccc/options/detector_input_options.hpp"
   "include/traccc/options/handle_argument_errors.hpp"
   "include/traccc/options/mt_options.hpp"
   "include/traccc/options/options.hpp"
@@ -19,6 +20,7 @@ traccc_add_library( traccc_options options TYPE SHARED
   "include/traccc/options/throughput_options.hpp"
   # source files
   "src/options/common_options.cpp"
+  "src/options/detector_input_options.cpp"
   "src/options/handle_argument_errors.cpp"
   "src/options/mt_options.cpp"
   "src/options/seeding_input_options.cpp"

examples/options/include/traccc/options/common_options.hpp

@@ -22,9 +22,6 @@ struct common_options {
     int skip;
     unsigned short target_cells_per_partition;
     bool check_performance;
-    std::string detector_file;
-    std::string material_file;
-    std::string grid_file;
 
     common_options(po::options_description& desc);
     void read(const po::variables_map& vm);

examples/options/include/traccc/options/detector_input_options.hpp

@@ -0,0 +1,24 @@
+/** TRACCC library, part of the ACTS project (R&D line)
+ *
+ * (c) 2023 CERN for the benefit of the ACTS project
+ *
+ * Mozilla Public License Version 2.0
+ */
+
+// Boost
+#include <boost/program_options.hpp>
+
+namespace traccc {
+
+namespace po = boost::program_options;
+
+struct detector_input_options {
+    std::string detector_file;
+    std::string material_file;
+    std::string grid_file;
+
+    detector_input_options(po::options_description& desc);
+    void read(const po::variables_map& vm);
+};
+
+}  // namespace traccc

examples/options/src/options/common_options.cpp

@@ -26,12 +26,6 @@ traccc::common_options::common_options(po::options_description& desc) {
     desc.add_options()("check_performance",
                        po::value<bool>()->default_value(false),
                        "generate performance result");
-    desc.add_options()("detector_file", po::value<std::string>()->required(),
-                       "specify detector file");
-    desc.add_options()("material_file", po::value<std::string>()->required(),
-                       "specify material file");
-    desc.add_options()("grid_file", po::value<std::string>()->required(),
-                       "specify surface grid file");
 }
 
 void traccc::common_options::read(const po::variables_map& vm) {
@@ -47,11 +41,4 @@ void traccc::common_options::read(const po::variables_map& vm) {
     target_cells_per_partition =
         vm["target_cells_per_partition"].as<unsigned short>();
     check_performance = vm["check_performance"].as<bool>();
-    detector_file = vm["detector_file"].as<std::string>();
-    if (vm.count("material_file")) {
-        material_file = vm["material_file"].as<std::string>();
-    }
-    if (vm.count("grid_file")) {
-        grid_file = vm["grid_file"].as<std::string>();
-    }
 }

examples/options/src/options/detector_input_options.cpp

@@ -0,0 +1,30 @@
+/** TRACCC library, part of the ACTS project (R&D line)
+ *
+ * (c) 2023 CERN for the benefit of the ACTS project
+ *
+ * Mozilla Public License Version 2.0
+ */
+
+// options
+#include "traccc/options/detector_input_options.hpp"
+
+traccc::detector_input_options::detector_input_options(
+    po::options_description& desc) {
+    desc.add_options()("detector_file", po::value<std::string>()->required(),
+                       "specify detector file");
+    desc.add_options()("material_file", po::value<std::string>(),
+                       "specify material file");
+    desc.add_options()("grid_file", po::value<std::string>(),
+                       "specify surface grid file");
+}
+
+void traccc::detector_input_options::read(const po::variables_map& vm) {
+
+    detector_file = vm["detector_file"].as<std::string>();
+    if (vm.count("material_file")) {
+        material_file = vm["material_file"].as<std::string>();
+    }
+    if (vm.count("grid_file")) {
+        grid_file = vm["grid_file"].as<std::string>();
+    }
+}

examples/run/alpaka/seeding_example_alpaka.cpp

@@ -12,6 +12,7 @@
 #include "traccc/io/read_geometry.hpp"
 #include "traccc/io/read_spacepoints.hpp"
 #include "traccc/options/common_options.hpp"
+#include "traccc/options/detector_input_options.hpp"
 #include "traccc/options/handle_argument_errors.hpp"
 #include "traccc/options/seeding_input_options.hpp"
 #include "traccc/performance/collection_comparator.hpp"
@@ -37,11 +38,11 @@
 namespace po = boost::program_options;
 
 int seq_run(const traccc::seeding_input_config& /*i_cfg*/,
-            const traccc::common_options& common_opts, bool run_cpu) {
+            const traccc::common_options& common_opts,
+            const traccc::detector_input_options& det_opts, bool run_cpu) {
 
     // Read the surface transforms
-    auto surface_transforms =
-        traccc::io::read_geometry(common_opts.detector_file);
+    auto surface_transforms = traccc::io::read_geometry(det_opts.detector_file);
 
     // Output stats
     uint64_t n_modules = 0;
@@ -171,6 +172,7 @@ int main(int argc, char* argv[]) {
     // Add options
     desc.add_options()("help,h", "Give some help with the program's options");
     traccc::common_options common_opts(desc);
+    traccc::detector_input_options det_opts(desc);
     traccc::seeding_input_config seeding_input_cfg(desc);
     desc.add_options()("run_cpu", po::value<bool>()->default_value(false),
                        "run cpu tracking as well");
@@ -183,14 +185,16 @@ int main(int argc, char* argv[]) {
 
     // Read options
     common_opts.read(vm);
+    det_opts.read(vm);
+
     seeding_input_cfg.read(vm);
     auto run_cpu = vm["run_cpu"].as<bool>();
 
-    std::cout << "Running " << argv[0] << " " << common_opts.detector_file
-              << " " << common_opts.input_directory << " " << common_opts.events
+    std::cout << "Running " << argv[0] << " " << det_opts.detector_file << " "
+              << common_opts.input_directory << " " << common_opts.events
               << std::endl;
 
-    int ret = seq_run(seeding_input_cfg, common_opts, run_cpu);
+    int ret = seq_run(seeding_input_cfg, common_opts, det_opts, run_cpu);
 
     return ret;
 }

examples/run/cpu/seeding_example.cpp

@@ -28,6 +28,7 @@
 
 // options
 #include "traccc/options/common_options.hpp"
+#include "traccc/options/detector_input_options.hpp"
 #include "traccc/options/finding_input_options.hpp"
 #include "traccc/options/handle_argument_errors.hpp"
 #include "traccc/options/propagation_options.hpp"
@@ -54,7 +55,8 @@ namespace po = boost::program_options;
 int seq_run(const traccc::seeding_input_config& /*i_cfg*/,
             const traccc::finding_input_config& finding_cfg,
             const traccc::propagation_options<traccc::scalar>& propagation_opts,
-            const traccc::common_options& common_opts) {
+            const traccc::common_options& common_opts,
+            const traccc::detector_input_options& det_opts) {
 
     /// Type declarations
     using host_detector_type = detray::detector<>;
@@ -97,10 +99,9 @@ int seq_run(const traccc::seeding_input_config& /*i_cfg*/,
 
     // Read the detector
     detray::io::detector_reader_config reader_cfg{};
-    reader_cfg
-        .add_file(traccc::io::data_directory() + common_opts.detector_file)
-        .add_file(traccc::io::data_directory() + common_opts.material_file)
-        .add_file(traccc::io::data_directory() + common_opts.grid_file);
+    reader_cfg.add_file(traccc::io::data_directory() + det_opts.detector_file)
+        .add_file(traccc::io::data_directory() + det_opts.material_file)
+        .add_file(traccc::io::data_directory() + det_opts.grid_file);
 
     auto [host_det, names] =
         detray::io::read_detector<host_detector_type>(host_mr, reader_cfg);
@@ -247,6 +248,7 @@ int main(int argc, char* argv[]) {
     // Add options
     desc.add_options()("help,h", "Give some help with the program's options");
     traccc::common_options common_opts(desc);
+    traccc::detector_input_options det_opts(desc);
     traccc::seeding_input_config seeding_input_cfg(desc);
     traccc::finding_input_config finding_input_cfg(desc);
     traccc::propagation_options<traccc::scalar> propagation_opts(desc);
@@ -259,14 +261,15 @@ int main(int argc, char* argv[]) {
 
     // Read options
     common_opts.read(vm);
+    det_opts.read(vm);
     seeding_input_cfg.read(vm);
     finding_input_cfg.read(vm);
     propagation_opts.read(vm);
 
-    std::cout << "Running " << argv[0] << " " << common_opts.detector_file
-              << " " << common_opts.input_directory << " " << common_opts.events
+    std::cout << "Running " << argv[0] << " " << det_opts.detector_file << " "
+              << common_opts.input_directory << " " << common_opts.events
               << std::endl;
 
     return seq_run(seeding_input_cfg, finding_input_cfg, propagation_opts,
-                   common_opts);
+                   common_opts, det_opts);
 }

examples/run/cpu/seq_example.cpp

@@ -1,6 +1,6 @@
 /** TRACCC library, part of the ACTS project (R&D line)
  *
- * (c) 2021-2022 CERN for the benefit of the ACTS project
+ * (c) 2021-2023 CERN for the benefit of the ACTS project
  *
  * Mozilla Public License Version 2.0
  */
@@ -21,6 +21,7 @@
 
 // options
 #include "traccc/options/common_options.hpp"
+#include "traccc/options/detector_input_options.hpp"
 #include "traccc/options/full_tracking_input_options.hpp"
 #include "traccc/options/handle_argument_errors.hpp"
 
@@ -34,11 +35,11 @@
 namespace po = boost::program_options;
 
 int seq_run(const traccc::full_tracking_input_config& i_cfg,
-            const traccc::common_options& common_opts) {
+            const traccc::common_options& common_opts,
+            const traccc::detector_input_options& det_opts) {
 
     // Read the surface transforms
-    auto surface_transforms =
-        traccc::io::read_geometry(common_opts.detector_file);
+    auto surface_transforms = traccc::io::read_geometry(det_opts.detector_file);
 
     // Read the digitization configuration file
     auto digi_cfg =
@@ -124,11 +125,10 @@ int seq_run(const traccc::full_tracking_input_config& i_cfg,
           ------------*/
 
         if (common_opts.check_performance) {
-            traccc::event_map evt_map(event, common_opts.detector_file,
-                                      i_cfg.digitization_config_file,
-                                      common_opts.input_directory,
-                                      common_opts.input_directory,
-                                      common_opts.input_directory, host_mr);
+            traccc::event_map evt_map(
+                event, det_opts.detector_file, i_cfg.digitization_config_file,
+                common_opts.input_directory, common_opts.input_directory,
+                common_opts.input_directory, host_mr);
 
             sd_performance_writer.write(vecmem::get_data(seeds),
                                         vecmem::get_data(spacepoints_per_event),
@@ -161,6 +161,7 @@ int main(int argc, char* argv[]) {
     // Add options
     desc.add_options()("help,h", "Give some help with the program's options");
     traccc::common_options common_opts(desc);
+    traccc::detector_input_options det_opts(desc);
     traccc::full_tracking_input_config full_tracking_input_cfg(desc);
 
     po::variables_map vm;
@@ -171,12 +172,13 @@ int main(int argc, char* argv[]) {
 
     // Read options
     common_opts.read(vm);
+    det_opts.read(vm);
     full_tracking_input_cfg.read(vm);
 
     std::cout << "Running " << argv[0] << " "
               << full_tracking_input_cfg.detector_file << " "
               << common_opts.input_directory << " " << common_opts.events
               << std::endl;
 
-    return seq_run(full_tracking_input_cfg, common_opts);
+    return seq_run(full_tracking_input_cfg, common_opts, det_opts);
 }

examples/run/cpu/truth_finding_example.cpp

@@ -16,6 +16,7 @@
 #include "traccc/io/read_measurements.hpp"
 #include "traccc/io/utils.hpp"
 #include "traccc/options/common_options.hpp"
+#include "traccc/options/detector_input_options.hpp"
 #include "traccc/options/finding_input_options.hpp"
 #include "traccc/options/handle_argument_errors.hpp"
 #include "traccc/options/propagation_options.hpp"
@@ -44,7 +45,8 @@ namespace po = boost::program_options;
 
 int seq_run(const traccc::finding_input_config& i_cfg,
             const traccc::propagation_options<scalar>& propagation_opts,
-            const traccc::common_options& common_opts) {
+            const traccc::common_options& common_opts,
+            const traccc::detector_input_options& det_opts) {
 
     /// Type declarations
     using host_detector_type = detray::detector<detray::default_metadata,
@@ -79,10 +81,9 @@ int seq_run(const traccc::finding_input_config& i_cfg,
 
     // Read the detector
     detray::io::detector_reader_config reader_cfg{};
-    reader_cfg
-        .add_file(traccc::io::data_directory() + common_opts.detector_file)
-        .add_file(traccc::io::data_directory() + common_opts.material_file)
-        .add_file(traccc::io::data_directory() + common_opts.grid_file);
+    reader_cfg.add_file(traccc::io::data_directory() + det_opts.detector_file)
+        .add_file(traccc::io::data_directory() + det_opts.material_file)
+        .add_file(traccc::io::data_directory() + det_opts.grid_file);
 
     const auto [host_det, names] =
         detray::io::read_detector<host_detector_type>(host_mr, reader_cfg);
@@ -198,6 +199,7 @@ int main(int argc, char* argv[]) {
     // Add options
     desc.add_options()("help,h", "Give some help with the program's options");
     traccc::common_options common_opts(desc);
+    traccc::detector_input_options det_opts(desc);
     traccc::finding_input_config finding_input_cfg(desc);
     traccc::propagation_options<scalar> propagation_opts(desc);
 
@@ -209,11 +211,12 @@ int main(int argc, char* argv[]) {
 
     // Read options
     common_opts.read(vm);
+    det_opts.read(vm);
     finding_input_cfg.read(vm);
     propagation_opts.read(vm);
 
     std::cout << "Running " << argv[0] << " " << common_opts.input_directory
               << " " << common_opts.events << std::endl;
 
-    return seq_run(finding_input_cfg, propagation_opts, common_opts);
+    return seq_run(finding_input_cfg, propagation_opts, common_opts, det_opts);
 }