Replaced some assert statements with proper checks

pde/fields/base.py

@@ -252,8 +252,8 @@
 
             else:
                 raise RuntimeError(
-                    "Multiple data fields were found in the "
-                    "file but no FieldCollection is expected"
+                    "Multiple data fields were found in the file but no "
+                    "`FieldCollection` is expected."
                 )
         return obj
 
@@ -684,7 +684,8 @@
         else:
             raise TypeError("`func` must be string or callable")
 
-        assert isinstance(out, FieldBase)
+        if not isinstance(out, FieldBase):
+            raise TypeError("`out` must be of type `FieldBase`")
         if label:
             out.label = label
         return out  # type: ignore
@@ -1659,7 +1660,8 @@
             rank_b = b.ndim - num_axes
             if rank_a < 1 or rank_b < 1:
                 raise TypeError("Fields in dot product must have rank >= 1")
-            assert a.shape[rank_a:] == b.shape[rank_b:]
+            if a.shape[rank_a:] != b.shape[rank_b:]:
+                raise ValueError("Shapes of fields are not compatible for dot product")
 
             if rank_a == 1 and rank_b == 1:  # result is scalar field
                 return np.einsum("i...,i...->...", a, maybe_conj(b), out=out)

pde/fields/collection.py

@@ -132,8 +132,10 @@
                 field._data_flat = self._data_full[self._slices[i]]
 
                 # check whether the field data is based on our data field
-                assert field.data.shape == field_shape
-                assert np.may_share_memory(field._data_full, self._data_full)
+                if field.data.shape != field_shape:
+                    raise RuntimeError("Field shapes have changed!")
+                if not np.may_share_memory(field._data_full, self._data_full):
+                    raise RuntimeError("Spurious copy of data detected!")
 
         if labels is not None:
             self.labels = labels  # type: ignore

pde/fields/tensorial.py

@@ -153,7 +153,8 @@
         self._data_full = data_full
 
         # ensure that no copying happend
-        assert np.may_share_memory(self.data, value)
+        if not np.may_share_memory(self.data, value):
+            raise RuntimeError("Spurious copy detected!")
 
     def dot(
         self,
@@ -192,7 +193,8 @@
         if out is None:
             out = other.__class__(self.grid, dtype=get_common_dtype(self, other))
         else:
-            assert isinstance(out, other.__class__), f"`out` must be {other.__class__}"
+            if not isinstance(out, other.__class__):
+                raise TypeError(f"`out` must be of type `{other.__class__}`")
             self.grid.assert_grid_compatible(out.grid)
 
         # calculate the result

pde/fields/vectorial.py

@@ -74,7 +74,8 @@
 
         data = []
         for field in fields:
-            assert field.grid.compatible_with(grid)
+            if not field.grid.compatible_with(grid):
+                raise ValueError("Grids are incompatible")
             data.append(field.data)
 
         return cls(grid, data, label=label, dtype=dtype)
@@ -209,7 +210,8 @@
         if out is None:
             out = result_type(self.grid, dtype=get_common_dtype(self, other))
         else:
-            assert isinstance(out, result_type), f"`out` must be {result_type}"
+            if not isinstance(out, result_type):
+                raise TypeError(f"`out` must be of type `{result_type}`")
             self.grid.assert_grid_compatible(out.grid)
 
         # calculate the result

pde/grids/coordinates/base.py

@@ -268,5 +268,6 @@
 
         # convert the basis of the vectors to Cartesian
         basis = self.basis_rotation(points)
-        assert basis.shape == (self.dim, self.dim) + shape
+        if basis.shape != (self.dim, self.dim) + shape:
+            raise DimensionError("Incompatible dimensions in rotation matrix")
         return np.einsum("j...,ji...->i...", components, basis)  # type: ignore

pde/pdes/allen_cahn.py

@@ -73,7 +73,8 @@
             :class:`~pde.fields.ScalarField`:
             Scalar field describing the evolution rate of the PDE
         """
-        assert isinstance(state, ScalarField), "`state` must be ScalarField"
+        if not isinstance(state, ScalarField):
+            raise ValueError("`state` must be ScalarField")
         laplace = state.laplace(bc=self.bc, label="evolution rate", args={"t": t})
         return self.interface_width * laplace - state**3 + state  # type: ignore
 

pde/pdes/base.py

@@ -367,7 +367,8 @@
             cell_volume: Callable[[int], float] = state.grid.make_cell_volume_compiled(
                 flat_index=True
             )
-            assert state.dtype == float
+            if state.dtype != float:
+                raise TypeError("Noise is only supported for float types")
 
             if isinstance(state, FieldCollection):
                 # different noise strengths, assuming one for each field

pde/pdes/diffusion.py

@@ -84,7 +84,8 @@
             :class:`~pde.fields.ScalarField`:
             Scalar field describing the evolution rate of the PDE
         """
-        assert isinstance(state, ScalarField), "`state` must be ScalarField"
+        if not isinstance(state, ScalarField):
+            raise ValueError("`state` must be ScalarField")
         laplace = state.laplace(bc=self.bc, label="evolution rate", args={"t": t})
         return self.diffusivity * laplace  # type: ignore
 

pde/pdes/kpz_interface.py

@@ -92,7 +92,8 @@
             :class:`~pde.fields.ScalarField`:
             Scalar field describing the evolution rate of the PDE
         """
-        assert isinstance(state, ScalarField), "`state` must be ScalarField"
+        if not isinstance(state, ScalarField):
+            raise ValueError("`state` must be ScalarField")
         result = self.nu * state.laplace(bc=self.bc, args={"t": t})
         result += self.lmbda * state.gradient_squared(bc=self.bc, args={"t": t})
         result.label = "evolution rate"

pde/pdes/kuramoto_sivashinsky.py

@@ -95,7 +95,8 @@
             :class:`~pde.fields.ScalarField`:
             Scalar field describing the evolution rate of the PDE
         """
-        assert isinstance(state, ScalarField), "`state` must be ScalarField"
+        if not isinstance(state, ScalarField):
+            raise ValueError("`state` must be ScalarField")
         state_lap = state.laplace(bc=self.bc, args={"t": t})
         result = (
             -self.nu * state_lap.laplace(bc=self.bc_lap, args={"t": t})

pde/pdes/swift_hohenberg.py

@@ -94,7 +94,8 @@
             :class:`~pde.fields.ScalarField`:
             Scalar field describing the evolution rate of the PDE
         """
-        assert isinstance(state, ScalarField), "`state` must be ScalarField"
+        if not isinstance(state, ScalarField):
+            raise ValueError("`state` must be ScalarField")
         state_laplace = state.laplace(bc=self.bc, args={"t": t})
         state_laplace2 = state_laplace.laplace(bc=self.bc_lap, args={"t": t})
 

pde/pdes/wave.py

@@ -91,8 +91,10 @@
             :class:`~pde.fields.FieldCollection`:
             Fields describing the evolution rates of the PDE
         """
-        assert isinstance(state, FieldCollection), "`state` must be FieldCollection"
-        assert len(state) == 2, "`state` must contain two fields"
+        if not isinstance(state, FieldCollection):
+            raise ValueError("`state` must be FieldCollection")
+        if len(state) != 2:
+            raise ValueError("`state` must contain two fields")
         u, v = state
         u_t = v.copy()
         v_t = self.speed**2 * u.laplace(self.bc, args={"t": t})  # type: ignore

pde/storage/memory.py

@@ -202,7 +202,8 @@
             data (:class:`~numpy.ndarray`): The actual data
             time (float, optional): The time point associated with the data
         """
-        assert data.shape == self.data_shape, f"Data must have shape {self.data_shape}"
+        if data.shape != self.data_shape:
+            raise ValueError(f"Data must have shape {self.data_shape}")
         self.data.append(np.array(data))  # store copy of the data
         self.times.append(time)
 

pde/tools/expressions.py

@@ -876,7 +876,8 @@
                 Whether the compiled function expects all arguments as a single array
                 or whether they are supplied individually.
         """
-        assert isinstance(self._sympy_expr, sympy.Array), "Expression must be an array"
+        if not isinstance(self._sympy_expr, sympy.Array):
+            raise TypeError("Expression must be an array")
         variables = ", ".join(v for v in self.vars)
         shape = self._sympy_expr.shape
 

pde/trackers/interrupts.py

@@ -71,7 +71,8 @@ class FixedInterrupts(InterruptsBase):
 
     def __init__(self, interrupts: np.ndarray | Sequence[float]):
         self.interrupts = np.atleast_1d(interrupts)
-        assert self.interrupts.ndim == 1
+        if self.interrupts.ndim != 1:
+            raise ValueError("`interrupts` must be a 1d sequence")
 
     def __repr__(self):
         return f"{self.__class__.__name__}(interrupts={self.interrupts})"

pde/visualization/plotting.py

@@ -205,7 +205,8 @@
             :class:`~pde.visualization.plotting.ScalarFieldPlot`
         """
         fields = storage[0]
-        assert isinstance(fields, FieldBase), "Storage must contain fields"
+        if not isinstance(fields, FieldBase):
+            raise RuntimeError("Storage must contain fields")
 
         # prepare the data that needs to be plotted
         quantities = cls._prepare_quantities(fields, quantities=quantities, scale=scale)
@@ -393,7 +394,8 @@
                 The title of this view. If `None`, the current title is not
                 changed.
         """
-        assert isinstance(fields, FieldBase), "Fields must inherit from FieldBase"
+        if not isinstance(fields, FieldBase):
+            raise TypeError("`fields` must be of type FieldBase")
 
         if title:
             self.sup_title.set_text(title)
@@ -520,7 +522,8 @@
     """
     if quantities is None:
         fields = storage[0]
-        assert isinstance(fields, FieldBase), "Storage must contain fields"
+        if not isinstance(fields, FieldBase):
+            raise TypeError("`fields` must be of type FieldBase")
         if fields.label:
             label_base = fields.label
         else:

tests/trackers/test_interrupts.py

@@ -113,5 +113,5 @@ def test_interrupt_fixed():
     ival = FixedInterrupts(1)
     assert ival.initialize(0) == pytest.approx(1)
     assert np.isinf(ival.next(0))
-    with pytest.raises(AssertionError):
+    with pytest.raises(ValueError):
         ival = FixedInterrupts([[1]])