Update readme and tweak docs config

.gitignore

@@ -149,3 +149,9 @@ docs/api
 docs/whatsnew/latest_changelog.txt
 xrayvision/version.py
 htmlcov/
+sg_execution_times.rst
+
+.DS_Store
+
+# IDE
+.idea

.pre-commit-config.yaml

@@ -9,7 +9,7 @@ repos:
     rev: 5.13.2
     hooks:
       - id: isort
-        exclude: ".*(.fits|.fts|.fit|.header|.txt|tca.*|extern.*|)$"
+        exclude: ".*(.fits|.fts|.fit|.header|.txt|tca.*|extern.*)$"
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.5.0
     hooks:

.readthedocs.yml

@@ -1,23 +1,30 @@
 # .readthedocs.yml
 # Read the Docs configuration file
 # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
 version: 2
 
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.10"
+    python: "3.9"
   apt_packages:
     - graphviz
 
+# Build documentation in the docs/ directory with Sphinx
 sphinx:
   builder: html
   configuration: docs/conf.py
   fail_on_warning: true
 
+# Optionally, build your docs in additional formats such as PDF and ePub
+formats: []
+
 python:
    install:
      - method: pip
        path: .
        extra_requirements:
-        - docs,map
+        - docs
+        - map

README.rst

@@ -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

changelog/53.doc.rst

@@ -0,0 +1 @@
+Update README fix badges and remove old example.

changelog/53.trivial.rst

@@ -0,0 +1 @@
+Fix small bug in isort configuration.

docs/conf.py

@@ -66,18 +66,17 @@
 # Disable google style docstrings
 napoleon_google_docstring = False
 
+# until sphinx-gallery / sphinx is fixed https://github.com/sphinx-doc/sphinx/issues/12300
+suppress_warnings = ["config.cache"]
+
 # -- Options for intersphinx extension ---------------------------------------
 
 # 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 +87,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,

examples/rhessi.py

@@ -5,10 +5,9 @@
 
 Create images from RHESSI visibility data
 """
+import astropy.units as apu
 import matplotlib.pyplot as plt
 import numpy as np
-
-import astropy.units as apu
 from astropy.io import fits
 
 from xrayvision.clean import vis_clean

examples/stix.py

@@ -9,9 +9,8 @@
 import pickle
 import urllib.request
 
-import matplotlib.pyplot as plt
-
 import astropy.units as apu
+import matplotlib.pyplot as plt
 
 from xrayvision.clean import vis_clean
 from xrayvision.imaging import vis_psf_map, vis_to_map

pyproject.toml

@@ -19,7 +19,7 @@ build-backend = 'setuptools.build_meta'
     changelog_skip_label = "No Changelog Entry Needed"
     help_url = "https://github.com/TCDSolar/xrayvision/blob/main/changelog/README.rst"
 
-    changelog_missing_long = "There isn't a changelog file in this pull request. Please add a changelog file to the `changelog/` directory following the instructions in the changelog [README](https://https://github.com/TCDSolar/xrayvision/blob/main/changelog/README.rst)."
+    changelog_missing_long = "There isn't a changelog file in this pull request. Please add a changelog file to the `changelog/` directory following the instructions in the changelog [README](https://github.com/TCDSolar/xrayvision/blob/main/changelog/README.rst)."
 
     type_incorrect_long = "The changelog file you added is not one of the allowed types. Please use one of the types described in the changelog [README](https://github.com/TCDSolar/xrayvision/blob/main/changelog/README.rst)"
 

setup.cfg

@@ -68,7 +68,7 @@ filterwarnings =
 
 [isort]
 balanced_wrapping = true
-skip =
+extend_skip =
     docs/conf.py,
     xrayvision/__init__.py,
 default_section = THIRDPARTY