Ptychodus
Ptychodus is a ptychography data analysis application that extracts, loads, and transforms instrument data for processing. It integrates several reconstruction libraries for phase retrieval. Ptychodus can be used interactively or integrated into beamline data pipelines.
Standard Installation
To install ptychodus from PyPI with the most common optional dependencies:
$ python -m pip install ptychodus[globus,gui,ptychi]
Instructions for installing in containers, uv, and from conda-forge are provided in the docs directory.
Developer Installation
For a developer installation:
$ git clone https://github.com/AdvancedPhotonSource/ptychodus.git
$ cd ptychodus
$ uv sync --extra globus --extra gui --extra ptychi
The ptychi extra installs a CPU build of PyTorch. For GPU reconstruction, swap it for the extra matching your driver's CUDA ceiling — nvidia-smi reports that ceiling on its banner line:
$ uv sync --extra globus --extra gui --extra ptychi-cuda130 # or -cuda126, -cuda132
A build newer than the driver leaves torch.cuda.is_available() false and reconstruction silently falls back to the CPU; uv run ptychodus-system-check reports the driver ceiling, the PyTorch build and whether the two agree. These extras pin PyTorch to the matching index through [tool.uv.sources], which only uv reads — a pip install of the same extra takes whatever PyTorch PyPI offers.
The cdtools extra adds cdtools' FancyPtycho model as a further reconstructor. On its own it takes PyPI's default PyTorch; alongside a ptychi extra it takes that extra's build:
$ uv sync --extra globus --extra gui --extra ptychi --extra cdtools
Launch ptychodus:
$ uv run ptychodus
Reporting Bugs
Open a bug at https://github.com/AdvancedPhotonSource/ptychodus/issues.
1 maintainer
Metadata
1 maintainer
Release files for ptychodus 1.8.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| ptychodus-1.8.0.tar.gz | 1.6 MB | Without provenance | Details for ptychodus-1.8.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| ptychodus-1.8.0-py3-none-any.whl | Python 3 | none | any | Details for ptychodus-1.8.0-py3-none-any.whl |
Total release size: 2.7 MB
Release files / ptychodus-1.8.0.tar.gz
| Download URL | ptychodus-1.8.0.tar.gz |
|---|---|
| Size | 1.6 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
42f2e490f58bacbe2fa4aed0f9ad5c1cce22eccade779fb6ecf9a6fc77be0db5
|
|
BLAKE2b-256 checksum How to use checksums |
390ce2196e8218e4ffac170fadead25e2cf0c6a6377bfe29a11f551541f47dc8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.11.2 {"installer":{"name":"uv","version":"0.11.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Red Hat Enterprise Linux","version":"9.8","id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Release files / ptychodus-1.8.0-py3-none-any.whl
| Download URL | ptychodus-1.8.0-py3-none-any.whl |
|---|---|
| Size | 1.2 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
51fa3f42056f4985eb7ee96706c3442d6706937ee4450c5abb7f11a7d236bc75
|
|
BLAKE2b-256 checksum How to use checksums |
827c9f7596aa28312a3706007e2be7ee7ac3ad99c4dfef375a59f81cd3e1a14a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.11.2 {"installer":{"name":"uv","version":"0.11.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Red Hat Enterprise Linux","version":"9.8","id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Security for ptychodus 1.8.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
