import GPUNotAvailableError to error.py

hoomd/data/array.py

@@ -708,7 +708,7 @@ def _repr_html_(self):
                     return "<emph>" + name + "</emph>" \
                         + "(<strong>INVALID</strong>)"
 else:
-    from hoomd.util import _NoGPU
+    from hoomd.error import _NoGPU
 
     class HOOMDGPUArray(_NoGPU):
         """GPU arrays are not available on the CPU."""

hoomd/data/local_access_gpu.py

@@ -63,7 +63,7 @@ def __init__(self, state):
             self._constraints = ConstraintLocalAccessGPU(state)
 
 else:
-    from hoomd.util import _NoGPU
+    from hoomd.error import _NoGPU
 
     class BondLocalAccessGPU(_NoGPU):
         """GPU data access is not available in CPU builds."""

hoomd/error.py

@@ -37,6 +37,19 @@ class TypeConversionError(ValueError):
     pass
 
 
+class GPUNotAvailableError(NotImplementedError):
+    """Error for when a GPU specific feature was requested without a GPU."""
+    pass
+
+
+class _NoGPU:
+    """Used in nonGPU builds of hoomd to raise errors for attempted use."""
+
+    def __init__(self, *args, **kwargs):
+        raise GPUNotAvailableError(
+            "This build of HOOMD-blue does not support GPUs.")
+
+
 class IncompleteSpecificationError(ValueError):
     """Error when a value is missing."""
     pass

hoomd/md/data/local_access_gpu.py

@@ -23,7 +23,7 @@ class NeighborListLocalAccessGPU(_NeighborListLocalAccessBase):
         _array_cls = HOOMDGPUArray
 
 else:
-    from hoomd.util import _NoGPU
+    from hoomd.error import _NoGPU
 
     class ForceLocalAccessGPU(_NoGPU):
         """GPU data access is not available in CPU builds."""

hoomd/util.py

@@ -6,6 +6,7 @@
 import hoomd
 import io
 from collections.abc import Iterable, Mapping, MutableMapping
+from hoomd.error import GPUNotAvailableError  # noqa: F401
 
 
 def _to_camel_case(string):
@@ -252,19 +253,6 @@ def __setitem__(self, namespace, value):
             super().__setitem__(namespace, value)
 
 
-class GPUNotAvailableError(NotImplementedError):
-    """Error for when a GPU specific feature was requested without a GPU."""
-    pass
-
-
-class _NoGPU:
-    """Used in nonGPU builds of hoomd to raise errors for attempted use."""
-
-    def __init__(self, *args, **kwargs):
-        raise GPUNotAvailableError(
-            "This build of HOOMD-blue does not support GPUs.")
-
-
 def make_example_simulation(device=None, dimensions=3, particle_types=['A']):
     """Make an example Simulation object.
 

sphinx-doc/deprecated.rst

@@ -25,6 +25,11 @@ documentation for more information on warning filters.
 
 * ``HPMCIntegrator.depletant_fugacity > 0`` (since 4.4.0).
 
+
+* ``hoomd.util.GPUNotAvailableError`` (since 4.5.0).
+
+  * use ``hoomd.error.GPUNotAvailableError``.
+
 * ``_InternalCustomUpdater.update`` (since 4.5.0)
 * ``_InternalCustomTuner.tune`` (since 4.5.0)
 * ``_InternalCustomWriter.write`` (since 4.5.0)

sphinx-doc/module-hoomd-error.rst

@@ -14,13 +14,15 @@ hoomd.error
     DataAccessError
     TypeConversionError
     MutabilityError
+    GPUNotAvailableError
 
 .. rubric:: Details
 
 .. automodule:: hoomd.error
     :synopsis: HOOMD errors
     :members: DataAccessError,
               TypeConversionError,
-              MutabilityError
+              MutabilityError,
+              GPUNotAvailableError
     :no-inherited-members:
     :show-inheritance:

sphinx-doc/module-hoomd-util.rst

@@ -11,12 +11,10 @@ hoomd.util
 .. autosummary::
     :nosignatures:
 
-    GPUNotAvailableError
     make_example_simulation
 
 .. rubric:: Details
 
 .. automodule:: hoomd.util
     :synopsis: Utilities
-    :members: GPUNotAvailableError,
-              make_example_simulation
+    :members: make_example_simulation