Improve performance analysis tool

.gitlab-ci.yml

@@ -34,6 +34,7 @@ stages:
   - install_production
   - update_permissions
   - cleanup
+  - deploy
 
 include:
   - project: lc-templates/id_tokens
@@ -53,3 +54,4 @@ include:
         when: never
       - when: always
   - local: .gitlab/jobs-prod.yml
+  - local: .gitlab/pages.yml

.gitlab/pages.yml

@@ -0,0 +1,25 @@
+create-pages:
+  extends: [.toss_shell1]
+  variables:
+    GIT_SUBMODULE_STRATEGY: normal
+  stage: deploy
+  pages:
+    # The folder that contains the files to be exposed at the Page URL
+    publish: public
+  rules:
+    # This ensures that only pushes to the default branch will trigger
+    # a pages deploy
+    - if: '$CI_COMMIT_REF_NAME == "develop"'
+      when: always
+    - if: '$CI_COMMIT_MESSAGE =~ /test-deploy/'
+      when: always
+  script:
+    - python3 -m venv $HOME/docsvenv
+    - source $HOME/docsvenv/bin/activate
+    - python3 -m pip install --progress-bar off -U pip
+    - python3 -m pip install --progress-bar off llnl-thicket sphinx sphinx-rtd-theme sphinx-design ipython
+    - python3 $SCRIPT_DIR/lc/plot_hist_data.py --out-dir time_doc
+    - python3 -m sphinx -q time_doc/ public/
+  artifacts:
+    paths:
+      - public

CMakeLists.txt

@@ -5,7 +5,7 @@ include(cmake/SpheralVersion.cmake)
 project(spheral LANGUAGES C CXX Fortran VERSION ${SPHERAL_VERSION})
 
 set(SPHERAL_ROOT_DIR ${CMAKE_CURRENT_SOURCE_DIR} CACHE PATH "Path to Spheral source directory")
-set(SPHERAL_TEST_INSTALL_PREFIX ${CMAKE_INSTALL_PREFIX}/tests)
+set(SPHERAL_TEST_INSTALL_PREFIX "tests")
 
 include(cmake/SetupSpheral.cmake)
 

RELEASE_NOTES.md

@@ -30,6 +30,9 @@ Notable changes include:
       - RadialFunctor
     * FacetedSurfaceASPHHydro has been removed in favor of providing user filters to the ASPH methods (i.e., the RadialFunctor method).
     * Field resizing operations have been removed from the public interface.
+    * Performance analysis tools are improved.
+      - Added an "advance" Caliper timer to be used in the future as the default reference timer.
+      - Added a deploy CI stage to create a GitLab page with the historical performance benchmarks.
 
   * Build changes / improvements:
     * Native Spack environments are now being used.
@@ -45,8 +48,10 @@ Notable changes include:
     * ATS submodule is updated to fix bug with latest Flux update on LC systems.
     * Update Polytope version.
     * TPL manager removes the symoblic links to the install directory.
-    * Consolidated CMake configured files into SpheralConfigs.py.in
-    * Deviatoric stress evolution in lower dimensions (1 and 2D) now consistent with other solid hydros
+    * Consolidated CMake configured files into SpheralConfigs.py.in.
+    * Deviatoric stress evolution in lower dimensions (1 and 2D) now consistent with other solid hydros.
+    * Changes the `SPHERAL_TEST_INSTALL_PREFIX` to be relative to `CMAKE_INSTALL_PREFIX/tests` directory.
+    * Fixed bug where performance tests would incorrectly move a benchmark directory if rerunning failed jobs.
 
 Version v2025.01.0 -- Release date 2025-01-31
 ==============================================

cmake/InstallTPLs.cmake

@@ -204,7 +204,6 @@ endif()
 message("-----------------------------------------------------------------------------")
 # TPLs that must be imported
 list(APPEND SPHERAL_EXTERN_LIBS boost eigen qhull silo hdf5)
-list(APPEND SPHERAL_EXTERN_LIBS boost eigen qhull silo hdf5)
 
 blt_list_append( TO SPHERAL_EXTERN_LIBS ELEMENTS leos IF ENABLE_LEOS)
 blt_list_append( TO SPHERAL_EXTERN_LIBS ELEMENTS aneos IF ENABLE_ANEOS)

cmake/SetupSpheral.cmake

@@ -172,10 +172,10 @@ endif()
 if (ENABLE_TESTS)
   add_subdirectory(${SPHERAL_ROOT_DIR}/tests)
 
-  spheral_install_python_tests(${SPHERAL_ROOT_DIR}/tests/ ${SPHERAL_TEST_INSTALL_PREFIX})
+  spheral_install_python_tests(${SPHERAL_ROOT_DIR}/tests/ ${CMAKE_INSTALL_PREFIX}/${SPHERAL_TEST_INSTALL_PREFIX})
   # Always install performance.py in the top of the testing script
   install(FILES ${SPHERAL_ROOT_DIR}/tests/performance.py
-    DESTINATION ${CMAKE_INSTALL_PREFIX}/tests)
+    DESTINATION ${CMAKE_INSTALL_PREFIX}/${SPHERAL_TEST_INSTALL_PREFIX})
 endif()
 
 include(${SPHERAL_ROOT_DIR}/cmake/SpheralConfig.cmake)

docs/developer/dev/diagnostic_tools.rst

@@ -172,11 +172,22 @@ The general procedure to comparing performance regression tests is:
 
       \delta_{\mathrm{thresh}} = 0.08 \mu + 2 \sigma
 
-   If the :math:`t_c - \mu > \delta_{\mathrm{thresh}}` for the ``main`` region, where :math:`t_c` is the new performance time, the test is considered to have failed and the timing tree of the exclusive average time per rank (``Avg time/rank (exc)``) will be displayed.
-   If the test configurations, like the number of time steps differed between the runs, or the hardware/install configurations did not match, it will consider the test skipped.
-   Otherwise, the test is considered to have passed.
-   If the :math:`t_c - \mu < -\delta_{\mathrm{thresh}}`, the performance improved significantly and the timing tree will be displayed.
+   There are 3 possible outcomes for each test:
+
+      - ``FAILED`` if :math:`t_c - \mu > \delta_{\mathrm{thresh}}` for the ``main`` region, where :math:`t_c` is the new performance time. The timing tree of the exclusive average time per rank (``Avg time/rank (exc)``) will be displayed.
+      - ``SKIPPED`` if test configurations do not match (number of time steps, number of SPH nodes, or hardware/install configurations).
+      - ``PASSED`` otherwise. Additionally, if :math:`t_c - \mu < -\delta_{\mathrm{thresh}}`, the performance improved significantly and the timing tree will be displayed.
 
 .. note::
 
    If ``performance.py`` is run on a non-MPI Spheral build, it will only use 1 rank and will thread all other available cores.
+
+Historical Timing Benchmarks
+----------------------------
+
+After the CI creates performance benchmark data during a merge to the develop branch, a deploy stage is run that creates plots showing the history of the benchmark timers over time.
+This page can be accessed by going to the repo page on GitLab (not GitHub), and either:
+
+* Click ``GitLab Pages`` on the right side of the repos home page.
+
+* Click ``Deploy->Pages`` on the left side of the page and select the link in the ``Deployments`` section.