Removing write_latest_location

As not necessary anymore now that the last time is written to file

Author: erikvansebille

docs/examples_v3/tutorial_kernelloop.ipynb

@@ -257,13 +257,7 @@
     "### 2. Be careful with updating particle variables that do not depend on Fields.\n",
     "While assigning the interpolated value of a `Field` to a Particle goes well in the loop above, this is not necessarily so for assigning other attributes. For example, a line like `particle.age += particle.dt` is executed directly so may result in the age being `dt` at `time = 0` in the output file. \n",
     "\n",
-    "A workaround is to either initialise the age to `-dt`, or to increase the `age` only when `particle.time > 0` (using an `np.where` statement).\n",
-    "\n",
-    "\n",
-    "### 3. The last time is not written to file\n",
-    "Because the location at the start of the loop is written at the end of the Kernel loop, the last `particle.time` of the particle is not written to file. This is similar behaviour to e.g. `np.arange(start, stop)`, which also doesn't include the `stop` value itself. \n",
-    "\n",
-    "If you do want to write the last time to file, you can increase the `runtime` or `endtime` by `dt` (although this may cause a TimeExtrapolationError if your run was to the end of the available hydrodynamic data), or you can call `pfile.write_latest_locations(pset, time=pset[0].time+pset[0].dt)`. Note that in the latter case, the particle locations (longitude, latitude and z) will be updated, but other variables will _not_ be updated as the Kernels are not run again."
+    "A workaround is to either initialise the age to `-dt`, or to increase the `age` only when `particle.time > 0` (using an `np.where` statement)."
    ]
   },
   {

src/parcels/_core/particlefile.py

@@ -242,23 +242,6 @@ def _write_particle_data(self, *, particle_data, pclass, time_interval, time, in
 
         particle_data["obs_written"][indices_to_write] = obs + 1
 
-    def write_latest_locations(self, pset, time):
-        """Write the current (latest) particle locations to zarr file.
-        This can be useful at the end of a pset.execute(), when the last locations are not written yet.
-        Note that this only updates the locations, not any of the other Variables. Therefore, use with care.
-
-        Parameters
-        ----------
-        pset :
-            ParticleSet object to write
-        time :
-            Time at which to write ParticleSet. Note that typically this would be pset.time + pset.dt
-        """
-        for var in ["lon", "lat", "z"]:
-            pset._data[f"{var}"] += pset._data[f"d{var}"]
-        pset._data["time"] += pset._data["dt"]
-        self.write(pset, time)
-
 
 def _get_store_from_pathlike(path: Path | str) -> DirectoryStore:
     path = str(Path(path))  # Ensure valid path, and convert to string