moirestrain documentation
=========================

:Version: 0.1.1

``moirestrain`` is a NumPy-first package for sampling moire analysis of periodic
grating images. It targets full-field micro-displacement and micro-strain
measurement from reference and deformed images.

The package focuses on the grid/phase-based metrology workflow: generating
phase-shifted moire images, estimating wrapped phase, unwrapping phase,
calculating displacement fields, and deriving strain fields.

.. toctree::
   :maxdepth: 2
   :caption: Content

   project
   installation
   tutorials
   tutorial
   theory
   citation
   api