refactor: Update ParaView plugins names and categories (#194)

Author: RomainBaville

docs/geos_pv_docs/meshQuality.rst

@@ -5,9 +5,9 @@ Mesh Quality
 PVCellTypeCounterEnhanced
 ----------------------------------
 
-.. automodule:: geos.pv.plugins.PVCellTypeCounterEnhanced
+.. automodule:: geos.pv.plugins.qc.PVCellTypeCounterEnhanced
 
 PVMeshQualityEnhanced
 ---------------------------
 
-.. automodule:: geos.pv.plugins.PVMeshQualityEnhanced
+.. automodule:: geos.pv.plugins.qc.PVMeshQualityEnhanced

docs/geos_pv_docs/processing.rst

@@ -11,37 +11,37 @@ The plugins include:
 PVAttributeMapping
 --------------------
 
-.. automodule:: geos.pv.plugins.PVAttributeMapping
+.. automodule:: geos.pv.plugins.generic_processing.PVAttributeMapping
 
 
 PVCreateConstantAttributePerRegion
 -----------------------------------
 
-.. automodule:: geos.pv.plugins.PVCreateConstantAttributePerRegion
+.. automodule:: geos.pv.plugins.generic_processing.PVCreateConstantAttributePerRegion
 
 
 PVFillPartialArrays
 --------------------
 
-.. automodule:: geos.pv.plugins.PVFillPartialArrays
+.. automodule:: geos.pv.plugins.generic_processing.PVFillPartialArrays
 
 
 PVSplitMesh
 ----------------------------------
 
-.. automodule:: geos.pv.plugins.PVSplitMesh
+.. automodule:: geos.pv.plugins.generic_processing.PVSplitMesh
 
 
 PVMergeBlocksEnhanced module
 --------------------------------------
 
-.. automodule:: geos.pv.plugins.PVMergeBlocksEnhanced
+.. automodule:: geos.pv.plugins.generic_processing.PVMergeBlocksEnhanced
 
 
 PVClipToMainFrame
 ----------------------------------
 
-.. automodule:: geos.pv.plugins.PVClipToMainFrame
+.. automodule:: geos.pv.plugins.generic_processing.PVClipToMainFrame
 
 
 Geos output pre-processing
@@ -50,7 +50,7 @@ Geos output pre-processing
 PVGeosBlockExtractAndMerge plugin
 ----------------------------------
 
-.. automodule:: geos.pv.plugins.PVGeosBlockExtractAndMerge
+.. automodule:: geos.pv.plugins.post_processing.PVGeosBlockExtractAndMerge
 
 
 Geomechanics workflows
@@ -60,16 +60,16 @@ Geomechanics workflows
 PVGeomechanicsWorkflow plugin
 ------------------------------
 
-.. automodule:: geos.pv.plugins.PVGeomechanicsWorkflow
+.. automodule:: geos.pv.plugins.post_processing.PVGeomechanicsWorkflow
 
 
 PVGeomechanicsCalculator plugin
 ---------------------------------------
 
-.. automodule:: geos.pv.plugins.PVGeomechanicsCalculator
+.. automodule:: geos.pv.plugins.post_processing.PVGeomechanicsCalculator
 
 
 PVMohrCirclePlot plugin
 ---------------------------------
 
-.. automodule:: geos.pv.plugins.PVMohrCirclePlot
+.. automodule:: geos.pv.plugins.post_processing.PVMohrCirclePlot

docs/geos_pv_docs/readers.rst

@@ -4,4 +4,4 @@ Readers
 PVGeosLogReader
 --------------------
 
-.. automodule:: geos.pv.plugins.PVGeosLogReader
+.. automodule:: geos.pv.plugins.post_processing.PVGeosLogReader

…rc/geos/pv/plugins/PVAttributeMapping.py …generic_processing/PVAttributeMapping.pygeos-pv/src/geos/pv/plugins/PVAttributeMapping.py renamed to geos-pv/src/geos/pv/plugins/generic_processing/PVAttributeMapping.py geos-pv/src/geos/pv/plugins/PVAttributeMapping.py renamed to geos-pv/src/geos/pv/plugins/generic_processing/PVAttributeMapping.py

@@ -8,7 +8,7 @@
 from typing_extensions import Self
 
 # update sys.path to load all GEOS Python Package dependencies
-geos_pv_path: Path = Path( __file__ ).parent.parent.parent.parent.parent
+geos_pv_path: Path = Path( __file__ ).parent.parent.parent.parent.parent.parent
 sys.path.insert( 0, str( geos_pv_path / "src" ) )
 from geos.pv.utils.config import update_paths
 
@@ -33,7 +33,9 @@
     vtkMultiBlockDataSet,
 )
 
