Metadata-Version: 2.4
Name: ptychodus
Version: 1.1.2
Summary: Ptychodus is a ptychography data analysis application.
License-Expression: BSD-3-Clause
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: h5py>=3
Requires-Dist: hdf5plugin
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: psutil
Requires-Dist: pyyaml
Requires-Dist: requests
Requires-Dist: scikit-image
Requires-Dist: scipy
Requires-Dist: tifffile
Requires-Dist: watchdog
Provides-Extra: globus
Requires-Dist: gladier; extra == "globus"
Requires-Dist: gladier-tools>=0.5.4; extra == "globus"
Provides-Extra: gui
Requires-Dist: PyQt5; extra == "gui"
Provides-Extra: ptychonn
Requires-Dist: ptychonn==0.3.*,>=0.3.7; extra == "ptychonn"
Provides-Extra: tike
Requires-Dist: tike==0.25.*,>=0.25.3; extra == "tike"
Provides-Extra: ptychi
Requires-Dist: ptychi==1.*,>=1.2.0; extra == "ptychi"
Dynamic: license-file

Ptychodus
=========

`Ptychodus <https://github.com/AdvancedPhotonSource/ptychodus>`_
is a ptychography data analysis application that reads instrument data,
prepares the data for processing, and supports calling several reconstruction
libraries for phase retrieval. Ptychodus can be used interactively or
integrated into a data pipeline.


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 <https://github.com/AdvancedPhotonSource/pty-chi>`_

.. code-block:: shell

   $ pip install ptychi

- To install `PtychoNN <https://github.com/mcherukara/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.
