Metadata-Version: 2.4
Name: uvcombine
Version: 1.0.0
Summary: Combination of high- and low-resolution radio astronomical data.
Author: Adam Ginsburg
Author-email: Eric Koch <koch.eric.w@gmail.com>
License-Expression: BSD-3-Clause
Project-URL: homepage, https://uvcombine.readthedocs.org
Project-URL: documentation, https://uvcombine.readthedocs.org
Project-URL: repository, https://github.com/radio-astro-tools/uvcombine
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE.rst
Requires-Dist: astropy>=6.1
Requires-Dist: numpy>=1.8
Requires-Dist: scipy
Requires-Dist: packaging>=19
Requires-Dist: setuptools>=62.3.3
Requires-Dist: matplotlib>=3.5
Requires-Dist: reproject>=0.13
Requires-Dist: spectral-cube>=0.4.0
Requires-Dist: radio-beam>=0.3.5
Requires-Dist: tqdm
Provides-Extra: docs
Requires-Dist: sphinx-astropy; extra == "docs"
Provides-Extra: test
Requires-Dist: pytest>=5; extra == "test"
Requires-Dist: pytest-astropy>=0.10; extra == "test"
Requires-Dist: pytest-cov>=3; extra == "test"
Requires-Dist: scikit-image>=0.24; extra == "test"
Provides-Extra: dev
Requires-Dist: numpy>=0.0.dev0; extra == "dev"
Requires-Dist: astropy>=0.0.dev0; extra == "dev"
Requires-Dist: spectral-cube>=0.0.dev0; extra == "dev"
Requires-Dist: radio-beam>=0.0.dev0; extra == "dev"
Provides-Extra: notebooks
Requires-Dist: pre-commit; extra == "notebooks"
Requires-Dist: nbstripout; extra == "notebooks"
Provides-Extra: stats
Requires-Dist: statsmodels; extra == "stats"
Provides-Extra: all
Requires-Dist: uvcombine[docs,stats,test]; extra == "all"
Dynamic: license-file

uvcombine
=========

uvcombine provides tools for combining high-resolution images with missing large angular scales (Fourier-domain short-spacings)
with low-resolution images containing the short/zero spacing, including:

* Feathering two images
* Feathering two cubes (including for large cubes using spectral-cube's dask implementation)
* uv-overlap consistency tests and measuring the single dish flux scaling factor.

See the `documentation <https://uvcombine.readthedocs.io/en/latest/>`_ for more information.
Worked notebook examples of the uvcombine functionality can be found in the `examples <https://github.com/radio-astro-tools/uvcombine/tree/main/examples>`_ directory.

Install the latest release from PyPI with::

    pip install uvcombine

Development
^^^^^^^^^^^

Example notebooks under ``examples/`` are kept free of cell outputs on ``main`` so
diffs stay reviewable. This is enforced by a ``pre-commit`` hook (`nbstripout
<https://github.com/kynan/nbstripout>`_) plus a CI check that fails if a notebook
with outputs is pushed. To set up the hook locally::

    pip install -e ".[notebooks]"
    pre-commit install

Notebooks with their outputs executed are kept on the ``with-output`` branch
instead; it is refreshed manually (not by CI) whenever an example notebook changes.

radio-astro-tools
^^^^^^^^^^^^^^^^^

This package is part of the radio-astro-tools project. See
`radio-astro-tools <https://radio-astro-tools.github.io/>`_ for more information.

