Metadata-Version: 2.4
Name: ptydy
Version: 0.0.1
Summary: Ptydy: a PtyRAD studio for planning, inspecting, and reconstructing ptychography data
Author-email: Chia-Hao Lee <cl2696@cornell.edu>
License-Expression: LGPL-3.0
Project-URL: Homepage, https://github.com/chiahao3/ptydy
Project-URL: Repository, https://github.com/chiahao3/ptydy
Project-URL: Issues, https://github.com/chiahao3/ptydy/issues
Project-URL: Changelog, https://github.com/chiahao3/ptydy/blob/main/CHANGELOG.md
Keywords: Ptychography,4D-STEM,Electron microscopy,GUI
Classifier: Development Status :: 1 - Planning
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: build; extra == "dev"
Requires-Dist: twine; extra == "dev"
Dynamic: license-file

# 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](https://github.com/chiahao3/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

```sh
pip install ptydy
```

This currently installs an empty placeholder.

## License

LGPL-3.0. See [LICENSE](LICENSE).
