PtyLab.py: Unified Ptychography Toolbox

Python 3.10+ Tests

Getting Started | Installation | Development | Documentation

PtyLab is an inverse modeling toolbox for Conventional (CP) and Fourier (FP) ptychography in a unified framework. For more information please check the paper.

Key Features

Classic engines: ePIE, mPIE, mqNewton, qNewton
Advanced corrections: position correction (pcPIE), defocus correction (zPIE), angle correction (aPIE), orthogonal probe relaxation (OPR)
Multi-modal: multi-slice, multi-wavelength, mixed-state object and probe
Multiple propagators: Fraunhofer, Fresnel, Angular Spectrum (ASP), scaled ASP, polychromatic variants
GPU acceleration: same code runs on CPU and GPU

The reconstructed output is a 6D array of shape (nlambda, nosm, npsm, nslice, No, No):

Dim	Meaning
`nlambda`	wavelengths
`nosm`	object state mixture
`npsm`	probe state mixture
`nslice`	depth slices
`No`	output frame size

Getting started

Try the demo in Google Colab:

demo

For more use cases, start with the tutorials in our documentation, then see the example_scripts directory.

Installation

Install from PyPI within your virtual environment:

pip install ptylab

For much faster installs, we recommend uv: uv pip install ptylab

This package uses cupy to utilize GPU for faster reconstruction. To enable GPU support:

pip install "ptylab[gpu]"

You can check if GPU is detected with ptylab check gpu.

For the latest unreleased changes on main:

pip install git+https://github.com/PtyLab/PtyLab.py.git

Development

Clone the repo and install dev and gpu dependencies with uv:

git clone git@github.com:PtyLab/PtyLab.py.git
cd PtyLab.py
uv sync --extra dev,gpu # remove the GPU flag if you are on CPU

This creates a .venv virtual environment in the project root. Select this environment from your IDE.

Add tests for new implementations and run the suite:

uv run pytest tests

Citation

If you use this package, please cite:

@article{Loetgering:23,
        author = {Lars Loetgering and Mengqi Du and Dirk Boonzajer Flaes and Tomas Aidukas and Felix Wechsler and Daniel S. Penagos Molina and Max Rose and Antonios Pelekanidis and Wilhelm Eschen and J\"{u}rgen Hess and Thomas Wilhein and Rainer Heintzmann and Jan Rothhardt and Stefan Witte},
        journal = {Opt. Express},
        number = {9},
        pages = {13763--13797},
        publisher = {Optica Publishing Group},
        title = {PtyLab.m/py/jl: a cross-platform, open-source inverse modeling toolbox for conventional and Fourier ptychography},
        volume = {31},
        month = {Apr},
        year = {2023},
        doi = {10.1364/OE.485370},
}

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ptylab-0.3.1.tar.gz (96.7 kB view details)

Uploaded Aug 17, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

ptylab-0.3.1-py3-none-any.whl (126.4 kB view details)

Uploaded Aug 17, 2026 Python 3

File details

Details for the file ptylab-0.3.1.tar.gz.

File metadata

Download URL: ptylab-0.3.1.tar.gz
Upload date: Aug 17, 2026
Size: 96.7 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for ptylab-0.3.1.tar.gz
Algorithm	Hash digest
SHA256	`9b8ef7511a076fc2c5c0fc71e9a3fb61fd328b3de324ab22ed5684c09e2384a2`
MD5	`4d71ef31d22fc2056bed6021abd08071`
BLAKE2b-256	`005a554e76d29405c7ba1ce31e0fe019f6542dffa7870d5d59511ac8c38be280`

See more details on using hashes here.

Provenance

The following attestation bundles were made for ptylab-0.3.1.tar.gz:

Publisher: publish.yml on PtyLab/PtyLab.py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: ptylab-0.3.1.tar.gz
- Subject digest: 9b8ef7511a076fc2c5c0fc71e9a3fb61fd328b3de324ab22ed5684c09e2384a2
- Sigstore transparency entry: 2498636448
- Sigstore integration time: Aug 17, 2026
Source repository:
- Permalink: PtyLab/PtyLab.py@2e429eda52be7d894b3b79d5b2fb8f5234b825ea
- Branch / Tag: refs/heads/main
- Owner: https://github.com/PtyLab
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: publish.yml@2e429eda52be7d894b3b79d5b2fb8f5234b825ea
- Trigger Event: push