pyvale 2025.7.2__cp311-cp311-macosx_13_0_x86_64.whl → 2025.8.1__cp311-cp311-macosx_13_0_x86_64.whl

pyvale/__init__.py

@@ -5,97 +5,17 @@
 # ==============================================================================
 
 """
-`pyvale`: the python validation engine. Used to simulate experimental data from
-an input multi-physics simulation by explicitly modelling sensors with realistic
-uncertainties. Useful for experimental design, sensor placement optimisation,
-testing simulation validation metrics and testing digital shadows/twins.
+The python validation engine (`pyvale`) is your virtual engineering laboratory:
+An all-in-one package for sensor simulation, sensor uncertainty quantification,
+sensor placement optimisation and simulation calibration/validation. Used to
+simulate experimental data from an input multi-physics simulation by explicitly
+modelling sensors with realistic uncertainties. Useful for experimental design,
+sensor placement optimisation, testing simulation validation metrics and
+virtually testing digital shadows/twins.
 """
 
-# NOTE: this simplifies and decouples how the user calls pyvale from the
-# underlying project structure: the user should be able to use 'pyvale.'
-# and access everything in one layer without multiple import dots
-
-
-from pyvale.dataset import *
-
-from pyvale.field import *
-from pyvale.fieldscalar import *
-from pyvale.fieldvector import *
-from pyvale.fieldtensor import *
-from pyvale.fieldconverter import *
-from pyvale.fieldtransform import *
-
-from pyvale.integratorspatial import *
-from pyvale.integratorquadrature import *
-from pyvale.integratorrectangle import *
-from pyvale.integratorfactory import *
-
-from pyvale.sensordescriptor import *
-from pyvale.sensortools import *
-from pyvale.sensorarray import *
-from pyvale.sensorarrayfactory import *
-from pyvale.sensorarraypoint import *
-from pyvale.sensordata import *
-
-from pyvale.camera import *
-from pyvale.cameradata import *
-from pyvale.cameradata2d import *
-from pyvale.cameratools import *
-from pyvale.camerastereo import *
-
-import pyvale.cython.rastercyth as rastercyth
-from pyvale.rastercy import *
-
-from pyvale.renderscene import *
-from pyvale.rendermesh import *
-from pyvale.rasternp import *
-
-from pyvale.imagedef2d import *
-
-from pyvale.errorintegrator import *
-from pyvale.errorrand import *
-from pyvale.errorsysindep import *
-from pyvale.errorsysdep import *
-from pyvale.errorsysfield import *
-from pyvale.errorsyscalib import *
-from pyvale.errordriftcalc import *
-
-from pyvale.generatorsrandom import *
-
-from pyvale.visualopts import *
-from pyvale.visualtools import *
-from pyvale.visualsimsensors import *
-from pyvale.visualsimanimator import *
-from pyvale.visualexpplotter import *
-from pyvale.visualtraceplotter import *
-from pyvale.visualimages import *
-from pyvale.visualimagedef import *
-
-from pyvale.analyticmeshgen import *
-from pyvale.analyticsimdatagenerator import *
-from pyvale.analyticsimdatafactory import *
-
-from pyvale.experimentsimulator import *
-
-from pyvale.blendercalibrationdata import *
-from pyvale.blenderlightdata import *
-from pyvale.blendermaterialdata import *
-from pyvale.blenderrenderdata import *
-from pyvale.blenderscene import *
-from pyvale.blendertools import *
-from pyvale.simtools import *
-
-from pyvale.output import *
-from pyvale.pyvaleexceptions import *
-
-from pyvale.experimentsimulator import *
-
-from pyvale.dicspecklegenerator import *
-from pyvale.dicspecklequality import *
-from pyvale.dicregionofinterest import *
-from pyvale.dic2d import *
-from pyvale.dicdataimport import *
-from pyvale.dicresults import *
-from pyvale.dic2dcpp import *
-from pyvale.dicstrain import *
-from pyvale.dicchecks import *
+from . import dic
+from . import blender
+from . import sensorsim
+from . import mooseherder
+from . import dataset

pyvale/blender/__init__.py

@@ -0,0 +1,23 @@
+#===============================================================================
+# pyvale: the python validation engine
+# License: MIT
+# Copyright (C) 2025 The Computer Aided Validation Team
+#===============================================================================
+
+from .blendercalibrationdata import CalibrationData
+from .blenderlightdata import LightData, LightType
+from .blendermaterialdata import MaterialData
+from .blenderrenderdata import RenderData, RenderEngine
+from .blenderscene import Scene
+from .blendertools import Tools
+from .blenderexceptions import BlenderError
+
+__all__ = ["CalibrationData",
+           "LightData",
+           "LightType",
+           "MaterialData",
+           "RenderData",
+           "RenderEngine",
+           "Scene",
+           "Tools",
+           "BlenderError"]

pyvale/{pyvaleexceptions.py → blender/blenderexceptions.py}

@@ -6,6 +6,3 @@
 
 class BlenderError(Exception):
     pass
-
-class VisError(Exception):
-    pass

pyvale/{blenderlightdata.py → blender/blenderlightdata.py}

@@ -10,17 +10,17 @@ from scipy.spatial.transform import Rotation
 
 #TODO: docstrings
 
-class BlenderLightType(Enum):
+class LightType(Enum):
     POINT = 'POINT'
     SUN = 'SUN'
     SPOT = 'SPOT'
     AREA = 'AREA'
 
 @dataclass(slots=True)
-class BlenderLightData():
+class LightData():
     pos_world: np.ndarray
     rot_world: Rotation
     energy: int # NOTE: In Watts
-    type: BlenderLightType = BlenderLightType.POINT
+    type: LightType = LightType.POINT
     shadow_soft_size: float = 1.5
 

pyvale/{blendermaterialdata.py → blender/blendermaterialdata.py}

@@ -8,7 +8,7 @@ from dataclasses import dataclass
 #TODO: docstrings
 
 @dataclass(slots=True)
-class BlenderMaterialData():
+class MaterialData():
     # TODO: Add other material properties here
     roughness: float = 1.0
     metallic: float = 0.0

pyvale/{blenderrenderdata.py → blender/blenderrenderdata.py}

@@ -7,8 +7,10 @@
 from enum import Enum
 from dataclasses import dataclass
 from pathlib import Path
-from pyvale.cameradata import CameraData
-from pyvale.output import Outputs
+
+# Pyvale
+from pyvale.sensorsim.cameradata import CameraData
+from pyvale.sensorsim.output import Outputs
 
 #TODO: docstrings
 
@@ -27,4 +29,4 @@ class RenderData:
     engine: RenderEngine = RenderEngine.CYCLES
     max_bounces: int = 12
     bit_size: int = 8
-    threads:int = 4
+    threads:int = 4

pyvale/{blenderscene.py → blender/blenderscene.py}

@@ -6,18 +6,21 @@
 import numpy as np
 from pathlib import Path
 import bpy
-from pyvale.cameradata import CameraData
-from pyvale.blenderlightdata import BlenderLightData
-from pyvale.blendertools import BlenderTools
-from pyvale.simtools import SimTools
-from pyvale.blendermaterialdata import BlenderMaterialData
-from pyvale.blenderrenderdata import RenderData, RenderEngine
-from pyvale.camerastereo import CameraStereo
-from pyvale.rendermesh import RenderMesh
-from pyvale.pyvaleexceptions import BlenderError
-
-
-class BlenderScene():
+
+# Pyvale 
+from pyvale.sensorsim.cameradata import CameraData
+from pyvale.sensorsim.simtools import SimTools
+from pyvale.sensorsim.camerastereo import CameraStereo
+from pyvale.sensorsim.rendermesh import RenderMesh
+
+from pyvale.blender.blenderexceptions import BlenderError
+from pyvale.blender.blendertools import Tools
+from pyvale.blender.blenderlightdata import LightData
+from pyvale.blender.blenderrenderdata import RenderEngine, RenderData
+from pyvale.blender.blendermaterialdata import MaterialData
+from pyvale.blender.blendercalibrationdata import CalibrationData
+
+class Scene():
     """Namespace for creating a scene within Blender.
     Methods include adding an object, camera, light and adding a speckle pattern,
     as well as deforming the object, and then rendering the scene.
@@ -119,12 +122,12 @@ class BlenderScene():
         cam1 = self.add_camera(stereo_system.cam_data_1)
         return cam0, cam1
 
-    def add_light(self, light_data: BlenderLightData) -> bpy.data.objects:
+    def add_light(self, light_data: LightData) -> bpy.data.objects:
         """A method to add a light object within Blender.
 
         Parameters
         ----------
