hinode 0.1.0__tar.gz

hinode-0.1.0/.github/workflows/black.yml

@@ -0,0 +1,17 @@
+name: Black
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  black:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: psf/black@stable
+        with:
+          options: "--check --verbose --diff"
+          src: "./hinode"

hinode-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,32 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    name: Build and publish to PyPI
+    if: startsWith(github.ref, 'refs/tags')
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+      - name: Install pypa/build
+        run: >-
+          python -m
+          pip install
+          build
+          --user
+      - name: Build a binary wheel and a source tarball
+        run: >-
+          python -m
+          build
+          --sdist
+          --wheel
+          --outdir dist/
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

hinode-0.1.0/.github/workflows/ruff.yml

@@ -0,0 +1,14 @@
+name: Ruff
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/ruff-action@v3

hinode-0.1.0/.github/workflows/tests.yml

@@ -0,0 +1,46 @@
+name: tests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [
+          ubuntu-latest,
+          windows-latest,
+          macOS-latest,
+        ]
+        python-version: ["3.12", "3.14",]
+    name: ${{ matrix.os }}, Python ${{ matrix.python-version }} tests
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install package
+        run: |
+          python -m pip install --upgrade pip
+          pip install setuptools wheel
+          pip install -e .[test]
+      - name: Test with pytest
+        env:
+          MPLBACKEND: "agg"
+        run: |
+          pip install pytest pytest-cov
+          pytest --cov=. --cov-report=xml
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v7
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: coverage.xml
+          flags: unittests
+          env_vars: OS,PYTHON
+          name: codecov-umbrella

hinode-0.1.0/.github/workflows/typing.yml

@@ -0,0 +1,25 @@
+name: typing
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  pyright:
+    name: Check type annotations with pyright
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - name: Install package
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e .[test]
+          pip install pyright==1.1.411
+      - name: Check types with pyright
+        run: pyright

hinode-0.1.0/.gitignore

@@ -0,0 +1,26 @@
+# Python
+__pycache__/
+*.py[cod]
+
+# Build metadata written by `pip install -e .`
+*.egg-info/
+build/
+dist/
+
+# Written by Sphinx: `_autosummary` is the API reference generated from the
+# docstrings, so it is a copy of the source rather than a thing of its own.
+docs/_build/
+docs/_autosummary/
+jupyter_execute/
+
+# Written by pytest and by the coverage step of the test workflow
+.pytest_cache/
+.coverage
+coverage.xml
+
+# Written by Jupyter alongside a notebook that has been opened
+.ipynb_checkpoints/
+
+# IDE
+.idea/
+.vscode/

hinode-0.1.0/.readthedocs.yml

@@ -0,0 +1,18 @@
+version: 2
+
+build:
+  os: ubuntu-lts-latest
+  tools:
+    python: "3.12"
+  apt_packages:
+    - graphviz
+
+sphinx:
+  configuration: docs/conf.py
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - doc

hinode-0.1.0/CITATION.cff

@@ -0,0 +1,22 @@
+cff-version: 1.2.0
+message: "If you use hinode in your research, please cite it using these metadata."
+type: software
+title: hinode
+abstract: >-
+  hinode is a Python library for downloading and analyzing observations from
+  the Hinode satellite, starting with the X-Ray Telescope (XRT). Observations
+  are represented as named-arrays function arrays, so a sequence of images has
+  named axes and physical units, and carries the time and sky position of
+  every pixel.
+authors:
+  - family-names: Smart
+    given-names: Roy T.
+    orcid: "https://orcid.org/0000-0002-9997-5515"
+repository-code: "https://github.com/sun-data/hinode"
+url: "https://hinode.readthedocs.io"
+license: BSD-3-Clause
+keywords:
+  - Hinode
+  - XRT
+  - solar physics
+  - data access

hinode-0.1.0/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2026, Roy T. Smart
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

hinode-0.1.0/PKG-INFO

