add get_compatible_units function

gemd/__version__.py

@@ -1 +1 @@
-__version__ = "2.3.2"
+__version__ = "2.4.0"

gemd/units/__init__.py

@@ -3,6 +3,7 @@
     parse_units,
     convert_units,
     get_base_units,
+    get_compatible_units,
     change_definitions_file,
     UndefinedUnitError,
     IncompatibleUnitsError,
@@ -13,6 +14,7 @@
     "parse_units",
     "convert_units",
     "get_base_units",
+    "get_compatible_units",
     "change_definitions_file",
     "UndefinedUnitError",
     "IncompatibleUnitsError",

gemd/units/impl.py

@@ -385,6 +385,23 @@ def get_base_units(units: Union[str, UnitRegistry.Unit]) -> Tuple[UnitRegistry.U
     return base_unit, float(ratio), offset
 
 
+def get_compatible_units(units: Union[str, UnitRegistry.Unit]) -> List[str]:
+    """Get all compatible units that match the dimensionality of the provided units.
+
+    Parameters
+    ----------
+    units: str, Unit
+        The representation of the object we wish to compare
+
+    Returns
+    -------
+    List[str]
+        A list of the compatible units.
+
+    """
+    return [f"{u}" for u in _REGISTRY.get_compatible_units(units)]
+
+
 def change_definitions_file(filename: str = None):
     """Change which file is used for units definition.
 

tests/units/test_parser.py

@@ -13,6 +13,7 @@
     change_definitions_file,
     convert_units,
     get_base_units,
+    get_compatible_units,
     parse_units,
 )
 
@@ -191,6 +192,19 @@ def test_get_base_units():
     assert get_base_units("g / 25 mm") == (_REGISTRY("kg / m"), 0.04, 0)
 
 
+def test_get_compatible_units():
+    """Test that compatible units make sense."""
+    from gemd.units.impl import _REGISTRY
+    assert "kelvin" in get_compatible_units("degC")
+    assert "degree_Celsius" in get_compatible_units("degC")
+    assert "gram" in get_compatible_units("kg")
+    assert "meter" not in get_compatible_units("kg")
+    assert "meter" in get_compatible_units("km")
+    assert "meter" in get_compatible_units(_REGISTRY("km"))
+    assert "meter" in get_compatible_units("[length]")
+    assert "gram" not in get_compatible_units("km")
+
+
 @contextmanager
 def _change_units(filename):
     try: