Ptydy

A PtyRAD studio. Pronounced "tidy".

Status: planning. This package is an early placeholder and has no functionality yet.

Ptydy will be a desktop program that brings the PtyRAD ecosystem together in one place, so the steps of a ptychography workflow share their settings instead of being copied between tools by hand:

1. Experiment planning: dose, probe overlap, sampling, and the expected result
2. Dataset inspection: a fast 4D-STEM viewer with fast-acbf calibration (scan rotation, defocus, diffraction center)
3. PtyRAD plan helper: build and check reconstruction settings, then submit jobs to a local or remote GPU
4. Dataset simulation: simulated datasets with known ground truth
5. Output inspector: look at reconstruction results next to their inputs

Design goals

• One shared project file that every step reads and writes, and that also works from scripts and notebooks
• Plugins for each task: install only the parts you need
• Anything the GUI does can also be done in a script: the GUI shows the settings it generates, so you learn the format as you go
• Remote reconstruction: set up on a laptop, run on a GPU node or Slurm cluster

Built with PySide6 and pyqtgraph.

Installation

pip install ptydy

This currently installs an empty placeholder.

License

LGPL-3.0. See LICENSE.