-        light_data : BlenderLightData
+        light_data : pyvale.blender.LightData
             A dataclass contain the necessary parameters to create a Blender
             light object.
 
@@ -222,7 +225,7 @@ class BlenderScene():
     def add_speckle(self,
                     part: bpy.data.objects,
                     speckle_path: Path | None,
-                    mat_data: BlenderMaterialData | None,
+                    mat_data: MaterialData | None,
                     mm_px_resolution: float,
                     cal: bool = False) -> None:
         """A method to add a speckle pattern to an existing mesh object within
@@ -238,7 +241,7 @@ class BlenderScene():
         speckle_path : Path | None
             The filepath containing the speckle pattern image. If this is None,
             there will be capability to generate a speckle pattern.
-        mat_data : BlenderMaterialData | None
+        mat_data : pyvale.blender.MaterialData | None
             A dataclass containin the material parameters. If this is None, it
             is initialised within the method.
         mm_px_resolution: float
@@ -249,15 +252,15 @@ class BlenderScene():
             a Blender part object. When set to True, the part object is UV
             unwrapped differently to ensure the correct scaling, by default False
         """
-        BlenderTools.clear_material_nodes(part)
+        Tools.clear_material_nodes(part)
         if mat_data is None:
-            mat_data = BlenderMaterialData()
+            mat_data = MaterialData()
         if speckle_path.exists():
-            BlenderTools.add_image_texture(mat_data=mat_data, image_path=speckle_path)
+            Tools.add_image_texture(mat_data=mat_data, image_path=speckle_path)
         else:
             speckle_pattern = np.array() # Generate speckle pattern array
