-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
39 additions
and
49 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,63 +1,46 @@ | ||
XRAYVISION - X-RAY VIsibility Synthesis ImagiNg | ||
================================================ | ||
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.yaml/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 | ||
------------ | ||
|
||
Requirements: Python3.6+, SunPy0.8+ | ||
|
||
As XRAYVISION is still a work in progress it has not been release to PyPI yet. The recommended way | ||
to install XRAYVISION is via pip from git. | ||
It is strongly advised that you use and isolated environment through python's venv, virturalenv, anaconda or similar. | ||
|
||
.. code:: bash | ||
.. code-block:: | ||
pip install git+https://github.com/sunpy/xrayvision.git | ||
pip install xrayvision | ||
Usage | ||
----- | ||
|
||
.. code:: python | ||
from astropy import units as u | ||
from xrayvision.visibility import RHESSIVisibility | ||
from xrayvision import SAMPLE_RHESSI_VISIBILITIES | ||
rhessi_vis = RHESSIVisibility.from_fits_file(SAMPLE_RHESSI_VISIBILITIES) | ||
rhessi_map = rhessi_vis.to_map(shape=(65, 65), pixel_size=[4., 4.] * u.arcsec) | ||
rhessi_map.peek() | ||
Getting Help | ||
------------ | ||
|
||
|
||
|
||
Contributing | ||
~~~~~~~~~~~~ | ||
When you are interacting with the SunPy community you are asked to | ||
follow our `Code of Conduct`_. | ||
|
||
.. |Powered By| image:: http://img.shields.io/badge/powered%20by-SunPy-orange.svg?style=flat | ||
:target: http://www.sunpy.org | ||
:alt: Powered by SunPy Badge | ||
|
||
.. |Build Status| image:: https://travis-ci.org/sunpy/xrayvision.svg?branch=master | ||
:target: https://travis-ci.org/sunpy/xrayvision | ||
:alt: Travis-CI build status | ||
|
||
.. |Doc Status| image:: https://readthedocs.org/projects/xrayvision/badge/?version=latest | ||
:target: http://xrayvision.readthedocs.io/en/latest/?badge=latest | ||
:alt: Documentation Status | ||
|
||
.. |Python Versions| image:: https://img.shields.io/badge/python-3.6-blue.svg | ||
:target: https://www.python.org/downloads/release/python-360/ | ||
:alt: Python Versions | ||
------------ | ||
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters