Metadata-Version: 2.4
Name: xrayvisim
Version: 0.2.1
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.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Physics
Provides: xrayvisim
Requires-Python: >=3.9
Description-Content-Type: text/x-rst
License-File: LICENSE.rst
Requires-Dist: astropy>=6.0.0
Requires-Dist: numpy>=1.24.0
Requires-Dist: packaging>=23.0
Requires-Dist: scipy>=1.13
Requires-Dist: xarray>=2023.5.0
Provides-Extra: map
Requires-Dist: sunpy[map]>=5.1.0; extra == "map"
Provides-Extra: all
Requires-Dist: xrayvisim[map]; extra == "all"
Provides-Extra: tests
Requires-Dist: matplotlib>=3.8.0; extra == "tests"
Requires-Dist: pytest-astropy>=0.11.0; extra == "tests"
Requires-Dist: pytest-mpl>=0.16; extra == "tests"
Requires-Dist: pytest-xdist>=3.0.2; extra == "tests"
Requires-Dist: pytest>=7.1.0; extra == "tests"
Provides-Extra: docs
Requires-Dist: sphinx>=6.0.0; extra == "docs"
Requires-Dist: sphinx-automodapi>=0.14.1; extra == "docs"
Requires-Dist: packaging>=23.0; extra == "docs"
Requires-Dist: sphinx-changelog>=1.5.0; extra == "docs"
Requires-Dist: sphinx-design>=0.2.0; extra == "docs"
Requires-Dist: sphinx-gallery>=0.13.0; extra == "docs"
Requires-Dist: sphinxext-opengraph>=0.6.0; extra == "docs"
Requires-Dist: xrayvisim[all]; extra == "docs"
Requires-Dist: pydata-sphinx-theme>=0.16.0; 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 `issue tracker`_.

Contributing
------------
When you are interacting with the community you are asked to
follow the `Code of Conduct`_.

.. _Code of Conduct: http://docs.sunpy.org/en/stable/coc.html
.. _example gallery: https://xrayvision.readthedocs.io/en/latest/generated/gallery/index.html
.. _issue tracker: https://github.com/TCDSolar/xrayvision/issues
