Metadata-Version: 2.4
Name: xrayvisim
Version: 0.3.0
Summary: An open-source Python library for Fourier or synthesis X-Ray imaging instruments.
Author-email: Shane Maloney <shane.maloney@dias.ie>
License-Expression: BSD-3-Clause
Project-URL: Homepage, https://xrayvision.readthedocs.io
Project-URL: Source Code, https://github.com/TCDSolar/xrayvision
Project-URL: Download, https://pypi.org/project/xrayvisim
Project-URL: Documentation, https://xrayvision.readthedocs.io/
Project-URL: Changelog, https://xrayvision.readthedocs.io/en/latest/whatsnew/changelog.html
Project-URL: Issue Tracker, https://github.com/TCDSolar/xrayvision/issues
Keywords: solar,physics,solar,sun,x-rays
Platform: any
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering :: Physics
Provides: xrayvisim
Requires-Python: >=3.12
Description-Content-Type: text/x-rst
License-File: LICENSE.rst
Requires-Dist: astropy>=7.0.0
Requires-Dist: packaging>=24.2
Requires-Dist: numpy>=2.1
Requires-Dist: scipy>=1.15
Requires-Dist: xarray>=2024.7.0
Requires-Dist: matplotlib>=3.10.0
Provides-Extra: map
Requires-Dist: sunpy[map]>=7.0.0; extra == "map"
Provides-Extra: all
Requires-Dist: xrayvisim[map]; extra == "all"
Provides-Extra: tests
Requires-Dist: pytest-astropy>=0.11.0; extra == "tests"
Requires-Dist: pytest-mpl>=0.18.0; extra == "tests"
Requires-Dist: pytest>=8.3.0; extra == "tests"
Requires-Dist: pytest-xdist>=3.7.0; extra == "tests"
Provides-Extra: docs
Requires-Dist: sphinx>=8.0.0; extra == "docs"
Requires-Dist: sphinx-automodapi>=0.18.0; extra == "docs"
Requires-Dist: packaging>=24.2; extra == "docs"
Requires-Dist: sphinx-changelog>=1.6.0; extra == "docs"
Requires-Dist: sphinx-copybutton>=0.5.0; extra == "docs"
Requires-Dist: sphinx-design>=0.7.0; extra == "docs"
Requires-Dist: sphinx-gallery>=0.17.0; extra == "docs"
Requires-Dist: sphinxext-opengraph>=0.10.0; extra == "docs"
Requires-Dist: pydata-sphinx-theme>=0.16.0; extra == "docs"
Requires-Dist: xrayvisim[all]; extra == "docs"
Provides-Extra: dev
Requires-Dist: xrayvisim[docs,tests]; extra == "dev"
Dynamic: license-file

XRAYVISION - X-RAY VIsibility Synthesis ImagiNg
===============================================

|Powered By| |Build Status| |Doc Status| |Python Versions|

.. |Powered By| image:: http://img.shields.io/badge/powered%20by-SunPy-orange.svg?style=flat
    :target: https://www.sunpy.org
    :alt: Powered by SunPy Badge

.. |Build Status| image:: https://github.com/TCDSolar/xrayvision/actions/workflows/ci.yml/badge.svg
    :target: https://github.com/TCDSolar/xrayvision/actions/workflows/ci.yaml
    :alt: Build Status

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

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

XRAYVISION is an open-source Python library for Fourier or synthesis imaging of X-Rays. The most
common usage of this technique is radio interferometry however there have been a number of solar
X-ray missions which also use this technique but obtain the visibilities via a different method.

Installation
------------

It is strongly advised that you use and isolated environment through python's venv, virturalenv, anaconda or similar.


**The name 'xrayvision' was already taken on PyPi so the package name is 'xrayvisim' e.g.**

.. code-block::

    pip install xrayvisim

Usage
-----

See the `example gallery`_.

Getting Help
------------

See the `issues page`_.

Usage of Generative AI
----------------------

We expect authentic engagement in our community.
**Do not post the output from Large Language Models or similar generative AI as code, issues or comments on GitHub or any other platform.**
If you use generative AI tools as an aid in developing code or documentation changes, ensure that you fully understand the proposed changes and can explain why they are the correct approach and an improvement to the current state.
For more information see our documentation on fair and appropriate `AI usage <https://docs.sunpy.org/en/latest/dev_guide/contents/ai_usage.html>`__.

Contributing
------------

We love contributions! xrayvisim is open source,
built on open source, and we'd love to have you hang out in our community.

If you would like to get involved, check out the `Developers Guide`_ section of the SunPy docs.
Help is always welcome so let us know what you like to work on, or check out the `issues page`_ for the list of known outstanding items.

For more information on contributing to SunPy, please read our `Newcomers' guide`_.

.. _Developers Guide: https://xrayvision.readthedocs.io/en/latest/how_to_guides/dev_guide.html
.. _issues page: https://github.com/TCDSolar/xrayvision/issues/
.. _Newcomers' guide: https://docs.sunpy.org/en/latest/dev_guide/contents/newcomers.html
.. _example gallery: https://xrayvision.readthedocs.io/en/latest/generated/gallery/index.html

When you are interacting with the SunPy community you are asked to follow our `code of conduct <https://sunpy.org/coc>`__.
