Skip to main content

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-cuda128   # or -cuda130, -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.

Launch ptychodus:

$ uv run ptychodus

Reporting Bugs

Open a bug at https://github.com/AdvancedPhotonSource/ptychodus/issues.

Metadata

Release files for ptychodus 1.7.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ptychodus 1.7.0
File Size Uploaded Provenance Actions
ptychodus-1.7.0.tar.gz 1.2 MB Without provenance Details for ptychodus-1.7.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ptychodus 1.7.0
File Interpreter ABI Platform Actions
ptychodus-1.7.0-py3-none-any.whl Python 3 none any Details for ptychodus-1.7.0-py3-none-any.whl

Total release size: 2.2 MB

Release files / ptychodus-1.7.0.tar.gz

Download URL ptychodus-1.7.0.tar.gz
Size 1.2 MB
Tags Source
SHA-256 checksum
How to use checksums
c9a0433fcc5c506cc58ff8d3c0d3291064085f9760f442f0a373953e8797c39f
BLAKE2b-256 checksum
How to use checksums
ca74a47337f8daf0ecf49007c1923485a09d813b2925ef902192575868e2b2fe
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.7.0-py3-none-any.whl

Download URL ptychodus-1.7.0-py3-none-any.whl
Size 998.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
190ff4f26693b9d9b10eff7abd60098fe22333ed0e3f547464842d846341ef35
BLAKE2b-256 checksum
How to use checksums
325bc85c08b96157c302e6197963cbab7118dc2f9d89e6e771421f73bcf9dd3e
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.7.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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page