Metadata-Version: 2.4
Name: miss-alignment
Version: 0.1.6
Summary: She knows a good alignment when she sees one
Project-URL: homepage, https://github.com/warpem/miss-alignment
Project-URL: repository, https://github.com/warpem/miss-alignment
Author-email: Marten Chaillet <martenchaillet@gmail.com>
License: BSD-3-Clause
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Typing :: Typed
Requires-Python: >=3.10
Requires-Dist: jmespath>=1
Requires-Dist: lightning
Requires-Dist: matplotlib
Requires-Dist: mrcfile>=1.5.4
Requires-Dist: numpy>=2
Requires-Dist: scipy
Requires-Dist: standard-imghdr
Requires-Dist: tensorboard
Requires-Dist: torch-cubic-spline-grids
Requires-Dist: torch-fourier-filter
Requires-Dist: torch-fourier-rescale>=0.1
Requires-Dist: torch-fourier-shift>=0.0.4
Requires-Dist: torch-fourier-slice>=0.3.1
Requires-Dist: torch-grid-utils>=0.0.5
Requires-Dist: torch-tiltxcorr==0.1.4
Requires-Dist: torch-tomogram
Requires-Dist: torch>=2.2
Requires-Dist: tqdm>=4.67.1
Requires-Dist: typer
Requires-Dist: warpylib
Requires-Dist: zenodo-get
Provides-Extra: dev
Requires-Dist: ipython; extra == 'dev'
Requires-Dist: matplotlib; extra == 'dev'
Requires-Dist: pre-commit>=4.1.0; extra == 'dev'
Requires-Dist: ruff>=0.9.9; extra == 'dev'
Provides-Extra: test
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Description-Content-Type: text/markdown

# miss-alignment

[![License](https://img.shields.io/pypi/l/miss-alignment.svg?color=green)](https://github.com/warpem/miss-alignment/raw/main/LICENSE)
[![PyPI](https://img.shields.io/pypi/v/miss-alignment.svg?color=green)](https://pypi.org/project/miss-alignment)
[![Python Version](https://img.shields.io/pypi/pyversions/miss-alignment.svg?color=green)](https://python.org)
[![CI](https://github.com/warpem/miss-alignment/actions/workflows/ci.yml/badge.svg)](https://github.com/warpem/miss-alignment/actions/workflows/ci.yml)

## Installation

Installation is limited at the moment to a specific python, CUDA, and torch version. This might be fixed at some point in the future. For now, its easiest to set everything up in a conda environment.

First create an environment called `miss-alignment` with cuda-toolkit 12.9 and activate it:

```
conda create –n miss-alignment –c conda-forge python=3.11 cuda-toolkit=12.9 –y
conda activate miss-alignment
```

We need to fix some GPU dependencies for accelerated reconstruction:
```
python -m pip install torch==2.8.0 numpy
python -m pip install torch-projectors --index-url https://warpem.github.io/torch-projectors/cu129/simple/
```

Finally install miss-alignment with this command:

```
python -m pip install miss-alignment
```

Check that the CLI shows up with:

```
miss-alignment --help
```

## How to run?

See the docs/ folder for some barebones instructions. This will be improved soon.

## Changelog

A full list of changes per release is available on the [GitHub Releases page](https://github.com/McHaillet/miss-alignment/releases).