-__doc__ = """
+from geos.pv.utils.details import FilterCategory
+
+__doc__ = f"""
 AttributeMapping is a paraview plugin that transfers global attributes from a source mesh to a final mesh with same point/cell coordinates.
 
 Input and output meshes can be vtkDataSet or vtkMultiBlockDataSet.
@@ -47,19 +49,19 @@
 
 To use it:
 
-* Load the module in Paraview: Tools>Manage Plugins...>Load new>PVAttributeMapping.
-* Select the mesh to transfer the global attributes (meshTo).
-* Select Filters > 4- Geos Utils > Attribute Mapping.
-* Select the source mesh with global attributes to transfer (meshFrom).
-* Select the on witch element (onPoints/onCells) the attributes to transfer are.
-* Select the global attributes to transfer from the source mesh to the final mesh.
-* Apply.
+* Load the plugin in Paraview: Tools > Manage Plugins ... > Load New ... > .../geosPythonPackages/geos-pv/src/geos/pv/plugins/generic_processing/PVAttributeMapping
+* Select the mesh to transfer the global attributes (meshTo)
+* Select the filter: Filters > { FilterCategory.GENERIC_PROCESSING.value } > Attribute Mapping
+* Select the source mesh with global attributes to transfer (meshFrom)
+* Select the on which element (onPoints/onCells) the attributes to transfer are
+* Select the global attributes to transfer from the source mesh to the final mesh
+* Apply
 
 """
 
 
 @smproxy.filter( name="PVAttributeMapping", label="Attribute Mapping" )
-@smhint.xml( '<ShowInMenu category="4- Geos Utils"/>' )
+@smhint.xml( f'<ShowInMenu category="{ FilterCategory.GENERIC_PROCESSING.value }"/>' )
 @smproperty.input( name="meshFrom", port_index=1, label="Mesh From" )
 @smdomain.datatype(
     dataTypes=[ "vtkDataSet", "vtkMultiBlockDataSet" ],

…src/geos/pv/plugins/PVClipToMainFrame.py …/generic_processing/PVClipToMainFrame.pygeos-pv/src/geos/pv/plugins/PVClipToMainFrame.py renamed to geos-pv/src/geos/pv/plugins/generic_processing/PVClipToMainFrame.py geos-pv/src/geos/pv/plugins/PVClipToMainFrame.py renamed to geos-pv/src/geos/pv/plugins/generic_processing/PVClipToMainFrame.py

@@ -16,7 +16,7 @@
     vtkMultiBlockDataSet, )
 
 # update sys.path to load all GEOS Python Package dependencies
-geos_pv_path: Path = Path( __file__ ).parent.parent.parent.parent.parent
+geos_pv_path: Path = Path( __file__ ).parent.parent.parent.parent.parent.parent
 sys.path.insert( 0, str( geos_pv_path / "src" ) )
 from geos.pv.utils.config import update_paths
 
@@ -25,18 +25,20 @@
 from geos.pv.utils.details import ( SISOFilter, FilterCategory )
 from geos.processing.generic_processing_tools.ClipToMainFrame import ClipToMainFrame
 
-__doc__ = """
+__doc__ = f"""
 Clip the input mesh to the main frame applying the correct LandmarkTransform
 
 To use it:
 
-* Load the module in Paraview: Tools>Manage Plugins...>Load new>PVClipToMainFrame.
-* Apply.
+* Load the plugin in Paraview: Tools > Manage Plugins ... > Load New ... > .../geosPythonPackages/geos-pv/src/geos/pv/plugins/generic_processing/PVClipToMainFrame
+* Select the mesh to process
+* Select the filter: Filters > { FilterCategory.GENERIC_PROCESSING.value } > Clip to the main frame
+* Apply
 
 """
 
 
-@SISOFilter( category=FilterCategory.GEOS_UTILS,
+@SISOFilter( category=FilterCategory.GENERIC_PROCESSING,
              decoratedLabel="Clip to the main frame",
              decoratedType=[ "vtkMultiBlockDataSet", "vtkDataSet" ] )
 class PVClipToMainFrame( VTKPythonAlgorithmBase ):

…ns/PVCreateConstantAttributePerRegion.py …ng/PVCreateConstantAttributePerRegion.pygeos-pv/src/geos/pv/plugins/PVCreateConstantAttributePerRegion.py renamed to geos-pv/src/geos/pv/plugins/generic_processing/PVCreateConstantAttributePerRegion.py geos-pv/src/geos/pv/plugins/PVCreateConstantAttributePerRegion.py renamed to geos-pv/src/geos/pv/plugins/generic_processing/PVCreateConstantAttributePerRegion.py

@@ -22,7 +22,7 @@
     vtkDataSet, )
 
 # update sys.path to load all GEOS Python Package dependencies
-geos_pv_path: Path = Path( __file__ ).parent.parent.parent.parent.parent
+geos_pv_path: Path = Path( __file__ ).parent.parent.parent.parent.parent.parent
 sys.path.insert( 0, str( geos_pv_path / "src" ) )
 from geos.pv.utils.config import update_paths
 
@@ -32,7 +32,7 @@
 
 from geos.pv.utils.details import SISOFilter, FilterCategory
 
-__doc__ = """
+__doc__ = f"""
 PVCreateConstantAttributePerRegion is a Paraview plugin that allows to create an attribute
 with constant values per components for each chosen indexes of a reference/region attribute.
 If other region indexes exist, values are set to nan for float type, -1 for int type or 0 for uint type.
@@ -45,16 +45,16 @@
 
 To use it:
 
-* Load the module in Paraview: Tools>Manage Plugins...>Load new>PVCreateConstantAttributePerRegion.
-* Select the mesh in which you want to create the attributes.
-* Select the filter Create Constant Attribute Per Region in filter|0- Geos Pre-processing.
-* Choose the region attribute, the relation index/values, the new attribute name, the type of the value, the number of components and their names.
-* Apply.
+* Load the plugin in Paraview: Tools > Manage Plugins ... > Load New ... > .../geosPythonPackages/geos-pv/src/geos/pv/plugins/generic_processing/PVCreateConstantAttributePerRegion
+* Select the mesh in which you want to create the attributes
+* Select the filter: Filters > { FilterCategory.GENERIC_PROCESSING.value } > Create Constant Attribute Per Region
+* Choose the region attribute, the relation index/values, the new attribute name, the type of the value, the number of components and their names
+* Apply
 
 """
 
 
-@SISOFilter( category=FilterCategory.GEOS_PROP,
+@SISOFilter( category=FilterCategory.GENERIC_PROCESSING,
              decoratedLabel="Create Constant Attribute Per Region",
              decoratedType=[ "vtkMultiBlockDataSet", "vtkDataSet" ] )
 class PVCreateConstantAttributePerRegion( VTKPythonAlgorithmBase ):

…c/geos/pv/plugins/PVFillPartialArrays.py …eneric_processing/PVFillPartialArrays.pygeos-pv/src/geos/pv/plugins/PVFillPartialArrays.py renamed to geos-pv/src/geos/pv/plugins/generic_processing/PVFillPartialArrays.py geos-pv/src/geos/pv/plugins/PVFillPartialArrays.py renamed to geos-pv/src/geos/pv/plugins/generic_processing/PVFillPartialArrays.py

@@ -27,23 +27,23 @@
 from geos.pv.utils.details import SISOFilter, FilterCategory
 from geos.processing.generic_processing_tools.FillPartialArrays import FillPartialArrays
 
-__doc__ = """
+__doc__ = f"""
 Fill partial arrays of input mesh.
 
 Input and output are vtkMultiBlockDataSet.
 
 To use it:
 
-* Load the module in Paraview: Tools>Manage Plugins...>Load new>PVFillPartialArrays.
-* Select the input mesh.
-* Select the partial arrays to fill.
-* Set the filling value (defaults to nan).
-* Apply.
+* Load the plugin in Paraview: Tools > Manage Plugins ... > Load New ... > .../geosPythonPackages/geos-pv/src/geos/pv/plugins/generic_processing/PVFillPartialArrays
+* Select the input mesh to process
+* Select the filter: Filters > { FilterCategory.GENERIC_PROCESSING.value } > Fill Partial Arrays
+* Set the partial attribute to fill and its filling values
+* Apply
 
 """
 
 
-@SISOFilter( category=FilterCategory.GEOS_UTILS,
+@SISOFilter( category=FilterCategory.GENERIC_PROCESSING,
              decoratedLabel="Fill Partial Arrays",
              decoratedType="vtkMultiBlockDataSet" )
 class PVFillPartialArrays( VTKPythonAlgorithmBase ):

…geos/pv/plugins/PVMergeBlocksEnhanced.py …eric_processing/PVMergeBlocksEnhanced.pygeos-pv/src/geos/pv/plugins/PVMergeBlocksEnhanced.py renamed to geos-pv/src/geos/pv/plugins/generic_processing/PVMergeBlocksEnhanced.py geos-pv/src/geos/pv/plugins/PVMergeBlocksEnhanced.py renamed to geos-pv/src/geos/pv/plugins/generic_processing/PVMergeBlocksEnhanced.py

@@ -23,15 +23,16 @@
 )
 
 # Update sys.path to load all GEOS Python Package dependencies
