Merge pull request #788 from PhilipDeegan/reportage

system reporting
PHAREHUB · Dec 19, 2023 · f5df34c · f5df34c
2 parents 2c44575 + 4aaebca
commit f5df34c
Show file tree

Hide file tree

Showing 77 changed files with 243 additions and 101 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1) # released April 8, 2021 - https://www.kitware.com/cmake-3-20-1-available-for-download/
 
 project(PHARE VERSION 0.1 LANGUAGES CXX)
 

diff --git a/pyphare/pyphare/pharein/simulation.py b/pyphare/pyphare/pharein/simulation.py
@@ -604,6 +604,7 @@ def wrapper(simulation_object, **kwargs):
             "strict",
             "restart_options",
             "tag_buffer",
+            "description",
         ]
 
         accepted_keywords += check_optional_keywords(**kwargs)
@@ -620,6 +621,8 @@ def wrapper(simulation_object, **kwargs):
         kwargs["cells"] = cells
         kwargs["refinement_ratio"] = 2
 
+        kwargs["description"] = kwargs.get("description", None)
+
         kwargs["clustering"] = check_clustering(**kwargs)
 
         time_step_nbr, time_step, final_time = check_time(**kwargs)
@@ -796,6 +799,8 @@ class Simulation(object):
               number of refined particle per coarse particle.
             * *tag_buffer* (``int``) --
               [default=1] value representing the number of cells by which tagged cells are buffered before clustering into boxes.
+            * *description* (``string``) --
+              [default=None] arbitrary string for per simulation context - injected in output files when feasible
     """
 
     @checker

diff --git a/res/cmake/def.cmake b/res/cmake/def.cmake
@@ -34,6 +34,7 @@ if (phare_configurator)
   execute_process(
     COMMAND ./tools/config/cmake.sh
     WORKING_DIRECTORY ${PHARE_PROJECT_DIR}
+    COMMAND_ERROR_IS_FATAL ANY
   )
   include("${PHARE_PROJECT_DIR}/tools/config/local.cmake")
 endif(phare_configurator)
@@ -286,3 +287,12 @@ if (test AND ${PHARE_EXEC_LEVEL_MIN} GREATER 0) # 0 = no tests
 
 endif()
 
+# useful to see what's available after importing a package
+function(phare_print_all_cmake_vars)
+  get_cmake_property(_variableNames VARIABLES)
+  list (SORT _variableNames)
+  foreach (_variableName ${_variableNames})
+      message(STATUS "${_variableName}=${${_variableName}}")
+  endforeach()
+endfunction(phare_print_all_cmake_vars)
+
diff --git a/src/amr/CMakeLists.txt b/src/amr/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 project(phare_amr)
 
 set( SOURCES_INC

diff --git a/src/core/CMakeLists.txt b/src/core/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 project(phare_core)
 
 set( SOURCES_INC

diff --git a/src/diagnostic/CMakeLists.txt b/src/diagnostic/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(phare_diagnostic)
 

diff --git a/src/initializer/CMakeLists.txt b/src/initializer/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 project(phare_initializer)
 
 

diff --git a/src/phare/CMakeLists.txt b/src/phare/CMakeLists.txt
@@ -1,5 +1,5 @@
 
-cmake_minimum_required(VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 project(phare-exe)
 
 

diff --git a/src/python3/CMakeLists.txt b/src/python3/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(phare_python3)
 

diff --git a/src/restarts/CMakeLists.txt b/src/restarts/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(phare_restarts)
 

diff --git a/src/simulator/CMakeLists.txt b/src/simulator/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 project(phare_simulator)
 
 set( SOURCES_INC

diff --git a/tests/amr/data/field/coarsening/CMakeLists.txt b/tests/amr/data/field/coarsening/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-field-data-coarsen)
 

diff --git a/tests/amr/data/field/copy_pack/CMakeLists.txt b/tests/amr/data/field/copy_pack/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-field-data)
 

diff --git a/tests/amr/data/field/copy_pack/copy/CMakeLists.txt b/tests/amr/data/field/copy_pack/copy/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-field-data-copy)
 

diff --git a/tests/amr/data/field/copy_pack/copy_overlap/CMakeLists.txt b/tests/amr/data/field/copy_pack/copy_overlap/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-field-data-copy-with-overlap)
 

diff --git a/tests/amr/data/field/copy_pack/stream_pack/CMakeLists.txt b/tests/amr/data/field/copy_pack/stream_pack/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-field-data-stream-pack)
 

diff --git a/tests/amr/data/field/geometry/CMakeLists.txt b/tests/amr/data/field/geometry/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 project(test-field-geometry)
 
 set(SOURCES_INC

diff --git a/tests/amr/data/field/overlap/CMakeLists.txt b/tests/amr/data/field/overlap/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-field-overlap)
 

diff --git a/tests/amr/data/field/refine/CMakeLists.txt b/tests/amr/data/field/refine/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-field-refine)
 

diff --git a/tests/amr/data/field/time_interpolate/CMakeLists.txt b/tests/amr/data/field/time_interpolate/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-field-data-time-interpolate)
 set(SOURCES_INC)

diff --git a/tests/amr/data/field/variable/CMakeLists.txt b/tests/amr/data/field/variable/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-field-variable)
 

diff --git a/tests/amr/data/particles/copy/CMakeLists.txt b/tests/amr/data/particles/copy/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-particles-data-copy)
 

diff --git a/tests/amr/data/particles/copy_overlap/CMakeLists.txt b/tests/amr/data/particles/copy_overlap/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-particles-data-copy-with-overlap)
 

diff --git a/tests/amr/data/particles/refine/CMakeLists.txt b/tests/amr/data/particles/refine/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-particles-data-refine)
 

diff --git a/tests/amr/data/particles/stream_pack/CMakeLists.txt b/tests/amr/data/particles/stream_pack/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-particles-data-stream-pack-unpack)
 

diff --git a/tests/amr/messengers/CMakeLists.txt b/tests/amr/messengers/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-messenger)
 

diff --git a/tests/amr/models/CMakeLists.txt b/tests/amr/models/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-models)
 

diff --git a/tests/amr/multiphysics_integrator/CMakeLists.txt b/tests/amr/multiphysics_integrator/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-multiphysics-integrator)
 

diff --git a/tests/amr/resources_manager/CMakeLists.txt b/tests/amr/resources_manager/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-resource)
 

diff --git a/tests/amr/tagging/CMakeLists.txt b/tests/amr/tagging/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-tagging)
 

diff --git a/tests/core/data/electrons/CMakeLists.txt b/tests/core/data/electrons/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-electrons)
 

diff --git a/tests/core/data/field/CMakeLists.txt b/tests/core/data/field/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-field)
 

diff --git a/tests/core/data/gridlayout/CMakeLists.txt b/tests/core/data/gridlayout/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-GridLayout)
 

diff --git a/tests/core/data/ion_population/CMakeLists.txt b/tests/core/data/ion_population/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-ionpopulation)
 

diff --git a/tests/core/data/ions/CMakeLists.txt b/tests/core/data/ions/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-ions)
 

diff --git a/tests/core/data/maxwellian_particle_initializer/CMakeLists.txt b/tests/core/data/maxwellian_particle_initializer/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-maxwelllian-particle-initializer)
 

diff --git a/tests/core/data/ndarray/CMakeLists.txt b/tests/core/data/ndarray/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-ndarray)
 

diff --git a/tests/core/data/particle_initializer/CMakeLists.txt b/tests/core/data/particle_initializer/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-particle-initializer)
 

diff --git a/tests/core/data/particles/CMakeLists.txt b/tests/core/data/particles/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-particles)
 

diff --git a/tests/core/data/vecfield/CMakeLists.txt b/tests/core/data/vecfield/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-vecfield)
 

diff --git a/tests/core/numerics/ampere/CMakeLists.txt b/tests/core/numerics/ampere/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-ampere)
 

diff --git a/tests/core/numerics/boundary_condition/CMakeLists.txt b/tests/core/numerics/boundary_condition/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-boundary_condition)
 

diff --git a/tests/core/numerics/faraday/CMakeLists.txt b/tests/core/numerics/faraday/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-faraday)
 

diff --git a/tests/core/numerics/interpolator/CMakeLists.txt b/tests/core/numerics/interpolator/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-interpolator)
 

diff --git a/tests/core/numerics/ion_updater/CMakeLists.txt b/tests/core/numerics/ion_updater/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-updater)
 

diff --git a/tests/core/numerics/ohm/CMakeLists.txt b/tests/core/numerics/ohm/CMakeLists.txt
@@ -1,4 +1,4 @@
-    cmake_minimum_required (VERSION 3.9)
+    cmake_minimum_required (VERSION 3.20.1)
 
 project(test-ohm)
 

diff --git a/tests/core/numerics/pusher/CMakeLists.txt b/tests/core/numerics/pusher/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-pusher)
 

diff --git a/tests/core/utilities/box/CMakeLists.txt b/tests/core/utilities/box/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-box)
 

diff --git a/tests/core/utilities/cellmap/CMakeLists.txt b/tests/core/utilities/cellmap/CMakeLists.txt
@@ -1,6 +1,6 @@
 
 
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-cellmap)
 

diff --git a/tests/core/utilities/index/CMakeLists.txt b/tests/core/utilities/index/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-index)
 

diff --git a/tests/core/utilities/indexer/CMakeLists.txt b/tests/core/utilities/indexer/CMakeLists.txt
@@ -1,5 +1,5 @@
 
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-indexer)
 

diff --git a/tests/core/utilities/point/CMakeLists.txt b/tests/core/utilities/point/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-point)
 

diff --git a/tests/core/utilities/range/CMakeLists.txt b/tests/core/utilities/range/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-range)
 

diff --git a/tests/diagnostic/CMakeLists.txt b/tests/diagnostic/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-diagnostics)
 

diff --git a/tests/functional/alfven_wave/CMakeLists.txt b/tests/functional/alfven_wave/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-alfven-wave)
 

diff --git a/tests/functional/conservation/CMakeLists.txt b/tests/functional/conservation/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-conservation)
 

diff --git a/tests/functional/dispersion/CMakeLists.txt b/tests/functional/dispersion/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-dispersion)
 

diff --git a/tests/functional/harris/CMakeLists.txt b/tests/functional/harris/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-conservation)
 

diff --git a/tests/functional/ionIonBeam/CMakeLists.txt b/tests/functional/ionIonBeam/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-ion-ion-beam)
 

diff --git a/tests/functional/shock/CMakeLists.txt b/tests/functional/shock/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.9)
+cmake_minimum_required (VERSION 3.20.1)
 
 project(test-shock1d)