Metadata-Version: 2.4
Name: photoelastimetry
Version: 0.6.0
Summary: Package for processing polarised images to measure stress in granular media
Author-email: Benjy Marks <benjy.marks@sydney.edu.au>
License-Expression: GPL-3.0-or-later
Keywords: granular material,polarimetry,photoelasticity,stress
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: matplotlib
Requires-Dist: scipy
Requires-Dist: tqdm
Requires-Dist: json5
Requires-Dist: tifffile
Requires-Dist: joblib
Requires-Dist: PyMaxflow
Provides-Extra: dev
Requires-Dist: pytest>=6.0; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: pytest-xdist; extra == "dev"
Requires-Dist: coverage[toml]; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Provides-Extra: docs
Requires-Dist: mkdocs; extra == "docs"
Requires-Dist: mkdocstrings[python]; extra == "docs"
Requires-Dist: mkdocs-material; extra == "docs"
Requires-Dist: markdown-include; extra == "docs"
Requires-Dist: mkdocs-include-markdown-plugin; extra == "docs"
Dynamic: license-file

# photoelastimetry

[![Tests](https://github.com/benjym/photoelastimetry/actions/workflows/test.yml/badge.svg)](https://github.com/benjym/photoelastimetry/actions/workflows/test.yml)
[![codecov](https://codecov.io/gh/benjym/photoelastimetry/branch/main/graph/badge.svg)](https://codecov.io/gh/benjym/photoelastimetry)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Python 3.9+](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

Package for processing polarised images to measure stress in granular media.

## Install

```bash
pip install photoelastimetry
```

## CLI Tools

- `image-to-stress`
- `stress-to-image`
- `demosaic-raw`
- `calibrate-photoelastimetry`

Run `--help` on each command for usage.

## Documentation

- Full docs: <https://benjym.github.io/photoelastimetry/>
- User docs (workflows/config): `docs/user/`
- Developer docs (setup/tests/architecture): `docs/developer/`
- API reference: `docs/reference/`

## Fastest Local Example

```bash
stress-to-image forward.json5
image-to-stress inverse.json5
```

For complete runnable examples, use `docs/user/quickstart.md` and workflow pages under `docs/user/workflows/`.

## Development

```bash
pip install -e ".[dev,docs]"
pytest
mkdocs build --strict
```

Contributor guidance is maintained in `docs/developer/`.
