pyvale 2026.1.1__cp311-cp311-manylinux_2_17_i686.manylinux2014_i686.whl

pyvale/verif/pointsenstensor.py

@@ -0,0 +1,159 @@
+#===============================================================================
+# pyvale: the python validation engine
+# License: MIT
+# Copyright (C) 2025 The Computer Aided Validation Team
+#===============================================================================
+import copy
+import pyvale.mooseherder as mh
+import pyvale.sensorsim as sens
+import pyvale.verif.pointsensmech as pointsensmech
+import pyvale.verif.analyticsimdatafactory as asd
+
+"""
+DEVELOPER VERIFICATION MODULE
+--------------------------------------------------------------------------------
+This module contains developer utility functions used for verification testing
+of the point sensor simulation toolbox in pyvale.
+
+Specifically, this module contains functions used for testing point sensors
+applied to tensor fields.
+"""
+
+# TODO
+# - Calibration errors for tensor fields
+
+def simdata_tens_2d_analytic() -> mh.SimData:
+    (sim_data,_) = asd.tensor_linear_2d()
+    return sim_data
+
+def simdata_tens_2d_analytic_nomesh() -> mh.SimData:
+    sim_data = simdata_tens_2d_analytic()
+    sim_data.connect = None
+    return sim_data
+
+def sens_array_2d_noerrs(sim_data: mh.SimData,
+                         sens_data: sens.SensorData,
+                         spatial_dims: sens.EDim = sens.EDim.TWOD,
+                         ) -> sens.SensorsPoint:
+    descriptor = sens.DescriptorFactory.strain()
+    field_name = "strain"
+    norm_comps = ("strain_xx","strain_yy")
+    dev_comps = ("strain_xy",)
+    field = sens.FieldTensor(sim_data,
+                            norm_comp_keys=norm_comps,
+                            dev_comp_keys=dev_comps,
+                            spatial_dims=spatial_dims)
+    sens_array = sens.SensorsPoint(sens_data,
+                                      field,
+                                      descriptor)
+    return sens_array
+
+
+def sens_array_3d_noerrs(sim_data: mh.SimData,
+                         sens_data: sens.SensorData,
+                         spatial_dims: sens.EDim = sens.EDim.THREED,
+                         ) -> sens.SensorsPoint:
+    descriptor = sens.DescriptorFactory.strain()
+    field_name = "strain"
+    norm_comps = ("strain_xx","strain_yy","strain_zz")
+    dev_comps = ("strain_xy","strain_yz","strain_xz")
+    field = sens.FieldTensor(sim_data,
+                            norm_comp_keys=norm_comps,
+                            dev_comp_keys=dev_comps,
+                            spatial_dims=spatial_dims)
+    sens_array =  sens.SensorsPoint(sens_data,
+                                       field,
+                                       descriptor)
+    return sens_array
+
+#-------------------------------------------------------------------------------
+def gen_sens_arrays_2d_dict(sim_data: mh.SimData,
+                            sens_data_dict: dict[str,sens.SensorData],
+                            sens_tag: str,
+                            ) -> dict[str,sens.SensorsPoint]:
+    sens_dict = {}
+    for ss in sens_data_dict:
+        sens_array = sens_array_2d_noerrs(sim_data,sens_data_dict[ss])
+
+        pos_lock = pointsensmech.sens_pos_2d_lock(sens_data_dict[ss].positions)
+        for kk in pos_lock:
+            if kk in ss:
+                pos_lock_key = kk
+                break
+
+        err_chain_dict = pointsensmech.err_chain_2d_dict(sens_array.get_field(),
+                                           sens_data_dict[ss].positions,
+                                           sens_data_dict[ss].sample_times,
+                                           pos_lock[pos_lock_key])
+
+        for ee in err_chain_dict:
+            tag = f"{sens_tag}_{ss}_err-{ee}"
+            sens_dict[tag] = copy.deepcopy(sens_array)
+
+            if err_chain_dict[ee] is not None:
+                err_int_opts = sens.ErrIntOpts()
+                sens_dict[tag].set_error_chain(err_chain_dict[ee],
+                                               err_int_opts)
+
+    return sens_dict
+
+def gen_sens_arrays_3d_dict(sim_data: mh.SimData,
+                            sens_data_dict: dict[str,sens.SensorData],
+                            sens_tag: str,
+                            ) -> dict[str,sens.SensorsPoint]:
+    sens_dict = {}
+    for ss in sens_data_dict:
+        sens_array = sens_array_3d_noerrs(sim_data,sens_data_dict[ss])
+
+        pos_lock = pointsensmech.sens_pos_3d_lock(sens_data_dict[ss].positions)
+        for kk in pos_lock:
+            if kk in ss:
+                pos_lock_key = kk
+                break
+
+        err_chain_dict = pointsensmech.err_chain_3d_dict(sens_array.get_field(),
+                                           sens_data_dict[ss].positions,
+                                           sens_data_dict[ss].sample_times,
+                                           pos_lock=pos_lock[pos_lock_key])
+
+        for ee in err_chain_dict:
+            tag = f"{sens_tag}_{ss}_err-{ee}"
+            sens_dict[tag] = copy.deepcopy(sens_array)
+
+            if err_chain_dict[ee] is not None:
+                err_int_opts = sens.ErrIntOpts()
+                sens_dict[tag].set_error_chain(err_chain_dict[ee],
+                                               err_int_opts)
+
+    return sens_dict
+#-------------------------------------------------------------------------------
+def sens_arrays_2d_dict() -> dict[str,sens.SensorsPoint]:
+    sim_data = pointsensmech.simdata_mech_2d()
+    sens_data_dict = pointsensmech.sens_data_2d_dict(sim_data)
+    tag = "tens2d"
+    return gen_sens_arrays_2d_dict(sim_data,sens_data_dict,tag)
+
+def sens_arrays_2d_analytic_dict() -> dict[str,sens.SensorsPoint]:
+    sim_data = simdata_tens_2d_analytic()
+    sens_data_dict = pointsensmech.sens_data_2d_dict(sim_data)
+    tag = "tens2d_analytic"
+    return gen_sens_arrays_2d_dict(sim_data,sens_data_dict,tag)
+
+def sens_arrays_2d_analytic_nomesh_dict() -> dict[str,sens.SensorsPoint]:
+    sim_data = simdata_tens_2d_analytic_nomesh()
+    sens_data_dict = pointsensmech.sens_data_2d_dict(sim_data)
+    tag = "tens2d_analytic_nomesh"
+    return gen_sens_arrays_2d_dict(sim_data,sens_data_dict,tag)
+
+
+def sens_arrays_3d_dict() -> dict[str,sens.SensorsPoint]:
+    sim_data = pointsensmech.simdata_mech_3d()
+    sens_data_dict = pointsensmech.sens_data_3d_dict(sim_data)
+    tag = "tens3d"
+    return gen_sens_arrays_3d_dict(sim_data,sens_data_dict,tag)
+
+def sens_arrays_3d_nomesh_dict() -> dict[str,sens.SensorsPoint]:
+    sim_data = pointsensmech.simdata_mech_3d_nomesh()
+    sens_data_dict = pointsensmech.sens_data_3d_dict(sim_data)
+    tag = "tens3d_nomesh"
+    return gen_sens_arrays_3d_dict(sim_data,sens_data_dict,tag)

