XRT DEM Iterative Solver Module

conftest.py

@@ -0,0 +1,2 @@
+import matplotlib
+matplotlib.use("Agg")

docs/about_xrt.rst

@@ -8,8 +8,8 @@ Hinode
 ======
 
 .. image:: _static/images/hinode_satellite.png
-   :alt: Hinode Satellite
-   :align: center
+    :alt: Hinode Satellite
+    :align: center
 
 Hinode is a joint mission involving the space agencies of Japan, the United States, Europe,  and the United Kingdom.
 It is depicted in the *illustration shown above*.
@@ -25,9 +25,9 @@ The X-Ray Telescope
 ===================
 
 .. image:: _static/images/XRT_composite_image_full_disk_14February2015.png
-   :alt: XRT Composite Image
-   :align: center
-   :scale: 50%
+    :alt: XRT Composite Image
+    :align: center
+    :scale: 50%
 
 The X-Ray Telescope (XRT), depicted as a long linear black tube on the Hinode spacecraft is a crucial instrument for observing the solar corona's most intense regions, with temperatures ranging from 1,000,000 to 10,000,000 Kelvin.
 The image below is a synoptic composite from February 14, 2015, created using the Al-Mesh/Be-Thin/Al-Med filters.
@@ -36,7 +36,7 @@ For a comprehensive overview of XRT's mission and capabilities, please visit the
 
 .. tip::
 
-   Visit the `XRT Picture of the Week`_ and the `Hinode-XRT YouTube`_ page for captivating visual content showcasing the XRT's solar observations.
+    Visit the `XRT Picture of the Week`_ and the `Hinode-XRT YouTube`_ page for captivating visual content showcasing the XRT's solar observations.
 
 XRT uses two sequentially positioned filter wheels, as shown in the diagram below, where each wheel houses a variety of filters.
 By rotating these wheels, scientists can select different filters to study the Sun in different wavelengths, thereby enhancing the resolution and quality of solar images.
@@ -73,8 +73,8 @@ The existing filters are structured as follows:
     The process is the same for all XRT filter channels.
 
 .. image:: _static/images/XRT_filter_wheels_Sun_View_Diagram.png
-   :alt: Diagram of the XRT Filter Wheels
-   :align: center
+    :alt: Diagram of the XRT Filter Wheels
+    :align: center
 
 Data Products
 *************
@@ -99,8 +99,8 @@ The XRT software was originally created in the Interactive Data Language (IDL).
 
 .. note::
 
-   Please note that the `SolarSoft XRT Analysis Guide`_ does not serve as a guide for using XRTpy.
-   It focuses solely on the analysis of XRT data using the IDL software.
+    Please note that the `SolarSoft XRT Analysis Guide`_ does not serve as a guide for using XRTpy.
+    It focuses solely on the analysis of XRT data using the IDL software.
 
 .. _Hinode-XRT YouTube: https://www.youtube.com/user/xrtpow
 .. _Interactive Data Language: https://www.l3harrisgeospatial.com/Software-Technology/IDL

docs/bibliography.bib

@@ -171,3 +171,23 @@ @ARTICLE{velasquez:2024
   doi = {10.21105/joss.06396},
   url = {https://doi.org/10.21105/joss.06396}
 }
+
+@ARTICLE{weber:2004,
+  author  = {{Weber}, M.~A. and {DeLuca}, E.~E. and {Golub}, L. and {Sette}, A.~L.},
+  title   = "{Temperature diagnostics with multichannel imaging telescopes}",
+  journal = "{IAU Symposium 223: Multi-Wavelength Investigations of Solar Activity}",
+  year    = 2004,
+  pages   = {321--328},
+  publisher = {Cambridge University Press},
+  doi     = {10.1017/S1743921304006088}
+}
+
+@ARTICLE{golub:2004,
+  author  = {{Golub}, L. and {DeLuca}, E.~E. and {Sette}, A. and {Weber}, M.},
+  title   = "{DEM analysis with the X-Ray Telescope (XRT) for Solar-B}",
+  journal = "{ASP Conference Series, The Solar-B Mission and the Outlook for Space-Based Solar Physics}",
+  year    = 2004,
+  volume  = {325},
+  pages   = {217--222},
+  publisher = {Astronomical Society of the Pacific}
+}

docs/changelog/0.6.0.rst

@@ -0,0 +1,24 @@
+XRTpy v0.6.0 (2026-05-04)
+=========================
+
+New Features
+------------
+- Introduced :class:`~xrtpy.xrt_dem_iterative.XRTDEMIterative`, a Python
+  implementation of the IDL routine ``xrt_dem_iterative2.pro``. This solver
+  uses spline-parameterized DEM curves and iterative least-squares fitting to
+  infer the differential emission measure from Hinode/XRT multi-filter
+  observations. (Will udpate with PR)
+- Added Monte Carlo uncertainty estimation to the DEM solver via the
+  ``monte_carlo_runs`` parameter. Perturbed intensity realizations are used
+  to estimate the spread in DEM(T). 
+- Added ``plot_dem()`` and ``plot_dem_mc()`` methods to
+  :class:`~xrtpy.xrt_dem_iterative.XRTDEMIterative` for visualizing the
+  base DEM solution and Monte Carlo ensemble.
+
+Documentation Updates
+---------------------
+- Added a new overview page ``dem_overview.rst`` providing an introduction
+  to DEM analysis with Hinode/XRT, the mathematical background, and
+  worked examples using :class:`~xrtpy.xrt_dem_iterative.XRTDEMIterative`.
+
+- Added API reference page for ``xrtpy.xrt_dem_iterative``.

docs/changelog/index.rst

@@ -9,8 +9,9 @@ This document lists the changes made during each release of XRTpy, including bug
 .. toctree::
    :maxdepth: 1
 
+   0.6.0
    0.5.1
    0.5.0
    0.4.0
    0.3.0
-   0.2.0
+   0.2.0

docs/conf.py

@@ -4,12 +4,16 @@
 
 # -- stdlib imports ------------------------------------------------------------
 import os
+import sys
 import warnings
 from datetime import datetime, timezone
 from pathlib import Path
 
 from packaging.version import Version
 
+# Ensure Sphinx imports the local xrtpy checkout (repo root), not site-packages
+sys.path.insert(0, str(Path(__file__).resolve().parents[1]))
+
 # -- Read the Docs Specific Configuration --------------------------------------
 # This needs to be done before xrtpy is imported
 on_rtd = os.environ.get("READTHEDOCS", None) == "True"
@@ -70,7 +74,7 @@
 ogp_image = "https://raw.githubusercontent.com/HinodeXRT/xrtpy/main/docs/_static/images/xrtpy_logo.png"
 ogp_use_first_image = True
 ogp_description_length = 160
-ogp_custom_meta_tags = ('<meta property="og:ignore_canonical" content="true" />',)
+#ogp_custom_meta_tags = ('<meta property="og:ignore_canonical" content="true" />',)
 
 # Suppress warnings about overriding directives as we overload some of the
 # doctest extensions.
@@ -230,6 +234,7 @@
     "feedback_communication*": [],
     "contributing*": [],
     "code_of_conduct*": [],
+    "dem_overview*": [],
 }
 # 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,