pyvale 2025.4.0__tar.gz → 2025.5.1__tar.gz

{pyvale-2025.4.0/src/pyvale.egg-info → pyvale-2025.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyvale
-Version: 2025.4.0
+Version: 2025.5.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
@@ -44,15 +44,19 @@ Requires-Dist: numba>=0.59.1
 Requires-Dist: pymoo>=0.6.1.3
 Requires-Dist: Cython>=3.0.0
 Requires-Dist: bpy>=4.2.0
+Requires-Dist: pyyaml>=6.0.2
+Requires-Dist: pytest>=8.3.5
 Dynamic: license-file
 
 # pyvale
 The python validation engine (`pyvale`): 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.
 
 ## 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://github.com/Computer-Aided-Validation-Laboratory/pyvale/blob/main/src/pyvale/examples/ex6_2_multiphysics3d_expsim.py).
+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.
 
-|![fig_thermomech3d_tc_vis](https://raw.githubusercontent.com/Computer-Aided-Validation-Laboratory/pyvale/main/images/thermomech3d_sg_vis.svg)|![fig_thermomech3d_sg_vis](https://raw.githubusercontent.com/Computer-Aided-Validation-Laboratory/pyvale/main/images/thermomech3d_sg_vis.svg)|
+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).
+
+|![fig_thermomech3d_tc_vis](https://raw.githubusercontent.com/Computer-Aided-Validation-Laboratory/pyvale/main/images/thermomech3d_tc_vis.svg)|![fig_thermomech3d_sg_vis](https://raw.githubusercontent.com/Computer-Aided-Validation-Laboratory/pyvale/main/images/thermomech3d_sg_vis.svg)|
 |--|--|
 |*Visualisation of the thermcouple locations.*|*Visualisation of the strain gauge locations.*|
 
@@ -118,21 +122,20 @@ pip install -e .
 pip install -e ./dependencies/mooseherder
 ```
 
-### MOOSE
+### Running Physics Simulations with MOOSE
 `pyvale` come pre-packaged with example `moose` physics simulation outputs (as *.e exodus files) to demonstrate its functionality. If you need to run additional simulation cases we recommend `proteus` (https://github.com/aurora-multiphysics/proteus) which has build scripts for common linux distributions.
 
-## Getting Started
-The examples folder in "pyvale/examples" includes a sequence of examples of increasing complexity that demonstrate the functionality of `pyvale`.
-
 ## Contributors
 The Computer Aided Validation Team at UKAEA:
-- Lloyd Fletcher (ScepticalRabbit), UK Atomic Energy Authority
-- John Charlton (coolmule0), UK Atomic Energy Authority
-- Joel Hirst (JoelPhys), UK Atomic Energy Authority
-- Lorna Sibson (lornasibson), UK Atomic Energy Authority
-- Adel Tayeb (3adelTayeb), UK Atomic Energy Authority
-- Alex Marsh (alexmarsh2), UK Atomic Energy Authority
-- Rory Spencer (fusmatrs), UK Atomic Energy Authority
+- Lloyd Fletcher ([ScepticalRabbit](https://github.com/ScepticalRabbit)), UK Atomic Energy Authority
+- Joel Hirst ([JoelPhys](https://github.com/JoelPhys)), UK Atomic Energy Authority
+- John Charlton ([coolmule0](https://github.com/coolmule0)), UK Atomic Energy Authority
+- Lorna Sibson ([lornasibson](https://github.com/lornasibson)), UK Atomic Energy Authority
+- Megan Sampson ([meganasampson](https://github.com/meganasampson)), UK Atomic Energy Authority
+- Michael Atkinson ([mikesmic](https://github.com/mikesmic)), UK Atomic Energy Authority
+- Adel Tayeb ([3adelTayeb](https://github.com/3adelTayeb)), UK Atomic Energy Authority
+- Alex Marsh ([alexmarsh2](https://github.com/alexmarsh2)), UK Atomic Energy Authority
+- Rory Spencer ([fusmatrs](https://github.com/orgs/Computer-Aided-Validation-Laboratory/people/fusmatrs)), UK Atomic Energy Authority
 
 
 

{pyvale-2025.4.0 → pyvale-2025.5.1}/README.md

@@ -2,9 +2,11 @@
 The python validation engine (`pyvale`): 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.
 
 ## 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://github.com/Computer-Aided-Validation-Laboratory/pyvale/blob/main/src/pyvale/examples/ex6_2_multiphysics3d_expsim.py).
+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.
 
-|![fig_thermomech3d_tc_vis](https://raw.githubusercontent.com/Computer-Aided-Validation-Laboratory/pyvale/main/images/thermomech3d_sg_vis.svg)|![fig_thermomech3d_sg_vis](https://raw.githubusercontent.com/Computer-Aided-Validation-Laboratory/pyvale/main/images/thermomech3d_sg_vis.svg)|
+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).
+
+|![fig_thermomech3d_tc_vis](https://raw.githubusercontent.com/Computer-Aided-Validation-Laboratory/pyvale/main/images/thermomech3d_tc_vis.svg)|![fig_thermomech3d_sg_vis](https://raw.githubusercontent.com/Computer-Aided-Validation-Laboratory/pyvale/main/images/thermomech3d_sg_vis.svg)|
 |--|--|
 |*Visualisation of the thermcouple locations.*|*Visualisation of the strain gauge locations.*|
 
@@ -70,21 +72,20 @@ pip install -e .
 pip install -e ./dependencies/mooseherder
 ```
 
-### MOOSE
+### Running Physics Simulations with MOOSE
 `pyvale` come pre-packaged with example `moose` physics simulation outputs (as *.e exodus files) to demonstrate its functionality. If you need to run additional simulation cases we recommend `proteus` (https://github.com/aurora-multiphysics/proteus) which has build scripts for common linux distributions.
 
-## Getting Started
-The examples folder in "pyvale/examples" includes a sequence of examples of increasing complexity that demonstrate the functionality of `pyvale`.
-
 ## Contributors
 The Computer Aided Validation Team at UKAEA:
-- Lloyd Fletcher (ScepticalRabbit), UK Atomic Energy Authority
-- John Charlton (coolmule0), UK Atomic Energy Authority
-- Joel Hirst (JoelPhys), UK Atomic Energy Authority
-- Lorna Sibson (lornasibson), UK Atomic Energy Authority
-- Adel Tayeb (3adelTayeb), UK Atomic Energy Authority
-- Alex Marsh (alexmarsh2), UK Atomic Energy Authority
-- Rory Spencer (fusmatrs), UK Atomic Energy Authority
+- Lloyd Fletcher ([ScepticalRabbit](https://github.com/ScepticalRabbit)), UK Atomic Energy Authority
+- Joel Hirst ([JoelPhys](https://github.com/JoelPhys)), UK Atomic Energy Authority
+- John Charlton ([coolmule0](https://github.com/coolmule0)), UK Atomic Energy Authority
+- Lorna Sibson ([lornasibson](https://github.com/lornasibson)), UK Atomic Energy Authority
+- Megan Sampson ([meganasampson](https://github.com/meganasampson)), UK Atomic Energy Authority
+- Michael Atkinson ([mikesmic](https://github.com/mikesmic)), UK Atomic Energy Authority
+- Adel Tayeb ([3adelTayeb](https://github.com/3adelTayeb)), UK Atomic Energy Authority
+- Alex Marsh ([alexmarsh2](https://github.com/alexmarsh2)), UK Atomic Energy Authority
+- Rory Spencer ([fusmatrs](https://github.com/orgs/Computer-Aided-Validation-Laboratory/people/fusmatrs)), UK Atomic Energy Authority
 
 
 

{pyvale-2025.4.0 → pyvale-2025.5.1}/pyproject.toml

@@ -1,10 +1,10 @@
 [build-system]
-requires = ["setuptools>=61.0", "wheel"]
+requires = ["setuptools>=61.0", "wheel", "Cython", "numpy"]
 build-backend = "setuptools.build_meta"
 
 [project]
 name = "pyvale"
-version = "2025.4.0"
+version = "2025.5.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" },
@@ -28,6 +28,8 @@ dependencies = [
   "pymoo>=0.6.1.3",
   "Cython>=3.0.0",
   "bpy>=4.2.0",
+  "pyyaml>=6.0.2",
+  "pytest>=8.3.5",
 ]
 
 [project.urls]

pyvale-2025.5.1/src/pyvale/__init__.py

@@ -0,0 +1,89 @@
+# ==============================================================================
+# pyvale: the python validation engine
+# License: MIT
+# Copyright (C) 2025 The Computer Aided Validation Team
+# ==============================================================================
+
+"""
+`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.
+"""
+
+# 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.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 *
+

pyvale-2025.5.1/src/pyvale/analyticmeshgen.py

@@ -0,0 +1,102 @@
+#===============================================================================
+# pyvale: the python validation engine
+# License: MIT
+# Copyright (C) 2025 The Computer Aided Validation Team
+#===============================================================================
+
+"""
+Analytic mesh creation tools for testing pyvale sensor simulation and
+uncertainty quantification functionality with a known analytic function for the
+scalar/vector/tensor field of interest.
+"""
+import numpy as np
+
+
+def rectangle_mesh_2d(leng_x: float,
+                      leng_y: float,
+                      n_elem_x: int,
+                      n_elem_y: int) -> tuple[np.ndarray,np.ndarray]:
+    """Creates the nodal coordinates and element connectivity table for a simple
+    2D quad mesh for a rectangular plate.
+
+    Parameters
+    ----------
+    leng_x : float
+        Length of the plate in the x direction.
+    leng_y : float
+        Length of the plate in the y direction.
+    n_elem_x : int
+        Number of elements along the x axis
+    n_elem_y : int
+        Number of elements along the y axis
+
+    Returns
+    -------
+    tuple[np.ndarray,np.ndarray]
+        The coordinates and connectivity table as numpy arrays. The coordinates
+        have shape=(n_nodes,coord[x,y,z]). The connectivity tables has shape=
+        (nodes_per_elem,num_elems).
+    """
+    n_elems = n_elem_x*n_elem_y
+    n_node_x = n_elem_x+1
+    n_node_y = n_elem_y+1
+    nodes_per_elem = 4
+
+    coord_x = np.linspace(0,leng_x,n_node_x)
+    coord_y = np.linspace(0,leng_y,n_node_y)
+    (coord_grid_x,coord_grid_y) = np.meshgrid(coord_x,coord_y)
+
+    coord_x = np.atleast_2d(coord_grid_x.flatten()).T
+    coord_y = np.atleast_2d(coord_grid_y.flatten()).T
+    coord_z = np.zeros_like(coord_x)
+    coords = np.hstack((coord_x,coord_y,coord_z))
+
+    connect = np.zeros((n_elems,nodes_per_elem)).astype(np.int64)
+    row = 1
+    nn = 0
+    for ee in range(n_elems):
+        nn += 1
+        if nn >= row*n_node_x:
+            row += 1
+            nn += 1
+
+        connect[ee,:] = np.array([nn,nn+1,nn+n_node_x+1,nn+n_node_x])
+    connect = connect.T
+
+    return (coords,connect)
+
+
+def fill_dims_2d(coord_x: np.ndarray,
+              coord_y: np.ndarray,
+              time: np.ndarray) -> tuple[np.ndarray,np.ndarray,np.ndarray]:
+    """Helper function to generate 2D filled arrays tih consistent dimensions
+    for array based maths operations. Takes 1D input vectors for the x, y and
+    time dimensions and returns 2D arrays with shape=(num_coords,num_timesteps).
+    Useful for evaluating analytical functions in space and time.
+
+    Parameters
+    ----------
+    coord_x : np.ndarray
+        1D flattened coordinate list for the x axis.
+    coord_y : np.ndarray
+        1D flattened coordinate list for the y axis.
+    time : np.ndarray
+        1D array of time steps.
+
+
+    Returns
+    -------
+    tuple[np.ndarray,np.ndarray,np.ndarray]
+        Filled 2D arrays with shape=(num_coords,num_timesteps) for the x, y and
+        time parameters respectively.
+    """
+    full_x = np.repeat(np.atleast_2d(coord_x).T,
+                       time.shape[0],
+                       axis=1)
+    full_y = np.repeat(np.atleast_2d(coord_y).T,
+                       time.shape[0],
+                       axis=1)
+    full_time = np.repeat(np.atleast_2d(time),
+                          coord_x.shape[0],
+                          axis=0)
+    return (full_x,full_y,full_time)

{pyvale-2025.4.0/src/pyvale/core → pyvale-2025.5.1/src/pyvale}/analyticsimdatafactory.py

@@ -1,20 +1,32 @@
+# ==============================================================================
+# pyvale: the python validation engine
+# License: MIT
+# Copyright (C) 2025 The Computer Aided Validation Team
+# ==============================================================================
+
 """
-================================================================================
-pyvale: the python validation engine
-License: MIT
-Copyright (C) 2025 The Computer Aided Validation Team
-================================================================================
+Helper functions and mini factory for building standard test meshes with
+analytic functions for the physical fields.
 """
+
 import numpy as np
 import sympy
 import mooseherder as mh
-from pyvale.core.analyticsimdatagenerator import (AnalyticCaseData2D,
-                                                  AnalyticSimDataGenerator)
+from pyvale.analyticsimdatagenerator import (AnalyticData2D,
+                                                  AnalyticSimDataGen)
+
 
-# NOTE: This module is a feature under developement.
+def standard_case_2d() -> AnalyticData2D:
+    """Created the standard 2D analytic test case which is a plate with
+    dimensions 10x7.5 (x,y), number of elements 40x30 (x,y), and time steps of
+    0 to 10 in increments of 1.
 
-def standard_case_2d() -> AnalyticCaseData2D:
-    case_data = AnalyticCaseData2D()
+    Returns
+    -------
+    AnalyticCaseData2D
+        _description_
+    """
+    case_data = AnalyticData2D()
     case_data.length_x = 10.0
     case_data.length_y = 7.5
     n_elem_mult = 10
@@ -25,10 +37,20 @@ def standard_case_2d() -> AnalyticCaseData2D:
 
 
 class AnalyticCaseFactory:
+    """Namespace for function used to build pre-defined 2D meshes and fields
+    based on analytic functions for testing the sensor simulation functionality
+    of pyvale.
+    """
 
     @staticmethod
-    def scalar_linear_2d() -> tuple[mh.SimData,AnalyticSimDataGenerator]:
-
+    def scalar_linear_2d() -> tuple[mh.SimData,AnalyticSimDataGen]:
+        """_summary_
+
+        Returns
+        -------
+        tuple[mh.SimData,AnalyticSimDataGenerator]
+            _description_
+        """
         case_data = standard_case_2d()
         (sym_y,sym_x,sym_t) = sympy.symbols("y,x,t")
         case_data.funcs_x = (20.0/case_data.length_x * sym_x,)
@@ -37,22 +59,28 @@ class AnalyticCaseFactory:
         case_data.offsets_space = (20.0,)
         case_data.offsets_time = (0.0,)
 
-        data_gen = AnalyticSimDataGenerator(case_data)
+        data_gen = AnalyticSimDataGen(case_data)
 
         sim_data = data_gen.generate_sim_data()
 
         return (sim_data,data_gen)
 
     @staticmethod
-    def scalar_quadratic_2d() -> tuple[mh.SimData,AnalyticSimDataGenerator]:
-
+    def scalar_quadratic_2d() -> tuple[mh.SimData,AnalyticSimDataGen]:
+        """_summary_
+
+        Returns
+        -------
+        tuple[mh.SimData,AnalyticSimDataGenerator]
+            _description_
+        """
         case_data = standard_case_2d()
         (sym_y,sym_x,sym_t) = sympy.symbols("y,x,t")
         case_data.funcs_x = (sym_x*(sym_x - case_data.length_x),)
         case_data.funcs_y = (sym_y*(sym_y - case_data.length_y),)
         case_data.funcs_t = (sym_t,)
 
-        data_gen = AnalyticSimDataGenerator(case_data)
+        data_gen = AnalyticSimDataGen(case_data)
 
         sim_data = data_gen.generate_sim_data()