Redesign n4::run_manager interface

Closes 122

.github/workflows/test.yml

@@ -78,8 +78,5 @@ jobs:
       - name: Run compile-time tests
         run: nix develop .#${{ matrix.devshell }}  -c just test-compile-time
 
-      - name: Run nain4 examples
-        run: nix develop .#${{ matrix.devshell }}  -c just test-examples
-
       - name: Run G4 examples
         run: nix develop .#${{ matrix.devshell }}  -c just g4-examples/run-examples-that-work

compile-time-tests/generate_tests.py

@@ -11,6 +11,7 @@
     ( "no member named 'initialize'"
     , """
 n4::run_manager::create()
+   .ui("program-name", argc, argv, false)
    .initialize();
 """)
 ,
@@ -20,6 +21,7 @@
     ("no member named 'geometry'"
     ,"""
 n4::run_manager::create()
+   .ui("program-name", argc, argv, false)
    .geometry  (dummy_geometry)
    .actions   (dummy_actions)
    .initialize();
@@ -31,9 +33,10 @@
     ( "no member named 'actions'"
     , """
 n4::run_manager::create()
-  .actions   (dummy_actions)
-  .geometry  (dummy_geometry)
-  .initialize();
+   .ui("program-name", argc, argv, false)
+   .actions   (dummy_actions)
+   .geometry  (dummy_geometry)
+   .initialize();
 """)
 ,
 
@@ -42,6 +45,7 @@
     ( "no member named 'initialize'"
     , """
 n4::run_manager::create()
+   .ui("program-name", argc, argv, false)
    .physics(dummy_physics_list)
    .initialize();
 """)
@@ -52,6 +56,7 @@
     ( "no member named 'actions'"
     , """
 n4::run_manager::create()
+   .ui("program-name", argc, argv, false)
    .physics(dummy_physics_list)
    .actions(dummy_actions)
    .initialize();
@@ -63,6 +68,7 @@
     ( "no member named 'geometry'"
     , """
 n4::run_manager::create()
+   .ui("program-name", argc, argv, false)
    .geometry  (dummy_geometry)
    .physics   (dummy_physics_list)
    .actions   (dummy_actions)
@@ -76,6 +82,7 @@
     ( "no member named 'actions'"
     , """
 n4::run_manager::create()
+   .ui("program-name", argc, argv, false)
    .actions   (dummy_actions)
    .physics   (dummy_physics_list)
    .geometry  (dummy_geometry)
@@ -89,6 +96,7 @@
     ( "no member named 'actions'"
     , """
 n4::run_manager::create()
+   .ui("program-name", argc, argv, false)
    .physics   (dummy_physics_list)
    .actions   (dummy_actions)
    .geometry  (dummy_geometry)
@@ -103,7 +111,7 @@
 #include "nain4.hh"
 #include "compile_time_common.hh"
 
-int main() {{
+int main(int argc, char** argv) {{
 
 {snippet}
 

doc/src/how-to/build-a-minimal-nain4-app.md

@@ -2,21 +2,21 @@
 
 ## Building the app
 
-The most basic example of a nain4 app can be found in [examples/00-basic/n4app.cc](../../../examples/00-basic/n4app.cc). Here is the full file:
+One of the most basic examples of a nain4 app can be found in [templates/basic/src/n4app.cc](../../../templates/basic/src/n4app.cc). Here is the full file:
 
 ```c++
-{{#include ../../../examples/00-basic/n4app.cc:full_file}}
+{{#include ../../../templates/basic/src/n4app.cc:full_file}}
 ```
 
 Now, let's split it into bite-sized portions. First we create a simple program that reads the number of events from CLI:
 ```c++
-{{#include ../../../examples/00-basic/n4app.cc:pick_cli_arguments}}
-{{#include ../../../examples/00-basic/n4app.cc:closing_bracket}}
+{{#include ../../../templates/basic/src/n4app.cc:pick_cli_arguments}}
+{{#include ../../../templates/basic/src/n4app.cc:closing_bracket}}
 ```
 
 In order to run a simulation we need to create a run manager:
 ```c++
-{{#include ../../../examples/00-basic/n4app.cc:create_run_manager}}
+{{#include ../../../templates/basic/src/n4app.cc:create_run_manager}}
 ```
 
 The run manager needs to be initialized with 3 attributes:
@@ -28,25 +28,32 @@ To build the action set we need to provide a primary generator action. Other act
 Note that the physics list must be instantiated and given to the run manager before the primary generator is instantiated. We provide the run manager with these attributes:
 
 ```c++
-{{#include ../../../examples/00-basic/n4app.cc:build_minimal_framework}}
+{{#include ../../../templates/basic/src/n4app.cc:build_minimal_framework}}
 ```
 
 here, `my_geometry`, and `my_generator` are the two functions we need to provide to run our simulation:
 
 ```c++
-{{#include ../../../examples/00-basic/n4app.cc:my_geometry}}
+{{#include ../../../templates/basic/src/n4app.cc:my_geometry}}
 
-{{#include ../../../examples/00-basic/n4app.cc:my_generator}}
+{{#include ../../../templates/basic/src/n4app.cc:my_generator}}
 ```
 
+and `create_actions` is defined as:
+
+```c++
+{{#include ../../../templates/basic/src/n4app.cc:create_actions}}
+```
+
+
 With this, our setup is ready, and we can start the simulation with
 ```c++
-{{#include ../../../examples/00-basic/n4app.cc:run}}
+{{#include ../../../templates/basic/src/n4app.cc:run}}
 ```
 
 Don't forget to add the relevant includes
 ```c++
-{{#include ../../../examples/00-basic/n4app.cc:includes}}
+{{#include ../../../templates/basic/src/n4app.cc:includes}}
 ```
 
 ## Compiling the app