Metadata-Version: 2.4
Name: furry-parakeet
Version: 0.3.2
Author-email: Christopher Hirata <hirata.10@osu.edu>, Katherine Laliotis <laliotis.2@osu.edu>
License: MIT License
        
        Copyright (c) 2024 Christopher Hirata
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Source Code, https://github.com/hirata10/furry-parakeet
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Requires-Python: >=3.12
Description-Content-Type: text/x-rst
License-File: LICENSE
Provides-Extra: dev
Requires-Dist: jupyter; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Dynamic: license-file

.. image:: https://codecov.io/github/Roman-HLIS-Cosmology-PIT/furry-parakeet/graph/badge.svg?token=K33BI5YAKV

furry-parakeet: C kernels and wrappers for image combination
############################################################

This repository contains the linear algebra and interpolation kernels used by `PyIMCOM <https://github.com/Roman-HLIS-Cosmology-PIT/pyimcom>`_.

Installation
============

You should be able to pip install by going to the ``furry-parakeet`` directory and running::

    pip install .

This uses the Numpy/C API. If you want to adjust the default settings for C compilers, you can edit ``setup.py`` (for example: openmp is enabled by default).

Legacy versions
===============

Previous versions of ``furry-parakeet`` installed each file as a python module, so you would import with ``import pyimcom_croutines``. You would now write ``from furry_parakeet import pyimcom_croutines``. You can make code that would be compatible with either using::

    try:
        from furry_parakeet import pyimcom_croutines
    except ImportError:
        import pyimcom_croutines

Helpful information
===================

There are `interface instructions <docs/interface_instructions.rst>`_ if you are interested in how ``furry-parakeet`` can interface with other tools in the Roman ecosystem.

You can also look at the `readthedocs page <https://furry-parakeet.readthedocs.io/en/latest/>`_ for the Python routines, and the `C routines page <docs/croutines.rst>`_ for the C routines that are wrapped into Python.

Links
=====

Some useful links include:

* `Hirata et al. (2024) <https://arxiv.org/abs/2303.08749>`_ describes the D5512 interpolator. The tables in Appendix A are available in machine-readable form `here <docs/Tables_A2A3.txt>`_.

* `Cao et al. (2025) <https://arxiv.org/abs/2410.05442>`_ describes the various linear algebra kernels.
