From 027a332a093fb04ab73fc79217d013f28d61a6d2 Mon Sep 17 00:00:00 2001 From: Shane Maloney Date: Wed, 17 Apr 2024 12:27:27 +0100 Subject: [PATCH] Update readme and tweak docs config --- .gitignore | 6 +++++ README.rst | 65 +++++++++++++++++++--------------------------------- docs/conf.py | 17 +++++++------- 3 files changed, 39 insertions(+), 49 deletions(-) diff --git a/.gitignore b/.gitignore index 54d6088..65f1c03 100644 --- a/.gitignore +++ b/.gitignore @@ -149,3 +149,9 @@ docs/api docs/whatsnew/latest_changelog.txt xrayvision/version.py htmlcov/ +sg_execution_times.rst + +.DS_Store + +# IDE +.idea diff --git a/README.rst b/README.rst index 17ed74a..cd1e5ee 100644 --- a/README.rst +++ b/README.rst @@ -1,8 +1,24 @@ -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. @@ -10,54 +26,21 @@ X-ray missions which also use this technique but obtain the visibilities via a d 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 diff --git a/docs/conf.py b/docs/conf.py index ad6bda4..0b5aa55 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -70,14 +70,10 @@ # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = { - 'python': ('https://docs.python.org/3/', - (None, 'http://data.astropy.org/intersphinx/python3.inv')), - 'numpy': ('https://docs.scipy.org/doc/numpy/', - (None, 'http://data.astropy.org/intersphinx/numpy.inv')), - 'scipy': ('https://docs.scipy.org/doc/scipy/reference/', - (None, 'http://data.astropy.org/intersphinx/scipy.inv')), - 'matplotlib': ('https://matplotlib.org/', - (None, 'http://data.astropy.org/intersphinx/matplotlib.inv')), + 'python': ('https://docs.python.org/3/', (None, 'http://data.astropy.org/intersphinx/python3.inv')), + 'numpy': ('https://docs.scipy.org/doc/numpy/', (None, 'http://data.astropy.org/intersphinx/numpy.inv')), + 'scipy': ('https://docs.scipy.org/doc/scipy/reference/', (None, 'http://data.astropy.org/intersphinx/scipy.inv')), + 'matplotlib': ('https://matplotlib.org/', (None, 'http://data.astropy.org/intersphinx/matplotlib.inv')), 'astropy': ('http://docs.astropy.org/en/stable/', None), 'sunpy': ('https://docs.sunpy.org/en/stable/', None)} @@ -88,6 +84,11 @@ html_theme = 'pydata_sphinx_theme' +html_theme_options = { + "logo": { + "text": "xrayision" + }, +} # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files,