Use gWCS instead of normal WCS for SJI (#30)

.github/workflows/ci.yml

@@ -29,7 +29,7 @@ jobs:
         apt:
           - ffmpeg
       envs: |
-        - linux: py310
+        - linux: py311
 
   test:
     needs: [core]
@@ -44,16 +44,13 @@ jobs:
         brew:
           - ffmpeg
       envs: |
-        - linux: py311
-        - windows: py39
-        - macos: py38
-        - linux: py38-oldestdeps
+        - windows: py310
+        - macos: py39-oldestdeps
 
   docs:
     needs: [core]
     uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@main
     with:
-      default_python: '3.8'
       submodules: false
       pytest: false
       cache-key: docs-${{ github.run_id }}
@@ -69,15 +66,14 @@ jobs:
     needs: [core]
     uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@main
     with:
-      default_python: '3.8'
       submodules: false
       coverage: codecov
       posargs: -n auto --dist loadgroup
       libraries: |
         apt:
           - ffmpeg
       envs: |
-        - linux: py39-online
+        - linux: py311-online
 
   cron:
     if: |
@@ -87,7 +83,6 @@ jobs:
       )
     uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@main
     with:
-      default_python: '3.8'
       submodules: false
       coverage: codecov
       posargs: -n auto

.pre-commit-config.yaml

@@ -1,22 +1,27 @@
 repos:
   - repo: https://github.com/myint/docformatter
-    rev: v1.5.1
+    rev: v1.7.2-rc7
     hooks:
       - id: docformatter
         args: [--in-place, --pre-summary-newline, --make-summary-multi]
   - repo: https://github.com/myint/autoflake
-    rev: v2.0.0
+    rev: v2.1.1
     hooks:
       - id: autoflake
         args: ['--in-place', '--remove-all-unused-imports', '--remove-unused-variable']
-        exclude: ".*(.fits|.fts|.fit|.txt|tca.*|extern.*|.rst|.md|__init__.py|docs/conf.py)$"
+        exclude: ".*(.fits|.fts|.fit|.txt|tca.*|extern.*|.rst|.md|docs/conf.py)$"
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: 'v0.0.270'
+    hooks:
+      - id: ruff
+        args: ['--fix']
   -   repo: https://github.com/psf/black
-      rev: 22.12.0
+      rev: 23.3.0
       hooks:
       - id: black
         exclude: ".*(.fits|.fts|.fit|.txt|.csv)$"
-  -   repo: https://github.com/timothycrosley/isort
-      rev: 5.11.4
+  -   repo: https://github.com/PyCQA/isort
+      rev: 5.12.0
       hooks:
       - id: isort
         exclude: ".*(.fits|.fts|.fit|.txt|.csv)$"
@@ -28,14 +33,14 @@ repos:
       - id: trailing-whitespace
         exclude: ".*(.fits|.fts|.fit|.txt|.csv)$"
       - id: mixed-line-ending
-        args: ['--fix=lf']
         exclude: ".*(.fits|.fts|.fit|.txt|.csv)$"
       - id: end-of-file-fixer
         exclude: ".*(.fits|.fts|.fit|.txt|.csv)$"
       - id: check-yaml
       - id: debug-statements
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.2.2
+    rev: v2.2.4
     hooks:
       - id: codespell
-        args: ['--config setup.cfg']
+        additional_dependencies:
+          - tomli

CHANGELOG.rst

@@ -1,19 +1,22 @@
-0.1.3 (2022-05-22)
+0.2.0 (2023-06-06)
 ==================
 
 Features
 --------
 
-- Added V5 and V6 support for  ``get_iris_response``.
-  It also does not download the files anymore.
+- Add support for V34 files.
 
 Breaking Changes
 ----------------
 
-- API of ``get_iris_response`` has changed:
-  ``pre_launch`` has gone, use ``response_version=2`` instead.
-  ``response_file`` keyword has been removed, it will use files provided by the package instead.
-  ``force_download`` was removed as the function now does not download any files.
+- SJI data is now stored using a gWCS.
+- All keywords have to passed by name into to all functions now.
+- Dropped Python 3.8 support.
+
+Internal Changes
+----------------
+- Templated to remove setup.py and setup.cfg
+- Tweaks to documentation.
 
 0.1.2 (2022-05-02)
 ==================

docs/conf.py

@@ -1,18 +1,25 @@
-# -- Project information -----------------------------------------------------
+"""
+Configuration file for the Sphinx documentation builder.
+"""
+import os
+import datetime
+from pathlib import Path
+
+from sphinx_gallery.sorting import ExampleTitleSortKey
+from sunpy_sphinx_theme.conf import *  # NOQA: F403
+
 from irispy import __version__
 
+# -- Project information -----------------------------------------------------
 project = "irispy-lmsal"
-copyright = "2021, LMSAL"
 author = "IRIS Instrument Team"
