Cleanup xrdutil (#663)

* Reformat utils

* Remove unused _convert_angles function

* Remove check for numba install

* Clean up unused variables, add typing

* Remove unused _coo_build_window function

* Add type hints to function defs

* Remove unnecessary variables / passes

* Provide deprecation warnings to the user.

* Tuple -> tuple

* List -> list, Dict -> dict

* Change deprecated to accept str instead of func

* Remove unnecessary "save" func from etaOmeMaps

* Add deprecation date

* deprecation_date -> removal_date

* Swap max/min energies for wavelength calc

hexrd/deprecation.py

@@ -0,0 +1,35 @@
+import os
+import functools
+
+
+class DeprecatedFunctionError(Exception):
+    """Custom exception for deprecated functions."""
+    pass
+
+
+def deprecated(new_func: str = None, removal_date: str = None):
+    """
+    Decorator to mark functions as deprecated. Raises an error if
+    the 'ACK_DEPRECATED' environment variable is not set. Alerts the
+    user to the replacement function if provided.
+    """
+
+    def decorator(func):
+        @functools.wraps(func)
+        def wrapper(*args, **kwargs):
+            if new_func is not None:
+                print(
+                    f"Warning: {func.__name__} is deprecated and is marked for"
+                    f" removal. Please use {new_func} instead."
+                    f" Removal date: {removal_date}"
+                )
+            if os.getenv('ACK_DEPRECATED') != 'true':
+                raise DeprecatedFunctionError(
+                    f"Function {func.__name__} is deprecated. Set environment "
+                    "variable 'ACK_DEPRECATED' to 'true' to acknowledge."
+                )
+            return func(*args, **kwargs)
+
+        return wrapper
+
+    return decorator

hexrd/findorientations.py

@@ -592,7 +592,7 @@ def generate_eta_ome_maps(cfg, hkls=None, save=True):
             map_fname
         )
 
-        eta_ome.save(fn)
+        eta_ome.save_eta_ome_maps(fn)
 
         logger.info('saved eta/ome orientation maps to "%s"', fn)