diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 726e166e12..a858d7ec94 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -242,6 +242,8 @@ jobs: # remove buggy example # related issue: https://github.com/topology-tool-kit/ttk/issues/1055 rm python/nestedTrackingFromOverlap.py + # tmp removal of mpi example + rm python/mpiExample.py # remove examples which fill up the memory rm python/topologicalOptimization_darkSky.py python3 -u python/run.py @@ -398,6 +400,8 @@ jobs: # remove buggy example # related issue: https://github.com/topology-tool-kit/ttk/issues/1055 rm python/nestedTrackingFromOverlap.py + # tmp removal of mpi example + rm python/mpiExample.py # remove examples which fill up the memory rm python/topologicalOptimization_darkSky.py pvpython -u python/run.py @@ -582,6 +586,8 @@ jobs: set PV_PLUGIN_PATH=%TTK_DIR%\bin\plugins cd ttk-data rm python/nestedTrackingFromOverlap.py + # tmp removal of mpi example + rm python/mpiExample.py # remove examples which fill up the memory rm python/topologicalOptimization_darkSky.py pvpython.exe -u python\run.py diff --git a/core/base/arrayPreconditioning/ArrayPreconditioning.h b/core/base/arrayPreconditioning/ArrayPreconditioning.h index 6520c40467..86a1377021 100644 --- a/core/base/arrayPreconditioning/ArrayPreconditioning.h +++ b/core/base/arrayPreconditioning/ArrayPreconditioning.h @@ -9,7 +9,10 @@ /// In distributed, using GlobalOrder set to True, this module will compute a /// global order, otherwise each process will locally compute its order. /// - +/// \b Online \b examples:\n +/// - +/// MPI example \n #pragma once // ttk common includes diff --git a/core/base/dimensionReduction/DimensionReduction.h b/core/base/dimensionReduction/DimensionReduction.h index e1b872afa4..cdbc20522e 100644 --- a/core/base/dimensionReduction/DimensionReduction.h +++ b/core/base/dimensionReduction/DimensionReduction.h @@ -22,7 +22,7 @@ /// href="https://topology-tool-kit.github.io/examples/clusteringKelvinHelmholtzInstabilities/"> /// Clustering Kelvin Helmholtz Instabilities example \n /// - Karhunen-Love +/// href="https://topology-tool-kit.github.io/examples/karhunenLoveDigits64Dimensions/">Karhunen-Love /// Digits 64-Dimensions example \n /// - Merge diff --git a/core/base/integralLines/IntegralLines.h b/core/base/integralLines/IntegralLines.h index 86ce5fbc77..5afead4bd6 100644 --- a/core/base/integralLines/IntegralLines.h +++ b/core/base/integralLines/IntegralLines.h @@ -12,6 +12,11 @@ /// lines along the edges of the input triangulation. /// /// \sa ttkIntegralLines.cpp %for a usage example. +/// +/// \b Online \b examples:\n +/// - +/// MPI example \n #pragma once diff --git a/core/base/morseSmaleComplex/MorseSmaleComplex.h b/core/base/morseSmaleComplex/MorseSmaleComplex.h index c66b1cb735..7ed19dfa2f 100644 --- a/core/base/morseSmaleComplex/MorseSmaleComplex.h +++ b/core/base/morseSmaleComplex/MorseSmaleComplex.h @@ -70,7 +70,7 @@ /// href="https://topology-tool-kit.github.io/examples/tectonicPuzzle/">Tectonic /// Puzzle example \n /// - Topological +/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_darkSky/">Topological /// Optimization DarkSky\n /// - Tribute diff --git a/core/base/persistenceDiagram/PersistenceDiagram.h b/core/base/persistenceDiagram/PersistenceDiagram.h index a10369083d..b7af9e5258 100644 --- a/core/base/persistenceDiagram/PersistenceDiagram.h +++ b/core/base/persistenceDiagram/PersistenceDiagram.h @@ -91,7 +91,7 @@ /// href="https://topology-tool-kit.github.io/examples/interactionSites/"> /// Interaction sites \n /// - Karhunen-Love +/// href="https://topology-tool-kit.github.io/examples/karhunenLoveDigits64Dimensions/">Karhunen-Love /// Digits 64-Dimensions example \n /// - Morse @@ -130,13 +130,13 @@ /// href="https://topology-tool-kit.github.io/examples/tectonicPuzzle/">Tectonic /// Puzzle example \n /// - Topological +/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_darkSky/">Topological /// Optimization DarkSky\n /// - Topological +/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus/">Topological /// Optimization for Pegasus Genus Repair example\n /// - Topological +/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_torus/">Topological /// Optimization for Torus Repair example\n /// - Tribute diff --git a/core/base/scalarFieldCriticalPoints/ScalarFieldCriticalPoints.h b/core/base/scalarFieldCriticalPoints/ScalarFieldCriticalPoints.h index e06bdfeca1..1d3bf711fa 100644 --- a/core/base/scalarFieldCriticalPoints/ScalarFieldCriticalPoints.h +++ b/core/base/scalarFieldCriticalPoints/ScalarFieldCriticalPoints.h @@ -38,6 +38,9 @@ /// href="https://topology-tool-kit.github.io/examples/interactionSites/"> /// Interaction sites \n /// - +/// MPI example \n +/// - /// Uncertain Starting Vortex example \n diff --git a/core/base/scalarFieldSmoother/ScalarFieldSmoother.h b/core/base/scalarFieldSmoother/ScalarFieldSmoother.h index 0467560061..79c4d51ce2 100644 --- a/core/base/scalarFieldSmoother/ScalarFieldSmoother.h +++ b/core/base/scalarFieldSmoother/ScalarFieldSmoother.h @@ -42,13 +42,16 @@ /// href="https://topology-tool-kit.github.io/examples/morseSmaleSegmentation_at/">Morse-Smale /// segmentation example \n /// - +/// MPI example \n +/// - Persistence /// Diagram Principal Geodesic Analysis example \n /// - Topological +/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_darkSky/">Topological /// Optimization DarkSky\n /// - Topological +/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus/">Topological /// Optimization for Pegasus Genus Repair example\n #pragma once diff --git a/core/base/signedDistanceField/SignedDistanceField.h b/core/base/signedDistanceField/SignedDistanceField.h index 183dd63bf9..445de6011c 100644 --- a/core/base/signedDistanceField/SignedDistanceField.h +++ b/core/base/signedDistanceField/SignedDistanceField.h @@ -28,10 +28,10 @@ /// /// \b Online \b examples: \n /// - Topological +/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus/">Topological /// Optimization for Pegasus Genus Repair example\n /// - Topological +/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_torus/">Topological /// Optimization for Torus Repair example\n #pragma once diff --git a/core/base/topologicalSimplification/TopologicalSimplification.h b/core/base/topologicalSimplification/TopologicalSimplification.h index a18bbc3b73..1a5c07302c 100644 --- a/core/base/topologicalSimplification/TopologicalSimplification.h +++ b/core/base/topologicalSimplification/TopologicalSimplification.h @@ -88,13 +88,13 @@ /// href="https://topology-tool-kit.github.io/examples/tectonicPuzzle/">Tectonic /// Puzzle example \n /// - Topological +/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_darkSky/">Topological /// Optimization DarkSky\n /// - Topological +/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus/">Topological /// Optimization for Pegasus Genus Repair example\n /// - Topological +/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_torus/">Topological /// Optimization for Torus Repair example\n /// - Tribute diff --git a/core/vtk/ttkArrayPreconditioning/ttkArrayPreconditioning.h b/core/vtk/ttkArrayPreconditioning/ttkArrayPreconditioning.h index 95215cae84..f9d18a72bd 100644 --- a/core/vtk/ttkArrayPreconditioning/ttkArrayPreconditioning.h +++ b/core/vtk/ttkArrayPreconditioning/ttkArrayPreconditioning.h @@ -16,6 +16,11 @@ /// /// \sa ttk::ttkArrayPreconditioning /// \sa ttkAlgorithm +/// +/// \b Online \b examples:\n +/// - +/// MPI example \n #pragma once diff --git a/core/vtk/ttkGeometrySmoother/ttkGeometrySmoother.h b/core/vtk/ttkGeometrySmoother/ttkGeometrySmoother.h index 19d320256c..bd73a8f608 100644 --- a/core/vtk/ttkGeometrySmoother/ttkGeometrySmoother.h +++ b/core/vtk/ttkGeometrySmoother/ttkGeometrySmoother.h @@ -46,10 +46,13 @@ /// href="https://topology-tool-kit.github.io/examples/morseSmaleSegmentation_at/">Morse-Smale /// segmentation example \n /// - +/// MPI example \n +/// - Persistence /// Diagram Principal Geodesic Analysis example \n /// - Topological +/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus/">Topological /// Optimization for Pegasus Genus Repair example\n /// diff --git a/core/vtk/ttkIntegralLines/ttkIntegralLines.h b/core/vtk/ttkIntegralLines/ttkIntegralLines.h index 22756367e8..d3ffee41f9 100644 --- a/core/vtk/ttkIntegralLines/ttkIntegralLines.h +++ b/core/vtk/ttkIntegralLines/ttkIntegralLines.h @@ -57,6 +57,11 @@ /// /// \sa ttk::IntegralLines /// \sa vtkIdentifiers +/// +/// \b Online \b examples: \n +/// - +/// MPI example \n #pragma once diff --git a/core/vtk/ttkMorseSmaleComplex/ttkMorseSmaleComplex.h b/core/vtk/ttkMorseSmaleComplex/ttkMorseSmaleComplex.h index 593e038a2e..f3134ae7b1 100644 --- a/core/vtk/ttkMorseSmaleComplex/ttkMorseSmaleComplex.h +++ b/core/vtk/ttkMorseSmaleComplex/ttkMorseSmaleComplex.h @@ -100,7 +100,7 @@ /// href="https://topology-tool-kit.github.io/examples/tectonicPuzzle/">Tectonic /// Puzzle example \n /// - Topological +/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_darkSky/">Topological /// Optimization DarkSky\n /// - Tribute diff --git a/core/vtk/ttkPersistenceDiagram/ttkPersistenceDiagram.h b/core/vtk/ttkPersistenceDiagram/ttkPersistenceDiagram.h index 8f101119a4..d63a97af33 100644 --- a/core/vtk/ttkPersistenceDiagram/ttkPersistenceDiagram.h +++ b/core/vtk/ttkPersistenceDiagram/ttkPersistenceDiagram.h @@ -107,7 +107,7 @@ /// href="https://topology-tool-kit.github.io/examples/interactionSites/"> /// Interaction sites \n /// - Karhunen-Love +/// href="https://topology-tool-kit.github.io/examples/karhunenLoveDigits64Dimensions/">Karhunen-Love /// Digits 64-Dimensions example \n /// - Morse @@ -143,13 +143,13 @@ /// href="https://topology-tool-kit.github.io/examples/tectonicPuzzle/">Tectonic /// Puzzle example \n /// - Topological +/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_darkSky/">Topological /// Optimization DarkSky example\n /// - Topological +/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus/">Topological /// Optimization for Pegasus Genus Repair example\n /// - Topological +/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_torus/">Topological /// Optimization for Torus Repair example\n /// - Tribute diff --git a/core/vtk/ttkPersistentGenerators/ttkPersistentGenerators.h b/core/vtk/ttkPersistentGenerators/ttkPersistentGenerators.h index c246e87ecb..27cf81abb3 100644 --- a/core/vtk/ttkPersistentGenerators/ttkPersistentGenerators.h +++ b/core/vtk/ttkPersistentGenerators/ttkPersistentGenerators.h @@ -35,7 +35,7 @@ /// href="https://topology-tool-kit.github.io/examples/persistentGenerators_skull/">Persistent /// Generators Skull example \n /// - Topological +/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus/">Topological /// Optimization for Pegasus Genus Repair example\n /// diff --git a/core/vtk/ttkPointDataSelector/ttkPointDataSelector.h b/core/vtk/ttkPointDataSelector/ttkPointDataSelector.h index dc8abad090..8093b01f42 100644 --- a/core/vtk/ttkPointDataSelector/ttkPointDataSelector.h +++ b/core/vtk/ttkPointDataSelector/ttkPointDataSelector.h @@ -13,6 +13,12 @@ /// /// See the related ParaView example state files for usage examples within a /// VTK pipeline. +/// +/// \b Online \b examples:\n +/// - +/// MPI example \n + #pragma once #include diff --git a/core/vtk/ttkScalarFieldCriticalPoints/ttkScalarFieldCriticalPoints.h b/core/vtk/ttkScalarFieldCriticalPoints/ttkScalarFieldCriticalPoints.h index 350a70cff4..f0acab709d 100644 --- a/core/vtk/ttkScalarFieldCriticalPoints/ttkScalarFieldCriticalPoints.h +++ b/core/vtk/ttkScalarFieldCriticalPoints/ttkScalarFieldCriticalPoints.h @@ -66,6 +66,9 @@ /// href="https://topology-tool-kit.github.io/examples/interactionSites/"> /// Interaction sites \n /// - +/// MPI example \n +/// - /// Uncertain Starting Vortex example \n /// diff --git a/core/vtk/ttkScalarFieldNormalizer/ttkScalarFieldNormalizer.h b/core/vtk/ttkScalarFieldNormalizer/ttkScalarFieldNormalizer.h index e998b7136f..a9d5176fbf 100644 --- a/core/vtk/ttkScalarFieldNormalizer/ttkScalarFieldNormalizer.h +++ b/core/vtk/ttkScalarFieldNormalizer/ttkScalarFieldNormalizer.h @@ -39,6 +39,9 @@ /// - Morse-Smale /// Quadrangulation example \n +/// - +/// MPI example \n /// #pragma once diff --git a/core/vtk/ttkScalarFieldSmoother/ttkScalarFieldSmoother.h b/core/vtk/ttkScalarFieldSmoother/ttkScalarFieldSmoother.h index b445d3c83d..21ef57e13a 100644 --- a/core/vtk/ttkScalarFieldSmoother/ttkScalarFieldSmoother.h +++ b/core/vtk/ttkScalarFieldSmoother/ttkScalarFieldSmoother.h @@ -47,13 +47,16 @@ /// href="https://topology-tool-kit.github.io/examples/morsePersistence/">Morse /// Persistence example \n /// - +/// MPI example \n +/// - Persistent /// Generators Dark Sky example \n /// - Topological +/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_darkSky/">Topological /// Optimization DarkSky\n /// - Topological +/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus/">Topological /// Optimization for Pegasus Genus Repair example\n #pragma once diff --git a/core/vtk/ttkSignedDistanceField/ttkSignedDistanceField.h b/core/vtk/ttkSignedDistanceField/ttkSignedDistanceField.h index ee47f7d499..a5d2c4659b 100644 --- a/core/vtk/ttkSignedDistanceField/ttkSignedDistanceField.h +++ b/core/vtk/ttkSignedDistanceField/ttkSignedDistanceField.h @@ -28,10 +28,10 @@ /// /// \b Online \b examples: \n /// - Topological +/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus/">Topological /// Optimization for Pegasus Genus Repair example\n /// - Topological +/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_torus/">Topological /// Optimization for Torus Repair example\n #pragma once diff --git a/core/vtk/ttkTopologicalSimplification/ttkTopologicalSimplification.h b/core/vtk/ttkTopologicalSimplification/ttkTopologicalSimplification.h index cf87ded99d..4ec2e89431 100644 --- a/core/vtk/ttkTopologicalSimplification/ttkTopologicalSimplification.h +++ b/core/vtk/ttkTopologicalSimplification/ttkTopologicalSimplification.h @@ -116,13 +116,13 @@ /// href="https://topology-tool-kit.github.io/examples/tectonicPuzzle/">Tectonic /// Puzzle example \n /// - Topological +/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_darkSky/">Topological /// Optimization DarkSky example\n /// - Topological +/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus/">Topological /// Optimization for Pegasus Genus Repair example\n /// - Topological +/// href="https://topology-tool-kit.github.io/examples/topologicalOptimization_torus/">Topological /// Optimization for Torus Repair example\n /// - Tribute diff --git a/paraview/xmls/ArrayPreconditioning.xml b/paraview/xmls/ArrayPreconditioning.xml index a368ad41d3..1d44409c12 100644 --- a/paraview/xmls/ArrayPreconditioning.xml +++ b/paraview/xmls/ArrayPreconditioning.xml @@ -10,6 +10,10 @@ short_help="Array Preconditioning"> This filter preconditions a vtkDataSet by computing an input order array for every selected scalar arrays. + + Online examples: + + - https://topology-tool-kit.github.io/examples/mpiExample/ diff --git a/paraview/xmls/GeometrySmoother.xml b/paraview/xmls/GeometrySmoother.xml index fe47ed5fe7..4aaa635940 100644 --- a/paraview/xmls/GeometrySmoother.xml +++ b/paraview/xmls/GeometrySmoother.xml @@ -34,6 +34,8 @@ - https://topology-tool-kit.github.io/examples/morseMolecule/ + - https://topology-tool-kit.github.io/examples/mpiExample/ + - https://topology-tool-kit.github.io/examples/persistenceDiagramPGA/ https://topology-tool-kit.github.io/examples/topologicalOptimization_pegasus/ diff --git a/paraview/xmls/IntegralLines.xml b/paraview/xmls/IntegralLines.xml index ee2f069790..461e96dbfc 100644 --- a/paraview/xmls/IntegralLines.xml +++ b/paraview/xmls/IntegralLines.xml @@ -21,6 +21,11 @@ data a scalar field that represent the vertex identifiers of the sources in the input geometry (use the Identifiers plugin prior to the selection of the sources if necessary to create such an identifier field). + Online examples: + + - https://topology-tool-kit.github.io/examples/mpiExample/ + + TTK fieldSelector plugin documentation. + + Online examples: + + - https://topology-tool-kit.github.io/examples/mpiExample/ TTK plugin that normalizes an input scalar field. - Online examples: + Online examples: - - https://topology-tool-kit.github.io/examples/BuiltInExample1/ + - https://topology-tool-kit.github.io/examples/BuiltInExample1/ - - https://topology-tool-kit.github.io/examples/clusteringKelvinHelmholtzInstabilities/ + - https://topology-tool-kit.github.io/examples/clusteringKelvinHelmholtzInstabilities/ - - https://topology-tool-kit.github.io/examples/harmonicSkeleton/ + - https://topology-tool-kit.github.io/examples/harmonicSkeleton/ - - https://topology-tool-kit.github.io/examples/morseSmaleQuadrangulation/ + - https://topology-tool-kit.github.io/examples/morseSmaleQuadrangulation/ + + - https://topology-tool-kit.github.io/examples/mpiExample/