+copyright = f"{datetime.datetime.now().year}, {author}"  # NOQA: A001
 
 # The full version, including alpha/beta/rc tags
 release = __version__
 is_development = ".dev" in __version__
 
 # -- General configuration ---------------------------------------------------
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
 extensions = [
     "hoverxref.extension",
     "sphinx_copybutton",
@@ -34,29 +41,20 @@
 
 # Set automodapi to generate files inside the generated directory
 automodapi_toctreedirnm = "generated/api"
-
-# Add any paths that contain templates here, relative to this directory.
-# templates_path = ['_templates']
-
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
-
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 source_suffix = ".rst"
-
 # The master toctree document.
 master_doc = "index"
-
 # The reST default role (used for this markup: `text`) to use for all
 # documents. Set to the "smart" one.
 default_role = "obj"
 
 # -- Options for hoverxref -----------------------------------------------------
-import os
-
 if os.environ.get("READTHEDOCS"):
     # Building on Read the Docs
     hoverxref_api_host = "https://readthedocs.org"
@@ -98,57 +96,54 @@
 copybutton_prompt_is_regexp = True
 
 # -- 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"),
+        (None, "http://www.astropy.org/astropy-data/intersphinx/python3.inv"),
     ),
     "numpy": (
-        "https://docs.scipy.org/doc/numpy/",
-        (None, "http://data.astropy.org/intersphinx/numpy.inv"),
+        "https://numpy.org/doc/stable/",
+        (None, "http://www.astropy.org/astropy-data/intersphinx/numpy.inv"),
     ),
     "scipy": (
         "https://docs.scipy.org/doc/scipy/reference/",
-        (None, "http://data.astropy.org/intersphinx/scipy.inv"),
+        (None, "http://www.astropy.org/astropy-data/intersphinx/scipy.inv"),
     ),
-    "matplotlib": (
-        "https://matplotlib.org/",
-        (None, "http://data.astropy.org/intersphinx/matplotlib.inv"),
+    "matplotlib": ("https://matplotlib.org/stable", None),
+    "aiapy": ("https://aiapy.readthedocs.io/en/stable/", None),
+    "astropy": ("https://docs.astropy.org/en/stable/", None),
+    "astroquery": ("https://astroquery.readthedocs.io/en/latest/", None),
+    "drms": ("https://docs.sunpy.org/projects/drms/en/stable/", None),
+    "mpl_animators": ("https://docs.sunpy.org/projects/mpl-animators/en/stable/", None),
+    "pandas": ("https://pandas.pydata.org/pandas-docs/stable/", None),
+    "parfive": ("https://parfive.readthedocs.io/en/stable/", None),
+    "reproject": ("https://reproject.readthedocs.io/en/stable/", None),
+    "skimage": ("https://scikit-image.org/docs/stable/", None),
+    "sqlalchemy": ("https://docs.sqlalchemy.org/en/latest/", None),
+    "sunkit_image": ("https://docs.sunpy.org/projects/sunkit-image/en/stable/", None),
+    "sunkit_instruments": (
+        "https://docs.sunpy.org/projects/sunkit-instruments/en/stable/",
+        None,
     ),
-    "astropy": ("http://docs.astropy.org/en/stable/", None),
+    "zeep": ("https://docs.python-zeep.org/en/stable/", None),
+    "asdf": ("https://asdf.readthedocs.io/en/stable/", None),
     "sunpy": ("https://docs.sunpy.org/en/stable/", None),
 }
 
 # -- Options for HTML output -------------------------------------------------
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-try:
-    from sunpy_sphinx_theme.conf import *
-except ImportError:
-    html_theme = "default"
-
-# 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,
-# so a file named "default.css" will overwrite the builtin "default.css".
-# html_static_path = ['_static']
-
 # Render inheritance diagrams in SVG
 graphviz_output_format = "svg"
-
-from sphinx_gallery.sorting import ExampleTitleSortKey  # NOQA
-
 sphinx_gallery_conf = {
-    "backreferences_dir": os.path.join("generated", "modules"),
+    "backreferences_dir": Path("generated") / "modules",
     "filename_pattern": "^((?!skip_).)*$",
-    "examples_dirs": os.path.join("..", "examples"),
+    "examples_dirs": Path("..") / "examples",
     "within_subsection_order": ExampleTitleSortKey,
-    "gallery_dirs": os.path.join("generated", "gallery"),
-    "default_thumb_file": os.path.join(html_static_path[0], "img", "sunpy_icon_128x128.png"),
+    "gallery_dirs": Path("generated") / "gallery",
+    "default_thumb_file": Path(html_static_path[0]) / "img" / "sunpy_icon_128x128.png",  # NOQA: F405
     "abort_on_example_error": False,
     "plot_gallery": "True",
     "remove_config_comments": True,
     "doc_module": ("sunpy"),
     "only_warn_on_example_error": True,
+    "matplotlib_animations": True,
 }