Add ideal instrument and models

.gitignore

@@ -2,6 +2,10 @@
 docs/include/auto-instruments
 tests/unit_tests/data/*.png
 
+# Test debug images
+tests/unit_tests/data/*.png
+tests/unit_tests/data/*/*.png
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

docs/source/api/models/ideal.rst

@@ -0,0 +1,7 @@
+resolution\_functions.models.ideal
+----------------------------------
+
+.. automodule:: resolution_functions.models.ideal
+   :members:
+   :show-inheritance:
+   :special-members: __call__

docs/source/instruments/ideal.rst

@@ -0,0 +1,8 @@
+IDEAL
+#####
+
+The IDEAL instrument is synthetic and supports a variety of
+energy-independent 1-D broadening models. It is mainly intended for
+testing and experimentation.
+
+.. include:: ../../include/auto-instruments/ideal-auto.rst

pyproject.toml

@@ -71,3 +71,18 @@ where =  ["src"]
 
 [tool.setuptools.package-data]
 resolution_functions = ["instrument_data/*.yaml"]
+
+[tool.ruff]
+line-length = 88
+target-version = "py311"
+
+[tool.ruff.lint]
+# When jaxtyping array with one dimension, include a leading space
+# e.g. Float[np.ndarray, " mesh"]
+# in order to throw F722 (like a higher-D array) rather than F821
+# (which is sometimes a useful error).
+# https://docs.kidger.site/jaxtyping/faq/#flake8-or-ruff-are-throwing-an-error
+
+ignore = [
+        "F722"  # Caused by jaxtyping annotations.
+]

src/resolution_functions/instrument.py

@@ -24,6 +24,7 @@
     'ARCS': ('arcs.yaml', None),
     'CNCS': ('cncs.yaml', None),
     'HYSPEC': ('hyspec.yaml', None),
+    'IDEAL': ('ideal.yaml', None),
     'Lagrange': ('lagrange.yaml', None),
     'LET': ('let.yaml', None),
     'MAPS': ('maps.yaml', None),

src/resolution_functions/instrument_data/ideal.yaml

@@ -0,0 +1,47 @@
+name: "IDEAL"
+default_version: "IDEAL"
+
+version:
+    IDEAL:
+        default_model: "gaussian"
+        models:
+            boxcar: "boxcar_v1"
+            boxcar_v1:
+                function: "boxcar"
+                citation: [""]
+                parameters:
+                    defaults: {}
+                    restrictions: {}
+                configurations: {}
+            triangle: "triangle_v1"
+            triangle_v1:
+                function: "triangle"
+                citation: [ "" ]
+                parameters:
+                    defaults: {}
+                    restrictions: {}
+                configurations: { }
+            trapezoid: "trapezoid_v1"
+            trapezoid_v1:
+                function: "trapezoid"
+                citation: [ "" ]
+                parameters:
+                    defaults: {}
+                    restrictions: {}
+                configurations: { }
+            gaussian: "gaussian_v1"
+            gaussian_v1:
+                function: "gaussian"
+                citation: [ "" ]
+                parameters:
+                    defaults: {}
+                    restrictions: {}
+                configurations: { }
+            lorentzian: "lorentzian_v1"
+            lorentzian_v1:
+                function: "lorentzian"
+                citation: [ "" ]
+                parameters:
+                    defaults: {}
+                    restrictions: {}
+                configurations: { }

src/resolution_functions/models/__init__.py

@@ -13,6 +13,13 @@
 
 from typing import TYPE_CHECKING
 
+from .ideal import (
+    GenericBoxcar1DModel,
+    GenericTriangle1DModel,
+    GenericTrapezoid1DModel,
+    GenericGaussian1DModel,
+    GenericLorentzian1DModel,
+)
 from .polynomial import PolynomialModel1D, DiscontinuousPolynomialModel1D
 from .panther_abins import PantherAbINSModel
 from .pychop import PyChopModelFermi, PyChopModelNonFermi, PyChopModelCNCS, PyChopModelLET
@@ -24,6 +31,11 @@
 
 
 MODELS: dict[str, type[InstrumentModel]] = {
+    'boxcar': GenericBoxcar1DModel,
+    'triangle': GenericTriangle1DModel,
+    'trapezoid': GenericTrapezoid1DModel,
+    'gaussian': GenericGaussian1DModel,
+    'lorentzian': GenericLorentzian1DModel,
     'polynomial_1d': PolynomialModel1D,
     'discontinuous_polynomial': DiscontinuousPolynomialModel1D,
     'tosca_book': ToscaBookModel,