ErrorCode -- deprecated?

[TomMBIO]

Question

Question

Good afternoon!

I am trying to incorporate ErrorCode into my runs to delete stuck particles, but unfortunately I am not able to import it:

Has this function since been deprecated? For reference, I am adding it to my particleset in this way:

Execute simulation

pset.execute(
    kernels,
    runtime=datetime.timedelta(days=180),
    dt=datetime.timedelta(minutes=60),
    recovery={ErrorCode.ErrorOutOfBounds: DeleteParticle, 
                    ErrorCode.ErrorInterpolation: DeleteParticle},
    output_file=output_file
)

Thank you very much for your time,

Tom

Supporting code/error messages

from parcels import (
    AdvectionRK4,
    DiffusionUniformKh,
    FieldSet,
    JITParticle,
    ParticleSet,
    Variable,
    Field,
    VectorField,
    ErrorCode,
)

ImportError                               Traceback (most recent call last)
Cell In[14], line 15
     12 from matplotlib.animation import FuncAnimation
     13 from matplotlib.lines import Line2D
---> 15 from parcels import (
     16     AdvectionRK4,
     17     DiffusionUniformKh,
     18     FieldSet,
     19     JITParticle,
     20     ParticleSet,
     21     Variable,
     22     Field,
     23     VectorField,
     24     ErrorCode,
     25 )
     27 import netCDF4 as nc
     28 import numpy as np

ImportError: cannot import name 'ErrorCode' from 'parcels' (C:\Users\benth\anaconda3\envs\parcels\Lib\site-packages\parcels\__init__.py)

[VeckoTheGecko]

Hi @TomMBIO . Looks like you're using code from an older version of Parcels. Error codes are now directly supported in Kernels (no need to do recovery=...) . This is shown in the Kernel Loop tutorial https://docs.oceanparcels.org/en/latest/examples/tutorial_kernelloop.html . Could you follow this and see how you go?

Also, ErrorCode is called StatusCode now.

[wlush]

Hi @TomMBIO and @VeckoTheGecko - I came to this conversation a bit late, so I'll just link the relevant section of the kernel loop tutorial: https://docs.oceanparcels.org/en/latest/examples/tutorial_kernelloop.html#Working-with-Status-Codes

[TomMBIO]

Hi both,

Thanks for your timely responses,

I've incorporated the CheckOutOfBounds kernel suggested in the above link and am now running a test run. I'll let you know if I run into any issues.

Just for clarification, once a particle is deleted by this function, the preceding trajectory information is retained, right?

Kind regards,
Tom