Getting Started

Installation

To install the package, run the following command in the terminal:

pip install photoelastimetry

Quick Start

After installation, three command line scripts are available for different photoelasticity workflows:

image-to-stress

Convert photoelastic images to stress maps:

image-to-stress params.json5 --output stress_map.png

stress-to-image

Generate photoelastic fringe patterns from stress fields:

stress-to-image params.json5

demosaic-raw

Process raw polarimetric images from specialized cameras:

demosaic-raw image.raw --width 2448 --height 2048 --format tiff

Configuration

All tools use JSON5 parameter files for configuration. See the User Guide for detailed parameter descriptions.

Next Steps

• Read the User Guide for detailed usage instructions
• Check the Examples for practical demonstrations
• Browse the API Reference for module documentation