pyvale 2025.7.1__tar.gz → 2025.8.1__tar.gz

{pyvale-2025.7.1/src/pyvale.egg-info → pyvale-2025.8.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyvale
-Version: 2025.7.1
+Version: 2025.8.1
 Summary: An all-in-one package for sensor simulation, sensor uncertainty quantification, sensor placement optimisation and simulation calibration or validation.
 Author-email: "scepticalrabbit et al." <thescepticalrabbit@gmail.com>
 License: MIT License
@@ -29,7 +29,6 @@ Project-URL: Issue Tracker, https://github.com/Digital-Validation-Laboratory/pyv
 Requires-Python: ==3.11.*
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: mooseherder>=0.1.0
 Requires-Dist: numpy<2.0.0
 Requires-Dist: scipy>=1.14.0
 Requires-Dist: netCDF4>=1.6.5
@@ -54,22 +53,22 @@ Dynamic: license-file
 # pyvale
 ![fig_pyvale_logo](https://raw.githubusercontent.com/Computer-Aided-Validation-Laboratory/pyvale/main/images/pyvale_logo.png)
 
-The python validation engine (`pyvale`) is you 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.
+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.
 
-We provide dedicated tools for simulation and uncertainty quantification of imaging sensors including digital image correlation (DIC) and infra-red thermography (IRT). Check out the [documentation](https://computer-aided-validation-laboratory.github.io/pyvale/index.html) to get started with some of our examples.
+We are actively developing dedicated tools for simulation and uncertainty quantification of imaging sensors including digital image correlation (DIC) and infra-red thermography (IRT). Check out the [documentation](https://computer-aided-validation-laboratory.github.io/pyvale/index.html) to get started with some of our examples.
 
 ## Quick Demo: Simulating Point Sensors
 Here we demonstrate how `pyvale` can be used to simulate thermocouples and strain gauges applied to a [MOOSE](https://mooseframework.inl.gov/index.html) thermo-mechanical simulation of a fusion divertor armour heatsink. The figures below show visualisations of the virtual thermocouple and strain gauge locations on the simualtion mesh as well as time traces for each sensor over a series of simulated experiments.
 
-The code to run the simulated experiments and produce the output shown here comes from [this example](https://computer-aided-validation-laboratory.github.io/pyvale/examples/point/ex4_2.html). You can find more examples and details of `pyvale` python API in the `pyvale` [documentation](https://computer-aided-validation-laboratory.github.io/pyvale/index.html).
+The code to run the simulated experiments and produce the output shown here comes from [this example](https://computer-aided-validation-laboratory.github.io/pyvale/examples/basics/ex4_2_expsim3d_thermmech3d.html). You can find more examples and details of `pyvale` python API in the `pyvale` [documentation](https://computer-aided-validation-laboratory.github.io/pyvale/index.html).
 
 |![fig_thermomech3d_tc_vis](https://raw.githubusercontent.com/Computer-Aided-Validation-Laboratory/pyvale/main/images/thermomech3d_tc_vis.png)|![fig_thermomech3d_sg_vis](https://raw.githubusercontent.com/Computer-Aided-Validation-Laboratory/pyvale/main/images/thermomech3d_sg_vis.png)|
 |--|--|
-|*Visualisation of the thermcouple locations.*|*Visualisation of the strain gauge locations.*|
+|*Visualisation of the thermocouple locations.*|*Visualisation of the strain gauge locations.*|
 
 |![fig_thermomech3d_tc_traces](https://raw.githubusercontent.com/Computer-Aided-Validation-Laboratory/pyvale/main/images/thermomech3d_tc_traces.png)|![fig_thermomech3d_sg_traces](https://raw.githubusercontent.com/Computer-Aided-Validation-Laboratory/pyvale/main/images/thermomech3d_sg_traces.png)|
 |--|--|
-|*Thermocouples time traces over a series of simulated experiments.*|*Strain gauge time traces over a series of simulated experiments.*|
+|*Thermocouple time traces over a series of simulated experiments.*|*Strain gauge time traces over a series of simulated experiments.*|
 
 
 ## Quick Install

{pyvale-2025.7.1 → pyvale-2025.8.1}/README.md

@@ -1,22 +1,22 @@
 # pyvale
 ![fig_pyvale_logo](https://raw.githubusercontent.com/Computer-Aided-Validation-Laboratory/pyvale/main/images/pyvale_logo.png)
 
-The python validation engine (`pyvale`) is you 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.
+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.
 
-We provide dedicated tools for simulation and uncertainty quantification of imaging sensors including digital image correlation (DIC) and infra-red thermography (IRT). Check out the [documentation](https://computer-aided-validation-laboratory.github.io/pyvale/index.html) to get started with some of our examples.
+We are actively developing dedicated tools for simulation and uncertainty quantification of imaging sensors including digital image correlation (DIC) and infra-red thermography (IRT). Check out the [documentation](https://computer-aided-validation-laboratory.github.io/pyvale/index.html) to get started with some of our examples.
 
 ## Quick Demo: Simulating Point Sensors
 Here we demonstrate how `pyvale` can be used to simulate thermocouples and strain gauges applied to a [MOOSE](https://mooseframework.inl.gov/index.html) thermo-mechanical simulation of a fusion divertor armour heatsink. The figures below show visualisations of the virtual thermocouple and strain gauge locations on the simualtion mesh as well as time traces for each sensor over a series of simulated experiments.
 
-The code to run the simulated experiments and produce the output shown here comes from [this example](https://computer-aided-validation-laboratory.github.io/pyvale/examples/point/ex4_2.html). You can find more examples and details of `pyvale` python API in the `pyvale` [documentation](https://computer-aided-validation-laboratory.github.io/pyvale/index.html).
+The code to run the simulated experiments and produce the output shown here comes from [this example](https://computer-aided-validation-laboratory.github.io/pyvale/examples/basics/ex4_2_expsim3d_thermmech3d.html). You can find more examples and details of `pyvale` python API in the `pyvale` [documentation](https://computer-aided-validation-laboratory.github.io/pyvale/index.html).
 
 |![fig_thermomech3d_tc_vis](https://raw.githubusercontent.com/Computer-Aided-Validation-Laboratory/pyvale/main/images/thermomech3d_tc_vis.png)|![fig_thermomech3d_sg_vis](https://raw.githubusercontent.com/Computer-Aided-Validation-Laboratory/pyvale/main/images/thermomech3d_sg_vis.png)|
 |--|--|
-|*Visualisation of the thermcouple locations.*|*Visualisation of the strain gauge locations.*|
+|*Visualisation of the thermocouple locations.*|*Visualisation of the strain gauge locations.*|
 
 |![fig_thermomech3d_tc_traces](https://raw.githubusercontent.com/Computer-Aided-Validation-Laboratory/pyvale/main/images/thermomech3d_tc_traces.png)|![fig_thermomech3d_sg_traces](https://raw.githubusercontent.com/Computer-Aided-Validation-Laboratory/pyvale/main/images/thermomech3d_sg_traces.png)|
 |--|--|
-|*Thermocouples time traces over a series of simulated experiments.*|*Strain gauge time traces over a series of simulated experiments.*|
+|*Thermocouple time traces over a series of simulated experiments.*|*Strain gauge time traces over a series of simulated experiments.*|
 
 
 ## Quick Install

{pyvale-2025.7.1 → pyvale-2025.8.1}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pyvale"
-version = "2025.7.1"
+version = "2025.8.1"
 description = "An all-in-one package for sensor simulation, sensor uncertainty quantification, sensor placement optimisation and simulation calibration or validation."
 authors = [
   { name = "scepticalrabbit et al.", email = "thescepticalrabbit@gmail.com" },
@@ -14,7 +14,6 @@ license = { file = "LICENSE" }
 readme = "README.md"
 requires-python = "==3.11.*"
 dependencies = [
-  "mooseherder>=0.1.0",
   "numpy<2.0.0",
   "scipy>=1.14.0",
   "netCDF4>=1.6.5",
@@ -36,6 +35,12 @@ dependencies = [
   "opencv-python<=4.9.0.80"
 ]
 
+[tool.pytest.ini_options]
+pythonpath = [
+    "src",
+    "tests"
+]
+
 [project.urls]
 "Repository" = "https://github.com/Digital-Validation-Laboratory/pyvale"
 "Issue Tracker" = "https://github.com/Digital-Validation-Laboratory/pyvale/issues"

{pyvale-2025.7.1 → pyvale-2025.8.1}/setup.py

@@ -1,3 +1,9 @@
+#===============================================================================
+# pyvale: the python validation engine
+# License: MIT
+# Copyright (C) 2025 The Computer Aided Validation Team
+#===============================================================================
+
 from setuptools import  setup, Extension
 from Cython.Build import cythonize
 import numpy
@@ -34,17 +40,15 @@ else:
 
 
 ext_cython = Extension(
-    "pyvale.cython.rastercyth",
-    ["src/pyvale/cython/rastercyth.py"],
+    "pyvale.sensorsim.cython.rastercyth",
+    ["src/pyvale/sensorsim/cython/rastercyth.py"],
     include_dirs=[numpy.get_include()],
     extra_compile_args=[openmp_flag],
     extra_link_args=[openmp_flag],
 )
 
-
-
 ext_dic = Extension(
-    'pyvale.dic2dcpp',
+    'pyvale.dic.dic2dcpp',
     sorted(glob("src/pyvale/dic/cpp/dic*.cpp")),
     language="c++",
     include_dirs=[pybind11.get_include()],

pyvale-2025.8.1/src/pyvale/__init__.py

@@ -0,0 +1,21 @@
+# ==============================================================================
+# pyvale: the python validation engine
+# License: MIT
+# Copyright (C) 2025 The Computer Aided Validation Team
+# ==============================================================================
+
+"""
+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.
+"""
+
+from . import dic
+from . import blender
+from . import sensorsim
+from . import mooseherder
+from . import dataset

pyvale-2025.8.1/src/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-2025.7.1/src/pyvale/pyvaleexceptions.py → pyvale-2025.8.1/src/pyvale/blender/blenderexceptions.py

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

{pyvale-2025.7.1/src/pyvale → pyvale-2025.8.1/src/pyvale/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-2025.7.1/src/pyvale → pyvale-2025.8.1/src/pyvale/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-2025.7.1/src/pyvale → pyvale-2025.8.1/src/pyvale/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-2025.7.1/src/pyvale → pyvale-2025.8.1/src/pyvale/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-2025.7.1/src/pyvale → pyvale-2025.8.1/src/pyvale/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-2025.8.1/src/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 *