Metadata-Version: 2.4
Name: apic-tools
Version: 0.1.0
Summary: A Python package for APIC functionality
Author-email: bancalari404 <j.bancalari@student.tugraz.at>
Maintainer-email: bancalari404 <j.bancalari@student.tugraz.at>
License-Expression: MIT
Project-URL: Homepage, https://github.com/bancalari404/pyAPIC
Project-URL: Repository, https://github.com/bancalari404/pyAPIC
Project-URL: Documentation, https://pyapic.readthedocs.io/
Project-URL: Bug Tracker, https://github.com/bancalari404/pyAPIC/issues
Keywords: python,apic
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.22
Requires-Dist: scipy>=1.8
Requires-Dist: h5py>=3
Requires-Dist: matplotlib>=3.5
Requires-Dist: scikit-image>=0.19
Requires-Dist: zernike>=0.0.33
Provides-Extra: dev
Requires-Dist: pytest>=6.0; extra == "dev"
Requires-Dist: pytest-cov>=2.0; extra == "dev"
Requires-Dist: black>=21.0; extra == "dev"
Requires-Dist: isort>=5.0; extra == "dev"
Requires-Dist: flake8>=3.8; extra == "dev"
Requires-Dist: mypy>=0.900; extra == "dev"
Provides-Extra: test
Requires-Dist: pytest>=6.0; extra == "test"
Requires-Dist: pytest-cov>=2.0; extra == "test"
Provides-Extra: docs
Requires-Dist: sphinx>=4.0; extra == "docs"
Requires-Dist: sphinx-rtd-theme>=1.0; extra == "docs"
Dynamic: license-file

# pyAPIC
[![PyPI](https://img.shields.io/pypi/v/pyAPIC.svg)](https://pypi.org/project/pyAPIC/)
[![Documentation](https://readthedocs.org/projects/pyapic/badge/?version=latest)](https://pyapic.readthedocs.io/)

## Terminology

Recent versions adopt clearer naming for acquisition parameters:

| New name   | Old name      | Description                            |
|------------|---------------|----------------------------------------|
| `illum_px` | `freqXY_calib`| LED positions in pixel coordinates     |
| `illum_na` | `na_calib`    | LED positions expressed in NA units    |
| `system_na`| `na_cal`      | System numerical aperture              |
| `system_na_px` | `na_rp_cal` | System NA in pixel units               |
| `pixel_size` | `dpix_c`    | Camera pixel size                      |

The old attribute names remain available as aliases for backward
compatibility but new code should prefer the terms above.

## Development setup

Install runtime dependencies:

```bash
pip install -r requirements.txt
```

Then install the package with its development extras:

```bash
pip install -e .[dev]
```

This provides tooling for testing and linting the project.

## Public API

The following convenience imports are available from the top-level package:

```python
from pyAPIC import (
    Case,
    ImagingData,
    ReconParams,
    load_mat,
    to_pixel_coords,
)

```

They mirror the underlying modules located in ``pyAPIC.core`` and
``pyAPIC.io`` and may be used in examples and user code.