@@ -0,0 +1,77 @@
+Metadata-Version: 2.4
+Name: hinode
+Version: 0.1.0
+Summary: A Python library to download and analyze observations from the Hinode satellite.
+Author-email: "Roy T. Smart" <roytsmart@gmail.com>
+License-Expression: BSD-3-Clause
+Project-URL: Homepage, https://github.com/sun-data/hinode
+Project-URL: Documentation, https://hinode.readthedocs.io/en/latest
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests
+Requires-Dist: urllib3>=2
+Requires-Dist: joblib
+Requires-Dist: astropy
+Requires-Dist: named-arrays~=2.14
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Provides-Extra: doc
+Requires-Dist: pytest; extra == "doc"
+Requires-Dist: matplotlib; extra == "doc"
+Requires-Dist: graphviz; extra == "doc"
+Requires-Dist: sphinx-autodoc-typehints; extra == "doc"
+Requires-Dist: sphinxcontrib-bibtex; extra == "doc"
+Requires-Dist: pydata-sphinx-theme; extra == "doc"
+Requires-Dist: ipykernel; extra == "doc"
+Requires-Dist: jupyter-sphinx; extra == "doc"
+Requires-Dist: sphinx-favicon; extra == "doc"
+Dynamic: license-file
+
+# hinode
+
+[![tests](https://github.com/sun-data/hinode/actions/workflows/tests.yml/badge.svg)](https://github.com/sun-data/hinode/actions/workflows/tests.yml)
+[![codecov](https://codecov.io/gh/sun-data/hinode/graph/badge.svg)](https://codecov.io/gh/sun-data/hinode)
+[![Black](https://github.com/sun-data/hinode/actions/workflows/black.yml/badge.svg)](https://github.com/sun-data/hinode/actions/workflows/black.yml)
+[![Ruff](https://github.com/sun-data/hinode/actions/workflows/ruff.yml/badge.svg)](https://github.com/sun-data/hinode/actions/workflows/ruff.yml)
+[![typing](https://github.com/sun-data/hinode/actions/workflows/typing.yml/badge.svg)](https://github.com/sun-data/hinode/actions/workflows/typing.yml)
+[![Documentation Status](https://readthedocs.org/projects/hinode/badge/?version=latest)](https://hinode.readthedocs.io/en/latest/?badge=latest)
+
+A Python library to download and analyze observations from the
+JAXA/NASA [Hinode](https://hinode.nao.ac.jp/en/) satellite.
+
+So far it supports the Level 1 images of the X-Ray Telescope (XRT),
+which it finds in the archive of the Solar Data Analysis Center,
+sorts by filter, and downloads.
+The images are not represented as instances of
+[`sunpy.map.Map`](https://docs.sunpy.org/en/stable/generated/api/sunpy.map.Map.html),
+but as instances of [`named_arrays.FunctionArray`](https://named-arrays.readthedocs.io/en/latest/_autosummary/named_arrays.FunctionArray.html),
+which carry the time, exposure time and sky position of every pixel,
+along with a mask of the pixels affected by saturation.
+
+## Installation
+
+This package is published on PyPI and can be installed using pip
+```bash
+pip install hinode
+```
+
+## Example
+
+Load the XRT images taken through the Al_poly filter between two times
+```python
+import hinode
+
+images = hinode.xrt.open(
+    time_start="2019-09-30T18:06:11",
+    time_stop="2019-09-30T18:11:01",
+    filter="Al_poly",
+)
+```
+
+## Citation
+
+If you use hinode in your research, please cite it.
+The citation metadata is kept in [`CITATION.cff`](https://github.com/sun-data/hinode/blob/main/CITATION.cff),
+which the "Cite this repository" button on GitHub can export as BibTeX or APA.

hinode-0.1.0/README.md

@@ -0,0 +1,46 @@
+# hinode
+
+[![tests](https://github.com/sun-data/hinode/actions/workflows/tests.yml/badge.svg)](https://github.com/sun-data/hinode/actions/workflows/tests.yml)
+[![codecov](https://codecov.io/gh/sun-data/hinode/graph/badge.svg)](https://codecov.io/gh/sun-data/hinode)
+[![Black](https://github.com/sun-data/hinode/actions/workflows/black.yml/badge.svg)](https://github.com/sun-data/hinode/actions/workflows/black.yml)
+[![Ruff](https://github.com/sun-data/hinode/actions/workflows/ruff.yml/badge.svg)](https://github.com/sun-data/hinode/actions/workflows/ruff.yml)
+[![typing](https://github.com/sun-data/hinode/actions/workflows/typing.yml/badge.svg)](https://github.com/sun-data/hinode/actions/workflows/typing.yml)
+[![Documentation Status](https://readthedocs.org/projects/hinode/badge/?version=latest)](https://hinode.readthedocs.io/en/latest/?badge=latest)
+
+A Python library to download and analyze observations from the
+JAXA/NASA [Hinode](https://hinode.nao.ac.jp/en/) satellite.
+
+So far it supports the Level 1 images of the X-Ray Telescope (XRT),
+which it finds in the archive of the Solar Data Analysis Center,
+sorts by filter, and downloads.
+The images are not represented as instances of
+[`sunpy.map.Map`](https://docs.sunpy.org/en/stable/generated/api/sunpy.map.Map.html),
+but as instances of [`named_arrays.FunctionArray`](https://named-arrays.readthedocs.io/en/latest/_autosummary/named_arrays.FunctionArray.html),
+which carry the time, exposure time and sky position of every pixel,
+along with a mask of the pixels affected by saturation.
+
+## Installation
+
+This package is published on PyPI and can be installed using pip
+```bash
+pip install hinode
+```
+
+## Example
+
+Load the XRT images taken through the Al_poly filter between two times
+```python
+import hinode
+
+images = hinode.xrt.open(
+    time_start="2019-09-30T18:06:11",
+    time_stop="2019-09-30T18:11:01",
+    filter="Al_poly",
+)
+```
+
+## Citation
+
+If you use hinode in your research, please cite it.
+The citation metadata is kept in [`CITATION.cff`](https://github.com/sun-data/hinode/blob/main/CITATION.cff),
+which the "Cite this repository" button on GitHub can export as BibTeX or APA.

hinode-0.1.0/docs/.gitignore

@@ -0,0 +1,2 @@
+_autosummary/
+_build/

hinode-0.1.0/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

hinode-0.1.0/docs/_templates/class_custom.rst

@@ -0,0 +1,40 @@
+{{ name | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ fullname }}
+    :members:
+    :show-inheritance:
+    :inherited-members:
+    :undoc-members:
+    :member-order: groupwise
+
+    {% block attributes %}
+    {% if attributes %}
+    .. rubric:: {{ _('Attributes') }}
+
+    .. autosummary::
+    {% for item in attributes %}
+      ~{{ name }}.{{ item }}
+    {%- endfor %}
+    {% endif %}
+    {% endblock %}
+
+    {% block methods %}
+    {% if methods %}
+    .. rubric:: {{ _('Methods') }}
+
+    .. autosummary::
+    {% for item in methods %}
+      ~{{ name }}.{{ item }}
+    {%- endfor %}
+    {% endif %}
+    {% endblock %}
+
+    {% block dia %}
+    .. rubric:: {{ _('Inheritance Diagram') }}
+
+    .. inheritance-diagram:: {{ fullname }}
+        :parts: 1
+    {% endblock %}
+

hinode-0.1.0/docs/_templates/function_custom.rst

@@ -0,0 +1,5 @@
+{{ name | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. autofunction:: {{ fullname }}

hinode-0.1.0/docs/_templates/module_custom.rst

@@ -0,0 +1,69 @@
+{{ name | escape | underline}}
+
+.. automodule:: {{ fullname }}
+
+    {% block attributes %}
+    {% if attributes %}
+    .. rubric:: Module Attributes
+
+    .. autosummary::
+      :toctree:
+    {% for item in attributes %}
+      {{ item }}
+    {%- endfor %}
+    {% endif %}
+    {% endblock %}
+
+    {% block functions %}
+    {% if functions %}
+    .. rubric:: {{ _('Functions') }}
+
+    .. autosummary::
+      :toctree:
+      :template: function_custom.rst
+    {% for item in functions %}
+      {{ item }}
+    {%- endfor %}
+    {% endif %}
+    {% endblock %}
+
+    {% block classes %}
+    {% if classes %}
+    .. rubric:: {{ _('Classes') }}
+
+    .. autosummary::
+      :toctree:
+      :template: class_custom.rst
+    {% for item in classes %}
+      {{ item }}
+    {%- endfor %}
+    {% endif %}
+    {% endblock %}
+
+    {% block exceptions %}
+    {% if exceptions %}
+    .. rubric:: {{ _('Exceptions') }}
+
+    .. autosummary::
+      :toctree:
+    {% for item in exceptions %}
+      {{ item }}
+    {%- endfor %}
+    {% endif %}
+    {% endblock %}
+
+    {% block modules %}
+    {% if modules %}
+    .. rubric:: Modules
+
+    .. autosummary::
+       :toctree:
+       :template: module_custom.rst
+       :recursive:
+    {% for item in modules %}
+       {{ item }}
+    {%- endfor %}
+    {% endif %}
+    {% endblock %}
+
+

hinode-0.1.0/docs/conf.py

@@ -0,0 +1,80 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of options, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+import os
+import sys
+
+package_path = os.path.abspath("../")
+sys.path.insert(0, package_path)
+os.environ["PYTHONPATH"] = os.pathsep.join(
+    (package_path, os.environ.get("PYTHONPATH", ""))
+)
+
+# -- Project information -----------------------------------------------------
+
+project = "hinode"
+copyright = "2026, Roy T. Smart"
+author = "Roy T. Smart"
+
+# -- General configuration ---------------------------------------------------
+
+extensions = [
+    "sphinx.ext.napoleon",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.inheritance_diagram",
+    "sphinx.ext.viewcode",
+    "sphinxcontrib.bibtex",
+    "jupyter_sphinx",
+]
+autosummary_generate = True
+autosummary_imported_members = True
+autosummary_ignore_module_all = False
+autodoc_typehints = "description"
+
+graphviz_output_format = "png"
+inheritance_graph_attrs = dict(rankdir="TB")
+
+templates_path = ["_templates"]
+
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+# -- Options for HTML output -------------------------------------------------
+
+html_theme = "pydata_sphinx_theme"
+
+html_static_path = ["_static"]
+
+html_theme_options = {
+    "icon_links": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/sun-data/hinode",
+            "icon": "fa-brands fa-github",
+            "type": "fontawesome",
+        },
+        {
+            "name": "PyPI",
+            "url": "https://pypi.org/project/hinode",
+            "icon": "fa-brands fa-python",
+        },
+    ],
+}
+
+# https://github.com/readthedocs/readthedocs.org/issues/2569
+master_doc = "index"
+
+bibtex_bibfiles = ["refs.bib"]
+bibtex_default_style = "plain"
+bibtex_reference_style = "author_year"
+
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+    "numpy": ("https://numpy.org/doc/stable/", None),
+    "matplotlib": ("https://matplotlib.org/stable", None),
+    "astropy": ("https://docs.astropy.org/en/stable/", None),
+    "named_arrays": ("https://named-arrays.readthedocs.io/en/stable/", None),
+}

hinode-0.1.0/docs/index.rst

@@ -0,0 +1,92 @@
+Introduction
+============
+
+`Hinode <https://hinode.nao.ac.jp/en/>`_ is a JAXA solar observatory,
+built with NASA, the UK Space Agency, and ESA,
+which has been observing the Sun since 2006 :cite:p:`Kosugi2007`.
+
+This Python package downloads Hinode observations and represents them
+using :mod:`named_arrays`,
+a named tensor implementation with :class:`astropy.units.Quantity` support.
+So far it supports the Level 1 images of the
+X-Ray Telescope (XRT) :cite:p:`Golub2007`, in :mod:`hinode.xrt`.
+
+Installation
+============
+
+This package is published to PyPI and can be installed using pip.
+
+.. code-block::
+
+    pip install hinode
+
+API Reference
+=============
+
+.. autosummary::
+    :toctree: _autosummary
+    :template: module_custom.rst
+    :recursive:
+
+    hinode
+
+
+Examples
+========
+
+Load the XRT images taken through the Al_poly filter while the
+EUV Snapshot Imaging Spectrograph (ESIS) was observing the Sun on
+2019 September 30, and display the last one.
+
+.. jupyter-execute::
+
+    import matplotlib.pyplot as plt
+    import astropy.units as u
+    import astropy.visualization
+    import named_arrays as na
+    import hinode
+
+    # Download the images and load them into memory
+    images = hinode.xrt.open(
+        time_start="2019-09-30T18:06:11",
+        time_stop="2019-09-30T18:11:01",
+        filter="Al_poly",
+    )
+
+    # Select the last image
+    image = images[{images.axis_time: ~0}]
+
+    # Display the image
+    unit = image.inputs.position.x.unit
+    with astropy.visualization.quantity_support():
+        fig, ax = plt.subplots(figsize=(6, 6), constrained_layout=True)
+        na.plt.pcolormesh(
+            image.inputs.position.x,
+            image.inputs.position.y,
+            C=image.outputs,
+            ax=ax,
+            cmap="gray",
+            norm="asinh",
+            vmin=0 * u.DN / u.s,
+            vmax=100 * u.DN / u.s,
+        )
+        ax.set_aspect("equal")
+        ax.set_title(image.inputs.time.ndarray)
+        ax.set_xlabel(f"helioprojective $x$ ({unit:latex_inline})")
+        ax.set_ylabel(f"helioprojective $y$ ({unit:latex_inline})")
+
+
+References
+==========
+
+.. bibliography::
+
+|
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`