pyvale/verif/pointsensvector.py

@@ -0,0 +1,157 @@
+#===============================================================================
+# pyvale: the python validation engine
+# License: MIT
+# Copyright (C) 2025 The Computer Aided Validation Team
+#===============================================================================
+import copy
+import pyvale.mooseherder as mh
+import pyvale.sensorsim as sens
+import pyvale.verif.pointsensmech as pointsensmech
+import pyvale.verif.analyticsimdatafactory as asd
+
+
+"""
+DEVELOPER VERIFICATION MODULE
+--------------------------------------------------------------------------------
+This module contains developer utility functions used for verification testing
+of the point sensor simulation toolbox in pyvale.
+
+Specifically, this module contains functions used for testing point sensors
+applied to vector fields.
+"""
+
+# TODO
+# - Calibration errors for vector fields
+
+def simdata_vec_2d_analytic() -> mh.SimData:
+    (sim_data,_) = asd.vector_linear_2d()
+    return sim_data
+
+def simdata_vec_2d_analytic_nomesh() -> mh.SimData:
+    sim_data = simdata_vec_2d_analytic()
+    sim_data.connect = None
+    return sim_data
+
+
+def sens_array_2d_noerrs(sim_data: mh.SimData,
+                   sens_data: sens.SensorData,
+                   spatial_dims: sens.EDim = sens.EDim.TWOD,
+                   ) -> sens.SensorsPoint:
+    descriptor = sens.DescriptorFactory.displacement()
+    field = sens.FieldVector(sim_data,
+                            comp_keys=("disp_x","disp_y"),
+                            spatial_dims=spatial_dims)
+    sens_array = sens.SensorsPoint(sens_data,
+                                      field,
+                                      descriptor)
+    return sens_array
+
+
+def sens_array_3d_noerrs(sim_data: mh.SimData,
+                   sens_data: sens.SensorData,
+                   spatial_dims: sens.EDim = sens.EDim.THREED
+                   ) -> sens.SensorsPoint:
+    descriptor = sens.DescriptorFactory.displacement()
+    field = sens.FieldVector(sim_data,
+                            comp_keys=("disp_x","disp_y","disp_z"),
+                            spatial_dims=spatial_dims)
+    sens_array =  sens.SensorsPoint(sens_data,
+                                       field,
+                                       descriptor)
+    return sens_array
+
+#-------------------------------------------------------------------------------
+def gen_sens_arrays_2d_dict(sim_data: mh.SimData,
+                            sens_data_dict: dict[str,sens.SensorData],
+                            sens_tag: str,
+                            ) -> dict[str,sens.SensorsPoint]:
+    sens_dict = {}
+    for ss in sens_data_dict:
+        sens_array = sens_array_2d_noerrs(sim_data,sens_data_dict[ss])
+
+        pos_lock = pointsensmech.sens_pos_2d_lock(sens_data_dict[ss].positions)
+        for kk in pos_lock:
+            if kk in ss:
+                pos_lock_key = kk
+                break
+
+        err_chain_dict = pointsensmech.err_chain_2d_dict(sens_array.get_field(),
+                                           sens_data_dict[ss].positions,
+                                           sens_data_dict[ss].sample_times,
+                                           pos_lock[pos_lock_key])
+
+        for ee in err_chain_dict:
+            tag = f"{sens_tag}_{ss}_err-{ee}"
+            sens_dict[tag] = copy.deepcopy(sens_array)
+
+            if err_chain_dict[ee] is not None:
+                err_int_opts = sens.ErrIntOpts()
+                sens_dict[tag].set_error_chain(err_chain_dict[ee],
+                                               err_int_opts)
+
+    return sens_dict
+
+
+def gen_sens_arrays_3d_dict(sim_data: mh.SimData,
+                            sens_data_dict: dict[str,sens.SensorData],
+                            sens_tag: str,
+                            ) -> dict[str,sens.SensorsPoint]:
+    sens_dict = {}
+    for ss in sens_data_dict:
+        sens_array = sens_array_3d_noerrs(sim_data,sens_data_dict[ss])
+
+        pos_lock = pointsensmech.sens_pos_3d_lock(sens_data_dict[ss].positions)
+        for kk in pos_lock:
+            if kk in ss:
+                pos_lock_key = kk
+                break
+
+        err_chain_dict = pointsensmech.err_chain_3d_dict(sens_array.get_field(),
+                                           sens_data_dict[ss].positions,
+                                           sens_data_dict[ss].sample_times,
+                                           pos_lock=pos_lock[pos_lock_key])
+
+        for ee in err_chain_dict:
+            tag = f"{sens_tag}_{ss}_err-{ee}"
+            sens_dict[tag] = copy.deepcopy(sens_array)
+
+            if err_chain_dict[ee] is not None:
+                err_int_opts = sens.ErrIntOpts()
+                sens_dict[tag].set_error_chain(err_chain_dict[ee],
+                                               err_int_opts)
+
+    return sens_dict
+
+
+#-------------------------------------------------------------------------------
+def sens_arrays_2d_dict() -> dict[str,sens.SensorsPoint]:
+    sim_data = pointsensmech.simdata_mech_2d()
+    sens_data_dict = pointsensmech.sens_data_2d_dict(sim_data)
+    tag = "vec2d"
+    return gen_sens_arrays_2d_dict(sim_data,sens_data_dict,tag)
+
+def sens_arrays_2d_analytic_dict() -> dict[str,sens.SensorsPoint]:
+    sim_data = simdata_vec_2d_analytic()
+    sens_data_dict = pointsensmech.sens_data_2d_dict(sim_data)
+    tag = "vec2d_analytic"
+    return gen_sens_arrays_2d_dict(sim_data,sens_data_dict,tag)
+
+def sens_arrays_2d_analytic_nomesh_dict() -> dict[str,sens.SensorsPoint]:
+    sim_data = simdata_vec_2d_analytic_nomesh()
+    sens_data_dict = pointsensmech.sens_data_2d_dict(sim_data)
+    tag = "vec2d_analytic_nomesh"
+    return gen_sens_arrays_2d_dict(sim_data,sens_data_dict,tag)
+
+
+def sens_arrays_3d_dict() -> dict[str,sens.SensorsPoint]:
+    sim_data = pointsensmech.simdata_mech_3d()
+    sens_data_dict = pointsensmech.sens_data_3d_dict(sim_data)
+    tag = "vec3d"
+    return gen_sens_arrays_3d_dict(sim_data,sens_data_dict,tag)
+
+
+def sens_arrays_3d_nomesh_dict() -> dict[str,sens.SensorsPoint]:
+    sim_data = pointsensmech.simdata_mech_3d_nomesh()
+    sens_data_dict = pointsensmech.sens_data_3d_dict(sim_data)
+    tag = "vec3d_nomesh"
+    return gen_sens_arrays_3d_dict(sim_data,sens_data_dict,tag)

pyvale-2026.1.1.dist-info/METADATA

@@ -0,0 +1,98 @@
+Metadata-Version: 2.2
+Name: pyvale
+Version: 2026.1.1
+Summary: Your virtual engineering lab: An all-in-one package for sensor simulation, uncertainty quantification, sensor placement optimisation and simulation calibration or validation.
+Author-Email: "scepticalrabbit et al." <thescepticalrabbit@gmail.com>
+License: MIT License
+         
+         Copyright (C) 2025 The Computer Aided Validation Team at UKAEA
+         
+         Permission is hereby granted, free of charge, to any person obtaining a copy
+         of this software and associated documentation files (the "Software"), to deal
+         in the Software without restriction, including without limitation the rights
+         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+         copies of the Software, and to permit persons to whom the Software is
+         furnished to do so, subject to the following conditions:
+         
+         The above copyright notice and this permission notice shall be included in all
+         copies or substantial portions of the Software.
+         
+         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+         SOFTWARE.
+Project-URL: Repository, https://github.com/Computer-Aided-Validation-Laboratory/pyvale
+Project-URL: Issue Tracker, https://github.com/Computer-Aided-Validation-Laboratory/pyvale/issues
+Requires-Python: ==3.11.*
+Requires-Dist: numpy<2.0.0
+Requires-Dist: scipy>=1.14.0
+Requires-Dist: netCDF4>=1.6.5
+Requires-Dist: pyvista>=0.43.3
+Requires-Dist: matplotlib>=3.8
+Requires-Dist: shapely>=2.0.4
+Requires-Dist: sympy>=1.13.0
+Requires-Dist: PyQT6>=6.7.1
+Requires-Dist: imageio>=2.36.1
+Requires-Dist: imageio-ffmpeg>=0.5.1
+Requires-Dist: numba==0.59.1
+Requires-Dist: pymoo>=0.6.1.3
+Requires-Dist: Cython==3.2.3
+Requires-Dist: bpy==4.5.4
+Requires-Dist: pyyaml>=6.0.2
+Requires-Dist: pytest>=8.3.5
+Requires-Dist: pybind11>=2.13.6
+Requires-Dist: pyqtgraph>=0.13.7
+Requires-Dist: opencv-python<=4.9.0.80
+Requires-Dist: pandas>=2.3.1
+Requires-Dist: scikit-build-core>=0.11.6
+Requires-Dist: ninja>=1.13.0
+Description-Content-Type: text/markdown
+
+# pyvale
+![fig_pyvale_logo](https://raw.githubusercontent.com/Computer-Aided-Validation-Laboratory/pyvale/main/images/pyvale_logo.png)
+
+The python validation engine (`pyvale`) is your virtual engineering laboratory: An all-in-one package for sensor uncertainty quantification simulations, experimental design/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 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/basicsensorsim/ex0_quickstart.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 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)|
+|--|--|
+|*Thermocouple time traces over a series of simulated experiments.*|*Strain gauge time traces over a series of simulated experiments.*|
+
+
+## Quick Install
+`pyvale` can be installed from pypi:
+```shell
+pip install pyvale
+```
+
+We recommend installing `pyvale` into a virtual environment of your choice as `pyvale` requires python 3.11. If you need help setting up your virtual environment and installing `pyvale` head over to the [installation guide](https://computer-aided-validation-laboratory.github.io/pyvale/install/install.html) in our docs.
+
+## Contributors
+The Computer Aided Validation Team at UKAEA:
+- Lloyd Fletcher ([ScepticalRabbit](https://github.com/ScepticalRabbit)), UK Atomic Energy Authority
+- Joel Hirst ([JoelPhys](https://github.com/JoelPhys)), 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
+- John Charlton ([coolmule0](https://github.com/coolmule0)), UK Atomic Energy Authority
+
+
+
+
+