Metadata-Version: 2.4
Name: shimexpy
Version: 0.1.0
Summary: Spatial Harmonic Imaging and mesh-based X-ray multicontrast imaging in Python
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: core
Requires-Dist: shimexpy-core>=0.1.0; extra == "core"
Provides-Extra: gui
Requires-Dist: shimexpy_gui>=0.1.0; extra == "gui"
Provides-Extra: cli
Requires-Dist: shimexpy_cli>=0.1.0; extra == "cli"
Provides-Extra: all
Requires-Dist: shimexpy-core>=0.1.0; extra == "all"
Requires-Dist: shimexpy_gui>=0.1.0; extra == "all"
Requires-Dist: shimexpy_cli>=0.1.0; extra == "all"
Dynamic: license-file

# Shimexpy

Shimexpy is a Python package for **Spatial Harmonic Imaging (SHI)** and **mesh-based X-ray multicontrast imaging**. It provides tools for Fourier-domain harmonic analysis and the reconstruction of absorption, dark-field (scattering), and differential phase contrast from X-ray images.

---

## Installation

```bash
pip install shimexpy[all]
```

Individual components:

```bash
pip install shimexpy[core]
pip install shimexpy[gui]
pip install shimexpy[cli]
```

GPU support (optional):

```bash
pip install shimexpy-core[cuda12x]
pip install shimexpy-core[cuda11x]
```

---

## Usage

```python
import shimexpy
```

```bash
shimexpy
```

```bash
shi
```

---

## License

Apache License 2.0
