Merge branch '1861-rename-particle' of github.com:OceanParcels/Parcels into 1861-rename-particle

fluidnumerics-joe · fluidnumerics-joe · commit e21a940395c9 · 2025-02-21T16:19:50.000-05:00
diff --git a/docs/examples/example_nemo_curvilinear.py b/docs/examples/example_nemo_curvilinear.py
@@ -48,9 +48,7 @@ def periodicBC(particle, fieldSet, time):  # pragma: no cover
         if particle.lon > 180:
             particle_dlon -= 360  # noqa
 
-    pset = parcels.ParticleSet.from_list(
-        fieldset, parcels.Particle, lon=lonp, lat=latp
-    )
+    pset = parcels.ParticleSet.from_list(fieldset, parcels.Particle, lon=lonp, lat=latp)
     pfile = parcels.ParticleFile(outfile, pset, outputdt=timedelta(days=1))
     kernels = pset.Kernel(advection[advtype]) + periodicBC
     pset.execute(kernels, runtime=runtime, dt=timedelta(hours=6), output_file=pfile)
diff --git a/docs/examples/tutorial_analyticaladvection.ipynb b/docs/examples/tutorial_analyticaladvection.ipynb
@@ -14863,9 +14863,7 @@
    "source": [
     "X, Y = np.meshgrid(np.arange(0, 19900, 100), np.arange(-100, 100, 100))\n",
     "\n",
-    "psetAA = parcels.ParticleSet(\n",
-    "    fieldsetBJ, pclass=parcels.Particle, lon=X, lat=Y, time=0\n",
-    ")\n",
+    "psetAA = parcels.ParticleSet(fieldsetBJ, pclass=parcels.Particle, lon=X, lat=Y, time=0)\n",
     "\n",
     "output = psetAA.ParticleFile(name=\"bickleyjetAA.zarr\", outputdt=timedelta(hours=1))\n",
     "\n",
diff --git a/docs/examples/tutorial_nemo_curvilinear.ipynb b/docs/examples/tutorial_nemo_curvilinear.ipynb
@@ -177,9 +177,7 @@
     "lonp = -180 * np.ones(npart)\n",
     "latp = [i for i in np.linspace(-70, 85, npart)]\n",
     "\n",
-    "pset = parcels.ParticleSet.from_list(\n",
-    "    fieldset, parcels.Particle, lon=lonp, lat=latp\n",
-    ")\n",
+    "pset = parcels.ParticleSet.from_list(fieldset, parcels.Particle, lon=lonp, lat=latp)\n",
     "pfile = parcels.ParticleFile(\"nemo_particles\", pset, outputdt=timedelta(days=1))\n",
     "\n",
     "pset.execute(\n",
@@ -237,9 +235,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "pset = parcels.ParticleSet.from_list(\n",
-    "    fieldset, parcels.Particle, lon=lonp, lat=latp\n",
-    ")\n",
+    "pset = parcels.ParticleSet.from_list(fieldset, parcels.Particle, lon=lonp, lat=latp)\n",
     "pset.populate_indices()"
    ]
   }
diff --git a/docs/examples/tutorial_particle_field_interaction.ipynb b/docs/examples/tutorial_particle_field_interaction.ipynb
@@ -152,9 +152,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "VectorParticle = parcels.Particle.add_variable(\n",
-    "    \"c\", dtype=np.float32, initial=100.0\n",
-    ")\n",
+    "VectorParticle = parcels.Particle.add_variable(\"c\", dtype=np.float32, initial=100.0)\n",
     "\n",
     "\n",
     "def Interaction(particle, fieldset, time):\n",
diff --git a/docs/examples/tutorial_timevaryingdepthdimensions.ipynb b/docs/examples/tutorial_timevaryingdepthdimensions.ipynb
@@ -127,9 +127,7 @@
     }
    ],
    "source": [
-    "pset = parcels.ParticleSet(\n",
-    "    fieldset, parcels.Particle, lon=9.5, lat=12.5, depth=-0.1\n",
-    ")\n",
+    "pset = parcels.ParticleSet(fieldset, parcels.Particle, lon=9.5, lat=12.5, depth=-0.1)\n",
     "\n",
     "pfile = pset.ParticleFile(\"SwashParticles\", outputdt=timedelta(seconds=0.05))\n",
     "\n",
diff --git a/tests/test_advection.py b/tests/test_advection.py
@@ -15,8 +15,8 @@
     AdvectionRK45,
     Field,
     FieldSet,
-    ParticleSet,
     Particle,
+    ParticleSet,
     StatusCode,
     Variable,
 )
diff --git a/tests/test_diffusion.py b/tests/test_diffusion.py
@@ -10,9 +10,9 @@
     AdvectionDiffusionM1,
     DiffusionUniformKh,
     Field,
+    Particle,
     ParticleSet,
     RectilinearZGrid,
-    Particle,
 )
 from tests.utils import create_fieldset_zeros_conversion
 
diff --git a/tests/test_fieldset.py b/tests/test_fieldset.py
@@ -8,8 +8,8 @@
     AdvectionRK4,
     AdvectionRK4_3D,
     FieldSet,
-    ParticleSet,
     Particle,
+    ParticleSet,
     Variable,
 )
 from parcels.field import Field, VectorField
diff --git a/tests/test_fieldset_sampling.py b/tests/test_fieldset_sampling.py
@@ -13,8 +13,8 @@
     FieldSet,
     Geographic,
     NestedField,
-    ParticleSet,
     Particle,
+    ParticleSet,
     StatusCode,
     Variable,
 )
diff --git a/tests/test_grids.py b/tests/test_grids.py
@@ -11,10 +11,10 @@
     CurvilinearZGrid,
     Field,
     FieldSet,
+    Particle,
     ParticleSet,
     RectilinearSGrid,
     RectilinearZGrid,
-    Particle,
     StatusCode,
     UnitConverter,
     Variable,
diff --git a/tests/test_interpolation.py b/tests/test_interpolation.py
@@ -3,7 +3,7 @@
 import xarray as xr
 
 import parcels._interpolation as interpolation
-from parcels import AdvectionRK4_3D, FieldSet, ParticleSet, Particle
+from parcels import AdvectionRK4_3D, FieldSet, Particle, ParticleSet
 from tests.utils import TEST_DATA, create_fieldset_zeros_3d
 
 
diff --git a/tests/test_kernel_execution.py b/tests/test_kernel_execution.py
@@ -8,8 +8,8 @@
     AdvectionRK4,
     FieldOutOfBoundError,
     FieldSet,
-    ParticleSet,
     Particle,
+    ParticleSet,
     StatusCode,
 )
 from tests.common_kernels import DeleteParticle, DoNothing, MoveEast, MoveNorth
@@ -121,9 +121,7 @@ def PythonFail(particle, fieldset, time):  # pragma: no cover
         else:
             pass
 
-    pset = ParticleSet(
-        fieldset_unit_mesh, pclass=Particle, lon=np.linspace(0, 1, npart), lat=np.linspace(1, 0, npart)
-    )
+    pset = ParticleSet(fieldset_unit_mesh, pclass=Particle, lon=np.linspace(0, 1, npart), lat=np.linspace(1, 0, npart))
     with pytest.raises(RuntimeError):
         pset.execute(PythonFail, endtime=20.0, dt=2.0)
     assert len(pset) == npart
@@ -138,9 +136,7 @@ def MoveRight(particle, fieldset, time):  # pragma: no cover
         tmp1, tmp2 = fieldset.UV[time, particle.depth, particle.lat, particle.lon + 0.1, particle]
         particle_dlon += 0.1  # noqa
 
-    pset = ParticleSet(
-        fieldset_unit_mesh, pclass=Particle, lon=np.linspace(0, 1, npart), lat=np.linspace(1, 0, npart)
-    )
+    pset = ParticleSet(fieldset_unit_mesh, pclass=Particle, lon=np.linspace(0, 1, npart), lat=np.linspace(1, 0, npart))
     with pytest.raises(FieldOutOfBoundError):
         pset.execute(MoveRight, endtime=10.0, dt=1.0)
     assert len(pset) == npart
diff --git a/tests/test_kernel_language.py b/tests/test_kernel_language.py
@@ -8,8 +8,8 @@
     Field,
     FieldSet,
     Kernel,
-    ParticleSet,
     Particle,
+    ParticleSet,
     Variable,
 )
 from parcels.application_kernels.EOSseawaterproperties import (
diff --git a/tests/test_particlefile.py b/tests/test_particlefile.py
@@ -13,8 +13,8 @@
     AdvectionRK4,
     Field,
     FieldSet,
-    ParticleSet,
     Particle,
+    ParticleSet,
     Variable,
 )
 from parcels.particlefile import _set_calendar
@@ -228,9 +228,7 @@ def IncrLon(particle, fieldset, time):  # pragma: no cover
 @pytest.mark.parametrize("nump", [1, 10])
 def test_pfile_chunks_repeatedrelease(fieldset, repeatdt, nump, tmp_zarrfile):
     runtime = 8
-    pset = ParticleSet(
-        fieldset, pclass=Particle, lon=np.zeros((nump, 1)), lat=np.zeros((nump, 1)), repeatdt=repeatdt
-    )
+    pset = ParticleSet(fieldset, pclass=Particle, lon=np.zeros((nump, 1)), lat=np.zeros((nump, 1)), repeatdt=repeatdt)
     chunks = (20, 10)
     pfile = pset.ParticleFile(tmp_zarrfile, outputdt=1, chunks=chunks)
 
diff --git a/tests/test_particles.py b/tests/test_particles.py
@@ -5,8 +5,8 @@
 
 from parcels import (
     AdvectionRK4,
-    ParticleSet,
     Particle,
+    ParticleSet,
     Variable,
 )
 from tests.utils import create_fieldset_zeros_unit_mesh
diff --git a/tests/test_particlesets.py b/tests/test_particlesets.py
@@ -5,9 +5,9 @@
     CurvilinearZGrid,
     Field,
     FieldSet,
+    Particle,
     ParticleSet,
     ParticleSetWarning,
-    Particle,
     StatusCode,
     Variable,
 )
@@ -239,9 +239,7 @@ def test_pset_access(fieldset):
 
 def test_pset_custom_ptype(fieldset):
     npart = 100
-    TestParticle = Particle.add_variable(
-        [Variable("p", np.float32, initial=0.33), Variable("n", np.int32, initial=2)]
-    )
+    TestParticle = Particle.add_variable([Variable("p", np.float32, initial=0.33), Variable("n", np.int32, initial=2)])
 
     pset = ParticleSet(fieldset, pclass=TestParticle, lon=np.linspace(0, 1, npart), lat=np.linspace(1, 0, npart))
     assert pset.size == npart
@@ -255,9 +253,7 @@ def test_pset_add_explicit(fieldset):
     lat = np.linspace(1, 0, npart)
     pset = ParticleSet(fieldset, lon=[], lat=[], pclass=Particle, lonlatdepth_dtype=np.float64)
     for i in range(npart):
-        particle = ParticleSet(
-            pclass=Particle, lon=lon[i], lat=lat[i], fieldset=fieldset, lonlatdepth_dtype=np.float64
-        )
+        particle = ParticleSet(pclass=Particle, lon=lon[i], lat=lat[i], fieldset=fieldset, lonlatdepth_dtype=np.float64)
         pset.add(particle)
     assert pset.size == npart
     assert np.allclose([p.lon for p in pset], lon, rtol=1e-12)
diff --git a/tests/tools/test_warnings.py b/tests/tools/test_warnings.py
@@ -10,9 +10,9 @@
     FieldSet,
     FieldSetWarning,
     KernelWarning,
+    Particle,
     ParticleSet,
     ParticleSetWarning,
-    Particle,
 )
 from tests.utils import TEST_DATA
 
