Metadata-Version: 2.4
Name: ptychodus
Version: 1.0.2
Summary: Ptychodus is a ptychography data analysis application.
License: Copyright (c) 2024, UChicago Argonne, LLC. All rights reserved.
        
        Copyright 2024. UChicago Argonne, LLC. This software was produced
        under U.S. Government contract DE-AC02-06CH11357 for Argonne National
        Laboratory (ANL), which is operated by UChicago Argonne, LLC for the
        U.S. Department of Energy. The U.S. Government has rights to use,
        reproduce, and distribute this software.  NEITHER THE GOVERNMENT NOR
        UChicago Argonne, LLC MAKES ANY WARRANTY, EXPRESS OR IMPLIED, OR
        ASSUMES ANY LIABILITY FOR THE USE OF THIS SOFTWARE.  If software is
        modified to produce derivative works, such modified software should
        be clearly marked, so as not to confuse it with the version available
        from ANL.
        
        Additionally, redistribution and use in source and binary forms, with
        or without modification, are permitted provided that the following
        conditions are met:
        
            * Redistributions of source code must retain the above copyright
              notice, this list of conditions and the following disclaimer.
        
            * Redistributions in binary form must reproduce the above copyright
              notice, this list of conditions and the following disclaimer in
              the documentation and/or other materials provided with the
              distribution.
        
            * Neither the name of UChicago Argonne, LLC, Argonne National
              Laboratory, ANL, the U.S. Government, nor the names of its
              contributors may be used to endorse or promote products derived
              from this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY UChicago Argonne, LLC AND CONTRIBUTORS
        "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
        LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
        FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL UChicago
        Argonne, LLC OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
        INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
        BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
        LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
        LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
        ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
        POSSIBILITY OF SUCH DAMAGE.
        
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: tables
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.1.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.
