Eye Patch

The pirate mask!

A python library and CLI tools for creating masks to assist deconvolution of interferometric data.

This library was originally the masking module of the Flint pipeline, but has now been separated out for flexible use.

Documentation

Full documentation is provided on ReadtheDocs.

Installation

We publish releases on PyPI:

# PyPI release
pip install eye-patch

You can also install directly from the git repository:

# Direct git install (latest push)
pip install git+https://github.com/flint-crew/eye-patch.git

Or, from a local clone:

git clone https://github.com/flint-crew/eye-patch.git
cd flint
pip install -e .

We highly recommend using uv for speedy installations. Reproducible builds can be created using uv sync:

git clone https://github.com/flint-crew/eye-patch.git
uv venv
uv sync

Contributions

Contributions are welcome! Please do submit a pull-request or issue if you spot something you would like to address.

The full set of dev tooling can be installed via:

git clone https://github.com/flint-crew/eye-patch.git
cd eye-patch
pip install '.[dev]'

Or, using uv:

git clone https://github.com/flint-crew/eye-patch.git
cd flint
uv sync --group dev