https://github.com/advancedphotonsource/ptychodus

Ptychodus is a ptychography data analysis application.
https://github.com/advancedphotonsource/ptychodus

ptychography

Last synced: 4 months ago
JSON representation

Ptychodus is a ptychography data analysis application.

• Host: GitHub
• URL: https://github.com/advancedphotonsource/ptychodus
• Owner: AdvancedPhotonSource
• License: other
• Created: 2022-02-16T22:51:48.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2025-10-21T16:17:57.000Z (8 months ago)
• Last Synced: 2025-10-21T19:59:36.385Z (8 months ago)
• Topics: ptychography
• Language: Python
• Homepage:
• Size: 880 MB
• Stars: 12
• Watchers: 8
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
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:

.. code-block:: shell

    $ python -m pip install ptychodus[globus,gui,ptychi]

Instructions for installing in containers and from conda-forge are provided in

the ``docs`` directory.

Developer Installation

----------------------

- For a developer installation:

.. code-block:: shell

   $ git clone https://github.com/AdvancedPhotonSource/ptychodus.git

   $ conda create -n ptychodus --file ptychodus/requirements-dev.txt

   $ conda activate ptychodus

   $ pip install -e ./ptychodus

- To install `pty-chi `_

.. code-block:: shell

   $ pip install ptychi

- To install `PtychoNN `_

.. code-block:: shell

   $ conda install -n ptychodus ptychonn

- Launch `ptychodus`:

.. code-block:: shell

   $ conda activate ptychodus

   $ ptychodus

Reporting Bugs

--------------

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