add option sciplot to idx_map doc example

- sciplot allows to plot data to svg files

Author: SimeonEhrig

docs/snippets/idxMap/CMakeLists.txt

@@ -3,7 +3,29 @@
 # SPDX-License-Identifier: ISC
 #
 
-add_executable(idx_map plot_idx_map.cpp)
-target_include_directories(idx_map PRIVATE include)
-target_link_libraries(idx_map PRIVATE alpaka::alpaka)
-alpaka_finalize(idx_map)
+option(alpaka_DOCS_PLOT_DATA "enable plotting data with sciplot (requires gnuplot)" OFF)
+
+set(_TARGET_DOC_IDX_MAP idx_map)
+add_executable(${_TARGET_DOC_IDX_MAP} plot_idx_map.cpp)
+target_include_directories(${_TARGET_DOC_IDX_MAP} PRIVATE include)
+target_link_libraries(${_TARGET_DOC_IDX_MAP} PRIVATE alpaka::alpaka)
+
+if (alpaka_DOCS_PLOT_DATA)
+    include(FetchContent)
+
+    option(SCIPLOT_BUILD_EXAMPLES OFF)
+    option(SCIPLOT_BUILD_TESTS OFF)
+    option(SCIPLOT_BUILD_DOCS OFF)
+
+    FetchContent_Declare(sciplot_content
+            GIT_REPOSITORY https://github.com/sciplot/sciplot.git
+            GIT_TAG master)
+
+    FetchContent_MakeAvailable(sciplot_content)
+
+    target_include_directories(${_TARGET_DOC_IDX_MAP} PRIVATE ${sciplot_content_SOURCE_DIR})
+
+    target_compile_options(${_TARGET_DOC_IDX_MAP} PRIVATE "-DALPAKA_DOC_PLOT_DATA")
+endif ()
+
+alpaka_finalize(${_TARGET_DOC_IDX_MAP})

docs/snippets/idxMap/include/plot_data.hpp

@@ -0,0 +1,51 @@
+#pragma once
+
+#include "idx_map_data.hpp"
+
+#include <alpaka/alpaka.hpp>
+
+#include <sciplot/sciplot.hpp>
+
+#include <string>
+
+void drawGraphPNG(alpaka::concepts::IDataSource<AccessData> auto data, std::string const filename)
+{
+    static_assert(data.dim() == 1);
+
+    sciplot::Plot2D plot;
+    plot.xlabel("data ID");
+    plot.ylabel("processing IDs");
+    plot.xrange(0.0, static_cast<double>(data.getExtents().product()));
+    plot.legend().atOutsideTopRight();
+
+    sciplot::Vec const x = sciplot::range(0, data.getExtents().product());
+
+    sciplot::Vec frame_elem(data.getExtents().product());
+    sciplot::Vec thread_id(data.getExtents().product());
+    sciplot::Vec block_id(data.getExtents().product());
+
+    for(auto i = 0; i < data.getExtents()[0]; ++i)
+    {
+        thread_id[i] = data[i].thread_id.product();
+        block_id[i] = data[i].block_id.product();
+    }
+
+    auto frame_elem_offset = thread_id.max();
+
+    for(auto i = 0; i < data.getExtents()[0]; ++i)
+    {
+        frame_elem[i] = data[i].frame_elem.product() + frame_elem_offset + 10.0;
+    }
+
+    plot.drawCurve(x, frame_elem).label("Frame Element");
+    plot.drawBoxes(x, thread_id).label("Thread Index");
+    plot.drawBoxes(x, block_id).label("Block Index");
+
+    sciplot::Figure fig = {{plot}};
+    sciplot::Canvas canvas = {{fig}};
+
+    constexpr auto scale = 100;
+    canvas.size(scale * 81, scale * 50);
+
+    canvas.save(filename + ".svg");
+}

docs/snippets/idxMap/plot_idx_map.cpp

@@ -8,6 +8,10 @@
 
 #include <iostream>
 
+#ifdef ALPAKA_DOC_PLOT_DATA
+#    include "plot_data.hpp"
+#endif
+
 struct Kernel
 {
     ALPAKA_FN_ACC void operator()(alpaka::onAcc::concepts::Acc auto const& acc, alpaka::concepts::IMdSpan auto out)
@@ -77,11 +81,15 @@ int example(auto const deviceSpec, auto const exec)
     alpaka::onHost::memcpy(acc_queue, host_out, acc_out);
     alpaka::onHost::wait(acc_queue);
 
+#ifdef ALPAKA_DOC_PLOT_DATA
+    drawGraphPNG(host_out, alpaka::onHost::getName(exec));
+#endif
+
     std::cout << "\n";
     return 0;
 }
 
-int main(int argc, char** argv)
+int main()
 {
     return alpaka::onHost::executeForEachIfHasDevice(
         [=](auto const& backend)