Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Pyvale: The Python Validation Engine
Light Logo Dark Logo
Pyvale: The Python Validation Engine

Contents:

  • User Guide
  • Installation
    • Windows 11
    • Ubuntu Linux
    • MacOS
  • Examples
    • Basics
      • Basics: Pyvale point sensor simulation
      • Basics: Sensor model & get_measurements() vs calc_measurements()
      • Basics: Building a point sensor array from scratch with custom errors
      • Basics: Overview of the basic error library
      • Basics: Field-based systematic errors
      • Basics: Sensor calibration systematic errors
      • Basics: Sensor spatial averaging and averaging errors
      • Basics: Vector field (displacement) sensors
      • Basics: Custom vector field sensors
      • Basics: Sensor angles for vector fields
      • Basics: Chaining field errors
      • Basics: 3D vector field sensors
      • Basics: Tensor field sensors (strain gauges)
      • Basics: Custom tensor field sensors (strain gauges) in 2D
      • Basics: Custom tensor field sensors (strain gauges) in 3D
      • Basics: Multi-physics experiment simulation in 2D
      • Basics: Multi-physics experiment simulation in 3D
    • Blender
      • Creating a scene with 2D DIC
      • Deforming a sample with 2D DIC
      • Creating a scene with stereo DIC
      • Deforming a sample with stereo DIC
      • Rendering calibration images
    • Digital Image Correlation (DIC)
      • Selecting a Region of Interest (ROI)
      • 2D Plate with a Hole
      • Strain and Deformation Gradient Calculations
      • DIC with images generated from a virtual blender experiment
      • Comparison to the 2.0 2D DIC Challenge
    • Mooseherder
      • Creating a configuration file
      • Modifying moose input files
      • Modifying gmsh input files
      • Running MOOSE once
      • Running Gmsh once
      • Run Gmsh then MOOSE once
      • Running a parameter sweep of a MOOSE simulation
      • Running a parameter sweep of a Gmsh and MOOSE simulation
      • Using multiple calls to run parallel sweeps
      • Reading exodus output from a MOOSE simulation
      • Reading exodus output from a parameter sweep
      • Read parameter sweep results for a MOOSE simulation
      • Read parameter sweep results for a Gmsh and MOOSE simulation
      • Using read config to extract specific variables from a sweep
      • Reading results from a pre-run parameter sweep
  • Detailed Python API
    • pyvale.sensorsim
      • camera.py
      • cameradata.py
      • cameradata2d.py
      • camerasensor.py
      • camerastereo.py
      • cameratools.py
      • errorcalculator.py
      • errordriftcalc.py
      • errorintegrator.py
      • errorrand.py
      • errorsyscalib.py
      • errorsysdep.py
      • errorsysfield.py
      • errorsysindep.py
      • exceptions.py
      • experimentsimulator.py
      • field.py
      • fieldconverter.py
      • fieldinterp.py
      • fieldinterpmesh.py
      • fieldinterppoints.py
      • fieldsampler.py
      • fieldscalar.py
      • fieldtensor.py
      • fieldtransform.py
      • fieldvector.py
      • generatorsrandom.py
      • imagedef2d.py
      • imagetools.py
      • integratorfactory.py
      • integratorquadrature.py
      • integratorrectangle.py
      • integratorspatial.py
      • integratortype.py
      • output.py
      • raster.py
      • rastercy.py
      • rasternp.py
      • rasteropts.py
      • renderer.py
      • rendermesh.py
      • renderscene.py
      • sensorarray.py
      • sensorarrayfactory.py
      • sensorarraypoint.py
      • sensordata.py
      • sensordescriptor.py
      • sensortools.py
      • simtools.py
      • visualexpplotter.py
      • visualimagedef.py
      • visualimages.py
      • visualopts.py
      • visualsimanimator.py
      • visualsimplotter.py
      • visualsimsensors.py
      • visualtools.py
      • visualtraceplotter.py
    • pyvale.blender
      • blendercalibrationdata.py
      • blenderexceptions.py
      • blenderlightdata.py
      • blendermaterialdata.py
      • blenderrenderdata.py
      • blenderscene.py
      • blendertools.py
    • pyvale.dic
      • dic2d.py
      • dic2dconv.py
      • dicchecks.py
      • dicdataimport.py
      • dicregionofinterest.py
      • dicresults.py
      • dicspecklegenerator.py
      • dicspecklequality.py
      • dicstrain.py
      • dicstrainresults.py
    • pyvale.mooseherder
      • directorymanager.py
      • exodusreader.py
      • gmshrunner.py
      • inputmodifier.py
      • mooseconfig.py
      • mooseherd.py
      • mooserunner.py
      • outputreader.py
      • simdata.py
      • simrunner.py
      • sweepreader.py
      • sweeptools.py
    • pyvale.verif
      • analyticmeshgen.py
      • analyticsimdatafactory.py
      • analyticsimdatagenerator.py
      • psens.py
      • psensconst.py
      • psensmech.py
      • psensmultiphys.py
      • psensscalar.py
      • psenstensor.py
      • psensvector.py
    • pyvale.dataset
      • dataset.py
  • Detailed C++ API
    • dicbruteforce.hpp
    • dicfourier.hpp
    • dicinterpolator.hpp
    • dicmain.hpp
    • dicoptimizer.hpp
    • dicrg.hpp
    • dicscanmethod.hpp
    • dicsmooth.hpp
    • dicstrain.hpp
    • dicutil.hpp
  • Citing Pyvale
Back to top
View this page
Edit this page

Detailed Python APIΒΆ

Modules

  • pyvale.sensorsim
  • pyvale.blender
  • pyvale.dic
  • pyvale.mooseherder
  • pyvale.verif
  • pyvale.dataset
Next
pyvale.sensorsim
Previous
Reading results from a pre-run parameter sweep
Copyright © 2025, The CAV Team
Made with Sphinx and @pradyunsg's Furo