Fixed Droplet.from_volume method. (#83)

Fixed some type issues

Author: david-zwicker

droplets/droplet_tracks.py

@@ -48,7 +48,7 @@ def contiguous_true_regions(condition: np.ndarray) -> np.ndarray:
         is the start index of the region and the second column is the end index
     """
     if len(condition) == 0:
-        return np.empty((0, 2), dtype=np.intc)
+        return np.empty((0, 2), dtype=np.intc)  # type: ignore
 
     # convert condition array to integer
     condition = np.asarray(condition, np.intc)
@@ -294,7 +294,7 @@ def _from_hdf_dataset(cls, dataset) -> DropletTrack:
             times = dataset["time"]
             droplet_data = rfn.rec_drop_fields(dataset, "time")
             for time, data in zip(times, droplet_data):
-                droplet = droplet_from_data(droplet_class, data)  # type: ignore
+                droplet = droplet_from_data(droplet_class, data)
                 obj.append(droplet, time=time)  # type: ignore
 
         return obj

droplets/droplets.py

@@ -300,20 +300,21 @@ def data_bounds(self) -> tuple[np.ndarray, np.ndarray]:
         return l, h
 
     @classmethod
-    def from_volume(cls, position: np.ndarray, volume: float):
-        """Construct a droplet from given volume instead of radius.
+    def from_volume(cls, position: np.ndarray, volume: float, **kwargs):
+        r"""Construct a droplet from given volume instead of radius.
 
         Args:
             position (:class:`~numpy.ndarray`):
                 Center of the droplet
             volume (float):
                 Volume of the droplet
-            interface_width (float, optional):
-                Width of the interface
+            \**kwargs:
+                Additional arguments are forwarded to the class initializer. This can
+                for instance be used to set the interfacial width.
         """
         dim = len(np.array(position, np.double, ndmin=1))
         radius = spherical.radius_from_volume(volume, dim)
-        return cls(position, radius)
+        return cls(position, radius, **kwargs)
 
     @property
     def position(self) -> np.ndarray:
@@ -781,7 +782,7 @@ def data_bounds(self) -> tuple[np.ndarray, np.ndarray]:
     @property
     def modes(self) -> int:
         """int: number of perturbation modes"""
-        shape = self.data.dtype.fields["amplitudes"][0].shape
+        shape = self.data.dtype.fields["amplitudes"][0].shape  # type: ignore
         return int(shape[0]) if shape else 1
 
     @property

pyproject.toml

@@ -120,7 +120,6 @@ omit = ['*/test*']
 
 [tool.mypy]
 python_version = "3.9"
-plugins = "numpy.typing.mypy_plugin"
 warn_return_any = true
 warn_unused_configs = true
 warn_unused_ignores = true

tests/test_droplets.py

@@ -62,6 +62,12 @@ def test_perturbed_droplet_2d():
     d.interface_position(0.1)
     d.interface_curvature(0.1)
 
+    d = droplets.PerturbedDroplet2D.from_volume(
+        [0, 1], 10, interface_width=0.1, amplitudes=[0.0, 0.1, 0.2]
+    )
+    assert d.volume == pytest.approx(10, 0.1)
+    assert d.interface_width == pytest.approx(0.1)
+
 
 def test_perturbed_droplet_3d():
     """Test methods of perturbed droplets in 3d."""