Getting started¶

Installation¶

You can install the package as follows:

latest version

Using pip

(.venv) $ pip install git+https://github.com/mipt-srf/grain-processor

or uv

$ uv add git+https://github.com/mipt-srf/grain-processor

latest PyPI release

Using pip

(.venv) $ pip install grain-processor

or uv

$ uv add grain-processor

You can start with this snippet of code

from grain_processor import GrainProcessor as GP
gp = GP(
    r"path\to\image.tif",
    cut_SEM=True,
    fft_filter=True,
)
gp.save_results()