-geos_pv_path: Path = Path( __file__ ).parent.parent.parent.parent.parent
+geos_pv_path: Path = Path( __file__ ).parent.parent.parent.parent.parent.parent
 sys.path.insert( 0, str( geos_pv_path / "src" ) )
 from geos.pv.utils.config import update_paths
 
 update_paths()
 
 from geos.processing.generic_processing_tools.MergeBlockEnhanced import MergeBlockEnhanced
+from geos.pv.utils.details import FilterCategory
 
-__doc__ = """
+__doc__ = f"""
 Merge Blocks Keeping Partial Attributes is a Paraview plugin filter that allows to merge blocks from a multiblock dataset while keeping partial attributes.
 
 Input is a vtkMultiBlockDataSet and output is a vtkUnstructuredGrid.
@@ -42,9 +43,9 @@
 
 To use it:
 
-* Load the module in Paraview: Tools > Manage Plugins... > Load new > PVMergeBlocksEnhanced
+* Load the plugin in Paraview: Tools > Manage Plugins ... > Load New ... > .../geosPythonPackages/geos-pv/src/geos/pv/plugins/generic_processing/PVMergeBlocksEnhanced
 * Select the multiblock dataset mesh you want to merge
-* Select Filters > 4- Geos Utils > Merge Blocks Keeping Partial Attributes
+* Select the filter: Filters > { FilterCategory.GENERIC_PROCESSING.value } > Merge Blocks Keeping Partial Attributes
 * Apply
 
 
@@ -57,7 +58,7 @@
 
 
 @smproxy.filter( name="PVMergeBlocksEnhanced", label="Merge Blocks Keeping Partial Attributes" )
-@smhint.xml( '<ShowInMenu category="4- Geos Utils"/>' )
+@smhint.xml( f'<ShowInMenu category="{ FilterCategory.GENERIC_PROCESSING.value }"/>' )
 @smproperty.input( name="Input", port_index=0, label="Input" )
 @smdomain.datatype( dataTypes=[ "vtkMultiBlockDataSet" ], composite_data_supported=True )
 class PVMergeBlocksEnhanced( VTKPythonAlgorithmBase ):

…os-pv/src/geos/pv/plugins/PVSplitMesh.py …lugins/generic_processing/PVSplitMesh.pygeos-pv/src/geos/pv/plugins/PVSplitMesh.py renamed to geos-pv/src/geos/pv/plugins/generic_processing/PVSplitMesh.py geos-pv/src/geos/pv/plugins/PVSplitMesh.py renamed to geos-pv/src/geos/pv/plugins/generic_processing/PVSplitMesh.py

@@ -13,7 +13,7 @@
 from vtkmodules.vtkCommonDataModel import vtkPointSet
 
 # update sys.path to load all GEOS Python Package dependencies
-geos_pv_path: Path = Path( __file__ ).parent.parent.parent.parent.parent
+geos_pv_path: Path = Path( __file__ ).parent.parent.parent.parent.parent.parent
 sys.path.insert( 0, str( geos_pv_path / "src" ) )
 from geos.pv.utils.config import update_paths
 
@@ -22,21 +22,22 @@
 from geos.processing.generic_processing_tools.SplitMesh import SplitMesh
 from geos.pv.utils.details import ( SISOFilter, FilterCategory )
 
-__doc__ = """
+__doc__ = f"""
 Split each cell of input mesh to smaller cells.
 
 Output mesh is of same type as input mesh. If input mesh is a composite mesh, the plugin split cells of each part independently.
 
 To use it:
 
-* Load the module in Paraview: Tools>Manage Plugins...>Load new>PVSplitMesh.
-* Select the input mesh.
-* Apply the filter.
+* Load the plugin in Paraview: Tools > Manage Plugins ... > Load New ... > .../geosPythonPackages/geos-pv/src/geos/pv/plugins/generic_processing/PVSplitMesh
+* Select the input mesh to process
+* Select the filter: Filters > { FilterCategory.GENERIC_PROCESSING.value } > Split Mesh
+* Apply
 
 """
 
 
-@SISOFilter( category=FilterCategory.GEOS_UTILS, decoratedLabel="Split Mesh", decoratedType="vtkPointSet" )
+@SISOFilter( category=FilterCategory.GENERIC_PROCESSING, decoratedLabel="Split Mesh", decoratedType="vtkPointSet" )
 class PVSplitMesh( VTKPythonAlgorithmBase ):
 
     def __init__( self: Self ) -> None: