.. pyvale documentation master file, created by
   sphinx-quickstart on Wed Apr  2 13:15:20 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.


.. image:: ./_static/pyvale_logo.png
   :alt: Pyvale Logo
   :align: center
   :width: 600px

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.

**Current Release:**  |release|

**Useful links:**  | `Source Repository <https://github.com/Computer-Aided-Validation-Laboratory/pyvale>`_ | `Issues  <https://github.com/Computer-Aided-Validation-Laboratory/pyvale/issues>`_ | `PyPI <https://pypi.org/project/pyvale/>`_ | `MIT License <https://choosealicense.com/licenses/mit/>`_ |

.. toctree::
   :maxdepth: 1
   :caption: Contents:

   guide
   install
   examples
   api_py
   api_cpp
   cite

Contributors
------------

The Computer Aided Validation Team at United Kingdom Atomic Energy Authority (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/lornasibsin>`_), UK Atomic Energy Authority
* Megan Sampson (`megan sampson <https://github.com/meganasampson>`_), 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 (`fusmatr <https://github.com/fusmatrs>`_), UK Atomic Energy Authority
* John Charlton  (`coolmule0 <https://github.com/coolmule0>`_), UK Atomic Energy Authority