Skip to content

Commit 5db395b

Browse files
committed
require dt argument in ParticleSet.execute()
1 parent b03aa97 commit 5db395b

File tree

1 file changed

+4
-7
lines changed

1 file changed

+4
-7
lines changed

parcels/_core/particleset.py

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -452,10 +452,10 @@ def set_variable_write_status(self, var, write_status):
452452

453453
def execute(
454454
self,
455+
dt: datetime.timedelta | np.timedelta64,
455456
pyfunc=AdvectionRK4,
456457
endtime: np.timedelta64 | np.datetime64 | None = None,
457458
runtime: datetime.timedelta | np.timedelta64 | None = None,
458-
dt: datetime.timedelta | np.timedelta64 | None = None,
459459
output_file=None,
460460
verbose_progress=True,
461461
):
@@ -466,6 +466,9 @@ def execute(
466466
467467
Parameters
468468
----------
469+
dt (np.timedelta64):
470+
Timestep interval (as a np.timedelta64 object) to be passed to the kernel.
471+
Use a negative value for a backward-in-time simulation.
469472
pyfunc :
470473
Kernel function to execute. This can be the name of a
471474
defined Python function or a :class:`parcels.kernel.Kernel` object.
@@ -477,9 +480,6 @@ def execute(
477480
runtime (np.timedelta64):
478481
The duration of the simuulation execution. Must be a np.timedelta64 object and is required to be set when the `fieldset.time_interval` is not defined.
479482
If the `fieldset.time_interval` is defined and the runtime is provided, the end time will be the start of the fieldset's time interval plus the runtime.
480-
dt (np.timedelta64):
481-
Timestep interval (as a np.timedelta64 object) to be passed to the kernel.
482-
Use a negative value for a backward-in-time simulation. (Default value = 1 second)
483483
output_file :
484484
mod:`parcels.particlefile.ParticleFile` object for particle output (Default value = None)
485485
verbose_progress : bool
@@ -502,9 +502,6 @@ def execute(
502502
output_file.set_metadata(self.fieldset.gridset[0]._mesh)
503503
output_file.metadata["parcels_kernels"] = self._kernel.funcname
504504

505-
if dt is None:
506-
dt = np.timedelta64(1, "s")
507-
508505
try:
509506
dt = maybe_convert_python_timedelta_to_numpy(dt)
510507
assert not np.isnat(dt)

0 commit comments

Comments
 (0)