Metadata-Version: 2.4
Name: aimfast
Version: 1.4.0
Summary: An Astronomical Image Fidelity Assessment Tool.
Project-URL: Homepage, https://github.com/Athanaseus/aimfast
Project-URL: Repository, https://github.com/Athanaseus/aimfast.git
Author-email: Athanaseus Ramaila <ramaila.jat@gmail.com>
License: GNU GPL v3
License-File: LICENSE
Keywords: catalogs,dataset,fits,html,lsm,models,statistics
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
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: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Software Development :: Libraries
Requires-Python: <3.14,>=3.10
Requires-Dist: astlib
Requires-Dist: astro-tigger
Requires-Dist: astropy
Requires-Dist: astroquery
Requires-Dist: bokeh
Requires-Dist: jsonschema
Requires-Dist: mock
Requires-Dist: numpy<2.3
Requires-Dist: numpydoc
Requires-Dist: pyyaml
Requires-Dist: regions
Requires-Dist: scikit-learn
Requires-Dist: scipy
Provides-Extra: aegean
Requires-Dist: aegeantools; extra == 'aegean'
Provides-Extra: all
Requires-Dist: aegeantools; extra == 'all'
Requires-Dist: bdsf; extra == 'all'
Requires-Dist: breizorro[all]; extra == 'all'
Requires-Dist: matplotlib; extra == 'all'
Requires-Dist: selenium; extra == 'all'
Provides-Extra: breizorro
Requires-Dist: breizorro[all]; extra == 'breizorro'
Provides-Extra: pybdsf
Requires-Dist: bdsf; extra == 'pybdsf'
Provides-Extra: source-finders
Requires-Dist: aegeantools; extra == 'source-finders'
Requires-Dist: bdsf; extra == 'source-finders'
Requires-Dist: breizorro[all]; extra == 'source-finders'
Provides-Extra: svg-images
Requires-Dist: matplotlib; extra == 'svg-images'
Requires-Dist: selenium; extra == 'svg-images'
Description-Content-Type: text/x-rst

=======
aimfast
=======

|Build Version|
|Doc Status|
|Pypi Version|
|Python Versions|
|Project License|

An Astronomical Image Fidelity Assessment Tool

Main website: aimfast.rtfd.io_

==============
Introduction
==============

Image fidelity is a measure of the accuracy of the reconstructed sky brightness distribution. A related metric, dynamic range, is a measure of the degree to which imaging artifacts around strong sources are suppressed, which in turn implies a higher fidelity of the on-source reconstruction. Moreover, the choice of image reconstruction algorithm also affects the correctness of the on-source brightness distribution.

==============
Installation
==============
Installation from source_,
working directory where source is checked out

.. code-block:: bash
  
    $ pip install .

This package is available on *PYPI*, allowing

.. code-block:: bash
  
    $ pip install aimfast

=======
License
=======

This project is licensed under the GNU General Public License v3.0 - see license_ for details.

=============
Contribute
=============

Contributions are always welcome! Please ensure that you adhere to our coding
standards pep8_.

.. |Doc Status| image:: https://readthedocs.org/projects/aimfast/badge/?version=latest
                :target: http://aimfast.readthedocs.io/en/latest
                :alt:

.. |Pypi Version| image:: https://img.shields.io/pypi/v/aimfast.svg
                  :target: https://pypi.python.org/pypi/aimfast
                  :alt:
.. |Build Version| image:: https://github.com/Athanaseus/aimfast/actions/workflows/test_installation.yml/badge.svg
                  :target: https://github.com/Athanaseus/aimfast/actions/workflows/test_installation.yml/
                  :alt:

.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/aimfast.svg
                     :target: https://pypi.python.org/pypi/aimfast/
                     :alt:

.. |Project License| image:: https://img.shields.io/badge/license-GPL-blue.svg
                     :target: https://github.com/Athanaseus/aimfast/blob/master/LICENSE
                     :alt:

.. _aimfast.rtfd.io: https://aimfast.rtfd.io
.. _source: https://github.com/Athanaseus/aimfast
.. _license: https://github.com/Athanaseus/aimfast/blob/master/LICENSE
.. _pep8: https://www.python.org/dev/peps/pep-0008