-            BlenderTools.add_image_texture(mat_data=mat_data, image_array=speckle_pattern)
-        BlenderTools.uv_unwrap_part(part, mm_px_resolution, cal)
+            Tools.add_image_texture(mat_data=mat_data, image_array=speckle_pattern)
+        Tools.uv_unwrap_part(part, mm_px_resolution, cal)
 
     def _debug_deform(self,
                       render_mesh: RenderMesh,
@@ -286,8 +289,8 @@ class BlenderScene():
             deformed_nodes = SimTools.get_deformed_nodes(timestep,
                                                          render_mesh)
             if deformed_nodes is not None:
-                BlenderTools.deform_single_timestep(part, deformed_nodes)
-                BlenderTools.set_new_frame(part)
+                Tools.deform_single_timestep(part, deformed_nodes)
+                Tools.set_new_frame(part)
 
     def render_single_image(self,
                             render_data: RenderData,
@@ -350,7 +353,7 @@ class BlenderScene():
                 bpy.context.scene.render.filepath = str(filepath)
                 if stage_image:
                     bpy.ops.render.render(write_still=True)
-                    image_array = BlenderTools.save_render_as_array(filepath)
+                    image_array = Tools.save_render_as_array(filepath)
                     image_arrays.append(image_array)
                 else:
                     bpy.ops.render.render(write_still=True)
@@ -367,7 +370,7 @@ class BlenderScene():
             bpy.context.scene.render.filepath = str(filepath)
             if stage_image:
                 bpy.ops.render.render(write_still=True)
-                image_array = BlenderTools.save_render_as_array(filepath)
+                image_array = Tools.save_render_as_array(filepath)
                 return image_array
             else:
                 bpy.ops.render.render(write_still=True)
@@ -375,7 +378,7 @@ class BlenderScene():
     def render_deformed_images(self,
                                render_mesh: RenderMesh,
                                sim_spat_dim: int,
-                               render_data:RenderData,
+                               render_data: RenderData,
                                part: bpy.data.objects,
                                stage_image: bool | None = True) -> None | np.ndarray:
         """A method to deform the mesh object at all timesteps, and render
@@ -439,8 +442,8 @@ class BlenderScene():
             deformed_nodes = SimTools.get_deformed_nodes(timestep,
                                                          render_mesh)
             if deformed_nodes is not None:
-                BlenderTools.deform_single_timestep(part, deformed_nodes)
-                BlenderTools.set_new_frame(part)
+                Tools.deform_single_timestep(part, deformed_nodes)
+                Tools.set_new_frame(part)
 
                 if isinstance(render_data.cam_data, tuple):
                     cam_count = 0
@@ -454,7 +457,7 @@ class BlenderScene():
                         bpy.context.scene.render.filepath = str(filepath)
                         if stage_image:
                             bpy.ops.render.render(write_still=True)
-                            image_array = BlenderTools.save_render_as_array(filepath)
+                            image_array = Tools.save_render_as_array(filepath)
                             image_arrays.append(image_array)
                         else:
                             bpy.ops.render.render(write_still=True)
@@ -467,7 +470,7 @@ class BlenderScene():
                     bpy.context.scene.render.filepath = str(filepath)
                     if stage_image:
                         bpy.ops.render.render(write_still=True)
-                        image_array = BlenderTools.save_render_as_array(filepath)
+                        image_array = Tools.save_render_as_array(filepath)
                         image_arrays.append(image_array)
                     else:
                         bpy.ops.render.render(write_still=True)

pyvale/{blendertools.py → blender/blendertools.py}

@@ -8,14 +8,18 @@ from pathlib import Path
 from scipy.spatial.transform import Rotation
 from PIL import Image
 import bpy
-from pyvale.cameratools import CameraTools
-from pyvale.blendermaterialdata import BlenderMaterialData
-from pyvale.blenderrenderdata import RenderData, RenderEngine
-from pyvale.blendercalibrationdata import CalibrationData
-from pyvale.output import Outputs
-from pyvale.pyvaleexceptions import BlenderError
-
-class BlenderTools:
+
+# Pyvale
+from pyvale.sensorsim.cameratools import CameraTools
+from pyvale.sensorsim.output import Outputs
+
+
+from pyvale.blender.blenderexceptions import BlenderError
+from pyvale.blender.blenderrenderdata import RenderEngine, RenderData
+from pyvale.blender.blendermaterialdata import MaterialData
+from pyvale.blender.blendercalibrationdata import CalibrationData
+
+class Tools:
     """Namespace for tools used within the pyvale Blender module.
     """
 
@@ -146,7 +150,7 @@ class BlenderTools:
         """
         if part.data.shape_keys is None:
             part.shape_key_add()
-            BlenderTools.set_new_frame(part)
+            Tools.set_new_frame(part)
         shape_key = part.shape_key_add()
         part.data.shape_keys.use_relative = False
 
@@ -207,7 +211,7 @@ class BlenderTools:
         part.select_set(False)
 
     @staticmethod
-    def add_image_texture(mat_data: BlenderMaterialData,
+    def add_image_texture(mat_data: MaterialData,
                           image_path: Path | None = None,
                           image_array: np.ndarray | None = None) -> None:
         """A method to add an image texture to a Blender object, this will

pyvale/dataset/__init__.py

@@ -0,0 +1,7 @@
+#===============================================================================
+# pyvale: the python validation engine
+# License: MIT
+# Copyright (C) 2025 The Computer Aided Validation Team
+#===============================================================================
+
+from .dataset import *