Metadata-Version: 2.4
Name: spam-gui
Version: 0.1.1
Summary: Graphical modules for spam (Software for the Practical Analysis of Materials), in a napari viewer
Author-email: Cyrille Couture <cyrille.couture@univ-grenoble-alpes.fr>, Emmanuel Roubin <emmanuel.roubin@univ-grenoble-alpes.fr>
License-Expression: GPL-3.0-or-later
Project-URL: Homepage, https://spam-project.dev
Project-URL: Source, https://gitlab.com/spam-project/spam-gui
Project-URL: Documentation, https://spam-project.gitlab.io/spam-gui/markdowns/
Project-URL: Issues, https://gitlab.com/spam-project/spam-gui/-/issues
Keywords: image registration,tomography
Classifier: Environment :: X11 Applications :: Qt
Classifier: Framework :: napari
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Image Processing
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: spam>=0.9.1
Requires-Dist: napari[pyqt6]>=0.5
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pyflakes; extra == "dev"
Requires-Dist: markdown-it-py; extra == "dev"
Requires-Dist: mdit-py-plugins; extra == "dev"
Requires-Dist: build; extra == "dev"
Requires-Dist: twine; extra == "dev"
Dynamic: license-file

# spam-gui

Graphical modules for [spam](https://spam-project.dev) (Software for the Practical Analysis of Materials), in a
[napari](https://napari.org) viewer. spam-gui is part of the spam project: https://spam-project.dev

- **Multimodal registration** (`spam-gui mmr`): registers two 3D images of the same sample acquired with different
  modalities (e.g., x-rays and neutrons), step by step, with spam's registration.
- **Eye registration** (`spam-gui ereg`): as spam's `spam-ereg`, image 1 moved by hand onto image 2, and Φ saved in
  spam's registration file.

Both work on large images (several GB, larger than the memory), at several binnings, and share what is done in their
first steps (the images loaded, the eye registration).

## Install

```
pip install spam-gui
```

in a virtual environment, as spam: a few system libraries first, see
[INSTALLATION.md](https://gitlab.com/spam-project/spam-gui/-/blob/main/INSTALLATION.md).

## Start

```
spam-gui                 # the module used last
spam-gui mmr [image1 image2]
spam-gui ereg [image1 image2]
spam-gui --help
```

## Documentation

| | |
|---|---|
| [INSTALLATION.md](https://gitlab.com/spam-project/spam-gui/-/blob/main/INSTALLATION.md) | Installing, updating; old Qt 5 environments; Linux and Wayland |
| [USAGE.md](https://gitlab.com/spam-project/spam-gui/-/blob/main/USAGE.md) | Starting it, the modules and their steps, the window, large images |
| [DEVELOPMENT.md](https://gitlab.com/spam-project/spam-gui/-/blob/main/DEVELOPMENT.md) | Installing to develop, writing a module, tests, releases, the docs website |
| [SPEC.md](https://gitlab.com/spam-project/spam-gui/-/blob/main/SPEC.md) | How modules are built, how they look and behave (and the specs of each module) |

All of them, as a website: https://spam-project.gitlab.io/spam-gui/

## Licence

GPL-3.0-or-later, as spam (see [LICENSE.md](https://gitlab.com/spam-project/spam-gui/-/blob/main/LICENSE.md)).
