Merge branch 'main' of github.com:HinodeXRT/xrtpy into idl-instructions

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,50 @@
+name: 🐛 Bug Report
+description: Report a problem that you encountered when using XRTpy
+labels: [Bug]
+body:
+
+- type: markdown
+  attributes:
+    value: >
+      Thank you for submitting a bug report — we really appreciate it!
+
+- type: textarea
+  id: description
+  attributes:
+    label: Bug description
+    description: >
+      Please describe what you were doing and what went wrong.
+  validations:
+    required: true
+
+- type: textarea
+  id: expected-outcome
+  attributes:
+    label: Expected outcome
+    description: >
+      What did you expect to happen instead? (optional)
+  validations:
+    required: false
+
+- type: textarea
+  id: minimal-example
+  attributes:
+    label: Minimal complete verifiable example
+    description: >
+      Provide a minimal self-contained example to help us reproduce the
+      bug, along with any relevant output. This will be automatically
+      formatted into code, so no need for Markdown backticks. (optional,
+      but incredibly helpful!)
+    render: Python
+  validations:
+    required: false
+
+- type: textarea
+  id: context
+  attributes:
+    label: Additional context
+    description: >
+      Please provide any additional context that would help us
+      understand and fix the bug. (optional)
+  validations:
+    required: false

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,39 @@
+name: 💡 Feature Request
+description: |
+  Help shape the future of XRTpy by requesting a new feature
+labels: [Feature request]
+body:
+- type: textarea
+  id: description
+  attributes:
+    label: Feature description
+    description: >
+      What new capability would you like added to XRTpy?
+  validations:
+    required: true
+
+- type: textarea
+  id: motivation
+  attributes:
+    label: Motivation
+    description: >
+      What are the benefits from adding this feature? What problems or
+      limitations would be solved? (optional)
+
+- type: textarea
+  id: solution
+  attributes:
+    label: Implementation strategy
+    description: >
+      How might we go about implementing this new capability? (optional)
+  validations:
+    required: false
+
+- type: textarea
+  id: additional-context
+  attributes:
+    label: Additional context
+    description: >
+      Please provide any additional helpful details here. (optional)
+  validations:
+    required: false

.github/ISSUE_TEMPLATE/general_issue.yml

@@ -0,0 +1,11 @@
+name: 📝 General Issue
+description: Create an issue that doesn't fit in the other categories
+body:
+- type: textarea
+  id: description
+  attributes:
+    label: Description
+    description: >
+      Please describe the issue here.
+  validations:
+    required: true

.github/workflows/testing.yml

@@ -54,6 +54,40 @@ jobs:
     - name: ${{ matrix.name }}
       run: nox -s ${{ matrix.noxenv }} -- ${{ matrix.noxposargs }}
 
+  documentation:
+    name: ${{ matrix.name }}
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+
+      matrix:
+        include:
+
+        - name: Documentation
+          python: '3.10'
+
+    steps:
+
+    - name: Checkout code
+      uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.10'
+
+    - name: Install nox
+      run: python -m pip install --progress-bar off --upgrade nox
+
+    - name: Install graphviz and pandoc
+      run: sudo apt install graphviz pandoc
+
+    - name: Build documentation
+      run: nox -e build_docs_nitpicky -- -q
+
   comprehensive-tests:
     name: ${{ matrix.name }}
     runs-on: ${{ matrix.os }}
@@ -69,13 +103,8 @@ jobs:
           noxenv: tests-3.10
           python: '3.10'
 
-        - name: Python 3.8 (Windows)
+        - name: Python 3.9 (Windows)
           os: windows-latest
-          python: 3.8
-          noxenv: tests-3.8
-
-        - name: Python 3.9 (Ubuntu)
-          os: ubuntu-latest
           python: 3.9
           noxenv: tests-3.9
 

.gitignore

@@ -141,3 +141,6 @@ version.py
 #ignore mac files
 .DS_store
 .DS_Store
+
+# local directory
+idl_routines/

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 ci:
   autofix_prs: false
-  autoupdate_schedule: quarterly
+  autoupdate_schedule: monthly
 
 repos:
 
@@ -21,12 +21,18 @@ repos:
   - id: check-yaml
 
 - repo: https://github.com/tox-dev/pyproject-fmt
-  rev: 0.4.1
+  rev: 1.1.0
   hooks:
   - id: pyproject-fmt
 
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.0.287
+  hooks:
+  - id: ruff
+    args: [--fix]
+
 - repo: https://github.com/PyCQA/isort
-  rev: 5.11.4
+  rev: 5.12.0
   hooks:
   - id: isort
     name: isort
@@ -37,60 +43,55 @@ repos:
     - python
 
 - repo: https://github.com/psf/black
-  rev: 22.12.0
+  rev: 23.7.0
   hooks:
   - id: black
 
 - repo: https://github.com/nbQA-dev/nbQA
-  rev: 1.6.0
+  rev: 1.7.0
   hooks:
   - id: nbqa-black
     additional_dependencies:
-    - black==22.3.0
+    - black==23.3.0
     args:
     - --nbqa-mutate
   - id: nbqa-isort
     additional_dependencies:
-    - isort==5.10.1
+    - isort==5.12.0
     args:
     - --nbqa-mutate
 
 - repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
-  rev: v2.5.0
+  rev: v2.10.0
   hooks:
   - id: pretty-format-ini
     args: [--autofix]
   - id: pretty-format-yaml
     args: [--autofix]
 
-- repo: https://github.com/pre-commit/mirrors-csslint
-  rev: v1.0.5
-  hooks:
-  - id: csslint
-
 - repo: https://github.com/MarcoGorelli/absolufy-imports
   rev: v0.3.1
   hooks:
   - id: absolufy-imports
     exclude: docs/plasmapy_sphinx
 
 - repo: https://github.com/codespell-project/codespell
-  rev: v2.2.2
+  rev: v2.2.5
   hooks:
   - id: codespell
     exclude: .*\.fits
     additional_dependencies:
     - tomli
 
 - repo: https://github.com/asottile/pyupgrade
-  rev: v3.3.1
+  rev: v3.10.1
   hooks:
   - id: pyupgrade
-    args: [--keep-runtime-typing, --py38-plus]
+    args: [--keep-runtime-typing, --py39-plus]
     files: ^xrtpy/
 
 - repo: https://github.com/pre-commit/pygrep-hooks
-  rev: v1.9.0
+  rev: v1.10.0
   hooks:
   - id: rst-directive-colons
   - id: rst-inline-touching-normal

.readthedocs.yaml

@@ -1,13 +1,24 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html
+
 version: 2
 
 formats:
 - htmlzip
 
+build:
+  os: ubuntu-22.04
+  tools:
+    python: '3.11'
+  apt_packages:
+  - graphviz
+  jobs:
+    post_build:
+    - echo $'\n'For help deciphering documentation build error messages, see:$'\n\n'\ \ https://docs.plasmapy.org/en/latest/contributing/doc_guide.html#troubleshooting
+
 python:
-  version: '3.8'
   install:
-  - requirements: requirements/install.txt
-  - requirements: requirements/docs.txt
-  - method: setuptools
+  - method: pip
     path: .
-  system_packages: true
+    extra_requirements:
+    - docs

LICENSE

@@ -1,6 +1,6 @@
 BSD 2-Clause License
 
-Copyright (c) 2021, HinodeXRT
+Copyright (c) 2021–2023, XRTpy contributors
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

MANIFEST.in

@@ -12,5 +12,6 @@ recursive-include licenses *
 prune build
 prune docs/_build
 prune docs/api
+prune tests
 
 global-exclude *.pyc *.o

changelog/139.removal.rst

@@ -0,0 +1 @@
+Removed support for Python 3.8. XRTpy now requires Python 3.9 or newer.

docs/_substitutions.rst

@@ -1,15 +1,17 @@
 .. |bibliography| replace:: :ref:`bibliography`\
+.. |Channel| replace:: :class:`~xrtpy.response.channel.Channel`
+.. |EffectiveAreaFundamental| replace:: :class:`~xrtpy.response.effective_area.EffectiveAreaFundamental`
 .. |glossary| replace:: :ref:`glossary`\
 .. |inf| replace:: `~numpy.inf`
-.. |minpython| replace:: 3.8
+.. |Map| replace:: `sunpy.map.Map`
+.. |minpython| replace:: 3.9
 .. |nan| replace:: `~numpy.nan`
 .. |ndarray| replace:: :class:`~numpy.ndarray`
 .. |Quantity| replace:: :class:`~astropy.units.Quantity`
+.. |TemperatureResponseFundamental| replace:: :class:`~xrtpy.response.temperature_response.TemperatureResponseFundamental`
 .. |TimeDelta| replace:: :class:`~astropy.time.TimeDelta`
 .. |Time| replace:: :class:`~astropy.time.Time`
-.. |Channel| replace:: :class:`~xrtpy.response.channel.Channel`
-.. |EffectiveAreaFundamental| replace:: :class:`~xrtpy.response.effective_area.EffectiveAreaFundamental`
-.. |TemperatureResponseFundamental| replace:: :class:`~xrtpy.response.temperature_response.TemperatureResponseFundamental`
+.. |XRTMap| replace:: `~sunpy.map.sources.hinode.XRTMap`
 
 .. A workaround for nested inline literals so that the filename will get
    formatted like a file but will be a link. In the text, these get used
@@ -21,23 +23,14 @@
    nitpick_ignore_regex in docs/conf.py so that it doesn't get counted
    as an error in a nitpicky doc build (e.g., tox -e doc_build_nitpicky).
 
-.. _`docs/_static`: https://github.com/PlasmaPy/PlasmaPy/tree/main/docs/_static
-.. |docs/_static| replace:: :file:`docs/_static`
-
-.. _`docs/_static/css`: https://github.com/PlasmaPy/PlasmaPy/tree/main/docs/_static/css
-.. |docs/_static/css| replace:: :file:`docs/_static/css`
-
-.. _`docs/api_static`: https://github.com/PlasmaPy/PlasmaPy/tree/main/docs/api_static
+.. _`docs/api_static`: https://github.com/HinodeXRT/xrtpy/tree/main/docs/api_static
 .. |docs/api_static| replace:: :file:`docs/api_static`
 
-.. _`docs/conf.py`: https://github.com/PlasmaPy/PlasmaPy/blob/main/docs/conf.py
+.. _`docs/conf.py`: https://github.com/HinodeXRT/xrtpy/blob/main/docs/conf.py
 .. |docs/conf.py| replace:: :file:`docs/conf.py`
 
-.. _`docs/glossary.rst`: https://github.com/PlasmaPy/PlasmaPy/blob/main/docs/glossary.rst
+.. _`docs/glossary.rst`: https://github.com/HinodeXRT/PlasmaPy/blob/main/docs/glossary.rst
 .. |docs/glossary.rst| replace:: :file:`docs/glossary.rst`
 
-.. _`docs/bibliography.bib`: https://github.com/PlasmaPy/PlasmaPy/blob/main/docs/bibliography.bib
+.. _`docs/bibliography.bib`: https://github.com/HinodeXRT/xrtpy/blob/main/docs/bibliography.bib
 .. |docs/bibliography.bib| replace:: :file:`docs/bibliography.bib`
-
-.. _`setup.cfg`: https://github.com/PlasmaPy/PlasmaPy/blob/main/setup.cfg
-.. |setup.cfg| replace:: :file:`setup.cfg`