Remove ParticleSet.from_list()

Author: VeckoTheGecko

parcels/particleset.py

@@ -341,45 +341,6 @@ def populate_indices(self):
 
             self._data["ei"][:, i] = idx  # assumes that we are in the surface layer (zi=0)
 
-    @classmethod
-    def from_list(cls, fieldset, pclass, lon, lat, depth=None, time=None, lonlatdepth_dtype=None, **kwargs):
-        """Initialise the ParticleSet from lists of lon and lat.
-
-        Parameters
-        ----------
-        fieldset :
-            mod:`parcels.fieldset.FieldSet` object from which to sample velocity
-        pclass :
-            Particle class. May be a parcels.particle.Particle class as defined in parcels, or a subclass defining a custom particle.
-        lon :
-            List of initial longitude values for particles
-        lat :
-            List of initial latitude values for particles
-        depth :
-            Optional list of initial depth values for particles. Default is 0m
-        time :
-            Optional list of start time values for particles. Default is fieldset.U.time[0]
-        repeatdt :
-            Optional interval (in seconds) on which to repeat the release of the ParticleSet (Default value = None)
-        lonlatdepth_dtype :
-            Floating precision for lon, lat, depth particle coordinates.
-            It is either np.float32 or np.float64. Default is np.float32 if fieldset.U.interp_method is 'linear'
-            and np.float64 if the interpolation method is 'cgrid_velocity'
-            Other Variables can be initialised using further arguments (e.g. v=... for a Variable named 'v')
-        **kwargs :
-            Keyword arguments passed to the particleset constructor.
-        """
-        return cls(
-            fieldset=fieldset,
-            pclass=pclass,
-            lon=lon,
-            lat=lat,
-            depth=depth,
-            time=time,
-            lonlatdepth_dtype=lonlatdepth_dtype,
-            **kwargs,
-        )
-
     @classmethod
     def from_particlefile(cls, fieldset, pclass, filename, restart=True, restarttime=None, **kwargs):
         """Initialise the ParticleSet from a zarr ParticleFile.

tests/test_fieldset.py

@@ -343,7 +343,7 @@ def sampleTemp(particle, fieldset, time):  # pragma: no cover
         ]
     )
 
-    pset = ParticleSet.from_list(fieldset, pclass=MyParticle, lon=[0.5], lat=[0.5], depth=[0.5])
+    pset = ParticleSet(fieldset, pclass=MyParticle, lon=[0.5], lat=[0.5], depth=[0.5])
     pset.execute(
         AdvectionRK4_3D + pset.Kernel(sampleTemp), runtime=timedelta(hours=51), dt=timedelta(hours=dt_sign * 1)
     )

tests/test_particlesets.py

@@ -32,7 +32,7 @@ def test_pset_create_list_with_customvariable(fieldset):
     MyParticle = Particle.add_variable("v")
 
     v_vals = np.arange(npart)
-    pset = ParticleSet.from_list(fieldset, lon=lon, lat=lat, v=v_vals, pclass=MyParticle)
+    pset = ParticleSet(fieldset, lon=lon, lat=lat, v=v_vals, pclass=MyParticle)
     assert np.allclose([p.lon for p in pset], lon, rtol=1e-12)
     assert np.allclose([p.lat for p in pset], lat, rtol=1e-12)
     assert np.allclose([p.v for p in pset], v_vals, rtol=1e-12)
@@ -127,7 +127,7 @@ def test_pset_create_with_time(fieldset):
     time = 5.0
     pset = ParticleSet(fieldset, lon=lon, lat=lat, pclass=Particle, time=time)
     assert np.allclose([p.time for p in pset], time, rtol=1e-12)
-    pset = ParticleSet.from_list(fieldset, lon=lon, lat=lat, pclass=Particle, time=[time] * npart)
+    pset = ParticleSet(fieldset, lon=lon, lat=lat, pclass=Particle, time=[time] * npart)
     assert np.allclose([p.time for p in pset], time, rtol=1e-12)
     pset = ParticleSet.from_line(fieldset, size=npart, start=(0, 1), finish=(1, 0), pclass=Particle, time=time)
     assert np.allclose([p.time for p in pset], time, rtol=1e-12)

tests/v4/test_structured_gcm.py

@@ -12,6 +12,6 @@ def test_fieldset_frompop():
     # dimensions = {"lon": "lon", "lat": "lat", "time": "time"}
 
     # fieldset = FieldSet.from_pop(filenames, variables, dimensions, mesh="flat")
-    # pset = ParticleSet.from_list(fieldset, Particle, lon=[3, 5, 1], lat=[3, 5, 1])
+    # pset = ParticleSet(fieldset, Particle, lon=[3, 5, 1], lat=[3, 5, 1])
     # pset.execute(AdvectionRK4, runtime=3, dt=1)
     pass

v3to4-breaking-changes.md

@@ -13,4 +13,4 @@ ParticleSet
 
 - ParticleSet init had repeatdt removed
 - ParticleSet.execute() expects `numpy.datetime64`/`numpy.timedelta.64` for `runtime`, `endtime` and `dt`
-- `ParticleSet.from_field()`, `ParticleSet.from_line()` has been removed
+- `ParticleSet.from_field()`, `ParticleSet.from_line()`, `ParticleSet.from_list()` has been removed