Metadata-Version: 2.4
Name: ptychozoon
Version: 1.0.0
Summary: Ptychozoon: a GPU-accelerated python library for ptychography-enhanced x-ray fluorescence.
Author-email: Hanna Ruth <hruth@anl.gov>
License-Expression: MIT
Project-URL: Homepage, https://github.com/AdvancedPhotonSource/ptychozoon
Project-URL: Documentation, https://ptychozoon.readthedocs.io
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE.TXT
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: PyYAML
Requires-Dist: tqdm
Requires-Dist: cupy
Requires-Dist: chronos-profiler
Requires-Dist: matplotlib
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Provides-Extra: qt
Requires-Dist: PyQt5; extra == "qt"
Provides-Extra: docs
Requires-Dist: sphinx>=7.0; extra == "docs"
Requires-Dist: sphinx-rtd-theme>=2.0; extra == "docs"
Dynamic: license-file

# Ptychozoon

Ptychozoon: a GPU-accelerated python library for ptychography-enhanced x-ray fluorescence.

## Installation

Ptychozoon uses [CuPy](https://cupy.dev/) for GPU-accelerated computation. CuPy requires CUDA runtime libraries that are not bundled with the pip wheel, so it must be installed via conda-forge first:

```bash
conda install -c conda-forge cupy
```

Then install ptychozoon. It is recommended to install with qt dependencies, which will enable the use of GUIs for viewing the results of the analysis:

```bash
pip install ptychozoon[qt]
```

To install with no optional dependencies:

```bash
pip install ptychozoon
```

To install the package for development, clone the git repository and create an editable install:

```bash
pip install -e ".[dev,qt]"
```

## Usage

```python
import ptychozoon
```
