Cleanup skipped and xfailed unittests

docs/user_guide/examples/tutorial_schism.ipynb

@@ -26,7 +26,7 @@
     "1. The mesh coordinates are in a **projected coordinate system (meters)**, not longitude/latitude, so\n",
     "   we build the grid as a *flat* (Cartesian) mesh.\n",
     "2. Velocities are stored at **mesh nodes** over a vertical column of layers, ordered **bottom → surface**.\n",
-    "3. SCHISM uses a **localized vertical grid (LSC2)**: the number of valid vertical levels varies from\n",
+    "3. SCHISM uses a **localised vertical grid (LSC2)**: the number of valid vertical levels varies from\n",
     "   node to node, and levels below the seabed are stored as `NaN`. We use this to flag particles that\n",
     "   end up below the local bathymetry and stop advecting them.\n",
     "\n",
@@ -147,7 +147,7 @@
     "\n",
     "* **Layer ordering.** SCHISM stores levels **bottom → surface**, while Parcels expects depth increasing\n",
     "  downward from the surface, so we reverse the layer axis.\n",
-    "* **Vertical coordinate.** SCHISM's LSC2 vertical grid (*Localized Sigma Coordinates with Shaved\n",
+    "* **Vertical coordinate.** SCHISM's LSC2 vertical grid (*Localised Sigma Coordinates with Shaved\n",
     "  cells*) varies with horizontal position: each node has its own layer depths, and even its own\n",
     "  *number* of levels (the true depths are written to a separate `zCoordinates` output, not used here).\n",
     "  **Parcels does not currently support a vertical grid that varies with lateral position.** `UxGrid`\n",

src/parcels/_core/fieldset.py

@@ -70,12 +70,12 @@ def __init__(self, models: list[ModelData]):
         for model in models:
             if not isinstance(model, ModelData):
                 raise ValueError(f"Expected `model` to be a ModelData object. Got {model}")
-        # assert_compatible_calendars(fields)
 
         self.models = models
         self.constant_model: StructuredModelData | None = None
         self._fields: dict[str, Field | VectorField] | None = None
         self.reconstruct_fields()
+        assert_compatible_calendars(self.fields.values())
         self.context: dict[str, float] = {}
         assert_models_have_same_mesh(self.models)
 

src/parcels/_core/model.py

@@ -20,7 +20,7 @@
 from parcels._core.xgrid import (
     XGrid,
     _transpose_xfield_data_to_tzyx,
-    assert_all_field_dims_have_axis,  # noqa: F401, leave import for now until decision is made # TODO v4: Make decision
+    assert_all_field_dims_have_axis,
 )
 from parcels._logger import logger
 from parcels._python import NOTSET, NotSetType
@@ -167,6 +167,8 @@ def validate_field_data(ds: xr.Dataset) -> xr.Dataset:
 
 
 class StructuredModelData(ModelData):
+    grid: XGrid
+
     def __init__(
         self,
         data: xr.Dataset,
@@ -190,7 +192,7 @@ def __init__(
         self.assert_valid_model_data()
 
     def assert_valid_field_data(self, field_data: xr.DataArray) -> None:
-        # assert_all_field_dims_have_axis(field_data, self.grid.xgcm_grid) #! TODO v4: These checks should be revisited
+        assert_all_field_dims_have_axis(field_data, self.grid.sgrid_metadata)
         _assert_has_time_coordinate(field_data)
 
     @property

src/parcels/_core/particlefile.py

@@ -166,18 +166,20 @@ def write(self, pset: ParticleSet | ParticleSetView, t, indices=None):
             )
 
         if isinstance(t, (np.timedelta64, np.datetime64)):
-            print(t)
             if self._time_interval is None:
                 raise ValueError(
                     "The time interval is unknown, so datetime/timedelta times cannot be converted. "
                     "Pass the ParticleFile to ParticleSet.execute() or call set_time_interval() first."
                 )
             t = timedelta_to_float(t - self._time_interval.left)
         vars_to_write = _get_vars_to_write(pclass)
-        if indices is None:
-            indices_to_write = _to_write_particles(particle_data, t)
-        else:
+        if indices is not None:
             indices_to_write = indices
+        elif isinstance(pset, ParticleSetView):
+            # A view already selects the particles to write, so `t` is not used to filter
+            indices_to_write = np.flatnonzero(pset._index)
+        else:
+            indices_to_write = _to_write_particles(particle_data, t)
 
         self._writer.write_table(
             pa.table({v.name: pa.array(particle_data[v.name][indices_to_write]) for v in vars_to_write}),

src/parcels/_core/xgrid.py

@@ -47,7 +47,8 @@ def _drop_field_data(ds: xr.Dataset) -> xr.Dataset:
 
 
 def assert_all_field_dims_have_axis(da: xr.DataArray, metadata: sgrid.SGrid2DMetadata) -> None:
-    dim_to_axis = _get_dim_to_axis_mapping(metadata) | {"time": "T"}
+    mock_dim_to_axis = {f"mock{ax}": ax for ax in _FIELD_DATA_ORDERING}
+    dim_to_axis = _get_dim_to_axis_mapping(metadata) | {"time": "T"} | mock_dim_to_axis
     ax_dims = [(dim_to_axis.get(str(dim)), str(dim)) for dim in da.dims]
 
     for ax, dim_name in ax_dims:
@@ -102,6 +103,7 @@ def _transpose_xfield_data_to_tzyx(da: xr.DataArray, sgrid_metadata: sgrid.SGrid
 
     if mock_dims_to_create:
         da = da.expand_dims(mock_dims_to_create, create_index_for_new_dim=False)
+        da = da.assign_coords({dim: (dim, [0], {"axis": dim_to_axis[dim]}) for dim in mock_dims_to_create})
 
     ax_dims = sorted(dim_to_axis.items(), key=lambda x: _FIELD_DATA_ORDERING.index(x[1]))
 
@@ -256,9 +258,9 @@ def get_axis_dim(self, axis: ptyping.XgridAxis) -> int:
         assert self.sgrid_metadata.vertical_dimensions is not None
         return get_cell_count_along_dim(self._ds, self.sgrid_metadata.vertical_dimensions[0])
 
-    def localize(
-        self, position: dict[ptyping.XgridAxis, tuple[int, float]], dims: list[str]
-    ) -> dict[str, tuple[int, float]]:
+    def localise(
+        self, position: dict[ptyping.XgridAxis, dict[str, np.ndarray]], dims: list[str]
+    ) -> dict[str, dict[str, np.ndarray]]:
         """
         Uses the grid context (i.e., the staggering of the grid) to convert a position relative
         to the f-points in the grid to a position relative to the staggered grid the array
@@ -271,24 +273,28 @@ def localize(
         Parameters
         ----------
         position : dict
-            A mapping of the axis to a tuple of (index, barycentric coordinate) for the
-            f-points in the grid.
+            A mapping of the axis to a dict with the arrays ``"index"`` and ``"bcoord"`` (barycentric
+            coordinate) for the f-points in the grid, as returned by ``search``.
         dims : list[str]
             A list of dimension names that the DataArray is defined on. This is used to determine
             the staggering of the grid and which axis each dimension corresponds to.
 
         Returns
         -------
-        dict[str, tuple[int, float]]
-            A mapping of the dimension names to a tuple of (index, barycentric coordinate) for
+        dict[str, dict[str, np.ndarray]]
+            A mapping of the dimension names to a dict with the arrays ``"index"`` and ``"bcoord"`` for
             the staggered grid the DataArray is defined on.
 
         Example
         -------
-        >>> position = {"X": (5, 0.51), "Y": (10, 0.25), "Z": (3, 0.75)}
+        >>> position = {
+        ...     "X": {"index": np.array([5]), "bcoord": np.array([0.51])},
+        ...     "Y": {"index": np.array([10]), "bcoord": np.array([0.25])},
+        ...     "Z": {"index": np.array([3]), "bcoord": np.array([0.75])},
+        ... }
         >>> dims = ["time", "depth", "YC", "XC"]
-        >>> grid.localize(position, dims)
-        {'depth': (3, 0.75), 'YC': (9, 0.75), 'XC': (5, 0.01)}
+        >>> grid.localise(position, dims)
+        {'depth': {'index': array([3]), 'bcoord': array([0.75])}, 'YC': {'index': array([9]), 'bcoord': array([0.75])}, 'XC': {'index': array([5]), 'bcoord': array([0.01])}}
         """
         dim_to_axis = _get_dim_to_axis_mapping(self.sgrid_metadata)
         axis_to_var = {dim_to_axis[dim]: dim for dim in dims if dim in dim_to_axis}
@@ -297,12 +303,13 @@ def localize(
         }
         return {
             axis_to_var[axis]: _convert_center_pos_to_fpoint(
-                index=index,
-                bcoord=bcoord,
+                index=pos["index"],
+                bcoord=pos["bcoord"],
                 position=var_positions[axis],
                 f_point_position=self._fpoint_info[axis],
             )
-            for axis, (index, bcoord) in position.items()
+            for axis, pos in position.items()
+            if axis in axis_to_var
         }
 
     @property
@@ -591,29 +598,29 @@ def assert_valid_depth(da_depth):
 
 def _convert_center_pos_to_fpoint(
     *,
-    index: int,
-    bcoord: float,
+    index: np.ndarray,
+    bcoord: np.ndarray,
     position: ptyping.GridPosition,
     f_point_position: sgrid.Padding,
-) -> tuple[int, float]:
+) -> dict[str, np.ndarray]:
     """Converts a physical position relative to the cell edges defined in the grid to be relative to the face center.
 
-    This is used to "localize" a position to be relative to the staggered grid at which the field is defined, so that
+    This is used to "localise" a position to be relative to the staggered grid at which the field is defined, so that
     it can be easily interpolated.
 
     This also handles different model input cell edges and centers are staggered in different directions (e.g., with NEMO and MITgcm).
     """
     if position != "face":  # Data is already defined on the F nodes
-        return index, bcoord
+        return {"index": index, "bcoord": bcoord}
 
     bcoord = bcoord - 0.5
-    if bcoord < 0:
-        bcoord += 1.0
-        index -= 1
+    wrapped = bcoord < 0
+    bcoord = np.where(wrapped, bcoord + 1.0, bcoord)
+    index = np.where(wrapped, index - 1, index)
 
     # Correct relative to the f-point position
     # Padding.BOTH was "inner", Padding.LOW was "right" in xgcm vocabulary
     if f_point_position in (sgrid.Padding.BOTH, sgrid.Padding.LOW):
-        index += 1
+        index = index + 1
 
-    return index, bcoord
+    return {"index": index, "bcoord": bcoord}

src/parcels/_repr_utils.py

@@ -104,7 +104,7 @@ def particleset_repr(pset: ParticleSet) -> str:
 
 def particlesetview_repr(pview: Any) -> str:
     """Return a pretty repr for ParticleSetView"""
-    time_string = "not_yet_set" if pview.time is None or np.isnan(pview.time) else f"{pview.time:f}"
+    time_string = "not_yet_set" if pview.t is None or np.isnan(pview.t) else f"{pview.t:f}"
     out = f"P[{pview.particle_id}]: time={time_string}, z={pview.z:f}, y={pview.y:f}, x={pview.x:f}"
     vars = [v.name for v in pview._pclass.variables if v.to_write is True and v.name not in ["z", "y", "x", "time"]]
     for var in vars:

tests/test_field.py

@@ -2,6 +2,7 @@
 
 import numpy as np
 import pytest
+import xarray as xr
 from re_assert import Matches
 
 from parcels import Field, VectorField
@@ -82,7 +83,16 @@ def test_field_time_interval():
 
 def test_vectorfield_init_different_time_intervals():
     # Tests that a VectorField raises a ValueError if the component fields have different time domains.
-    ...
+    dsU = simple_UV_dataset(mesh_str="flat")[["U", "grid"]]
+    dsV = simple_UV_dataset(mesh_str="flat")[["V"]]
+
+    dsV = dsV.rename({"time": "timeV"})
+    dsV["timeV"] = dsV["timeV"] + np.timedelta64(1, "D")
+    dsV["timeV"].attrs["axis"] = "T"
+
+    ds = xr.merge([dsU, dsV])
+    with pytest.raises(ValueError, match="Multiple time coordinates"):
+        FieldSet.from_sgrid_conventions(ds)
 
 
 def test_field_invalid_interpolator():
@@ -242,15 +252,3 @@ def test_field_eval_out_of_bounds_unstructured(field_name, location, expected):
         match="Some interpolated values are out-of-bounds. These values are set to 0. Treat carefully.",
     ):
         np.testing.assert_allclose(field.eval(*location), expected)
-
-
-def test_field_unstructured_grid_creation(): ...
-
-
-def test_field_interpolation(): ...
-
-
-def test_field_interpolation_out_of_spatial_bounds(): ...
-
-
-def test_field_interpolation_out_of_time_bounds(): ...

tests/test_fieldset.py

@@ -13,7 +13,7 @@
 import parcels.tutorial
 import tests
 from parcels import Particle, ParticleFile, ParticleSet, Variable, convert
-from parcels._core.fieldset import FieldSet, IncompatibleMeshesException, _datetime_to_msg
+from parcels._core.fieldset import CalendarError, FieldSet, IncompatibleMeshesException, _datetime_to_msg
 from parcels._core.mesh import SphericalMesh
 from parcels._core.model import _default_vector_field_components, _infer_mesh_from_sgrid_data
 from parcels._core.utils.time import TimeInterval
@@ -273,7 +273,16 @@ def test_multi_model_nonoverlapping_time_interval():
 
 def test_fieldset_add_incompatible_calendars():
     # tests the adding of fieldsets that have incompatible calendars
-    ...
+    ds1 = datasets_structured["ds_2d_left"][["U_A_grid", "V_A_grid", "grid"]]
+    fieldset = FieldSet.from_sgrid_conventions(ds1)
+
+    ds2 = ds1.copy().rename({"U_A_grid": "U2", "V_A_grid": "V2"})
+    # Replace the numpy datetime64 time axis by an array of cftime objects with a different calendar
+    times = [cftime.DatetimeNoLeap(2000, 1, 1 + i) for i in range(ds2["time"].size)]
+    ds2["time"] = (ds2["time"].dims, np.array(times, dtype=object), ds2["time"].attrs)
+
+    with pytest.raises(CalendarError):
+        fieldset + FieldSet.from_sgrid_conventions(ds2)
 
 
 @pytest.mark.parametrize(
@@ -296,7 +305,11 @@ def test_datetime_to_msg(input_, expected):
 
 def test_fieldset_samegrids_UV():
     """Test that if a simple fieldset with U and V is created, that only one grid object is defined."""
-    ...
+    ds = simple_UV_dataset(mesh_str="flat")
+    fieldset = FieldSet.from_sgrid_conventions(ds)
+
+    assert fieldset.U.grid is fieldset.V.grid
+    assert len(fieldset.gridset) == 1
 
 
 def test_fieldset_grid_deduplication():
@@ -306,7 +319,15 @@ def test_fieldset_grid_deduplication():
     When grid deduplication is actually implemented, this might need to be refactored
     into multiple tests (/more might be needed).
     """
-    ...
+    ds = simple_UV_dataset(mesh_str="flat")
+    fieldset = FieldSet.from_sgrid_conventions(ds)
+
+    ds2 = simple_UV_dataset(mesh_str="flat").rename({"U": "U2", "V": "V2"})
+    fieldset += FieldSet.from_sgrid_conventions(ds2)
+    assert fieldset.U.grid is fieldset.V.grid
+    assert fieldset.U2.grid is fieldset.V2.grid
+    assert fieldset.U.grid is not fieldset.U2.grid
+    assert fieldset.U.grid is not fieldset.V2.grid
 
 
 def test_fieldset_from_icon():

tests/test_particlefile.py

@@ -8,7 +8,6 @@
 import pyarrow as pa
 import pyarrow.parquet as pq
 import pytest
-import xarray as xr
 from re_assert import Matches
 
 import parcels.tutorial
@@ -156,46 +155,6 @@ def test_write_dtypes_pfile(fieldset, tmp_parquet):
         assert tab[f"v_{d.__name__}"].type == pa.from_numpy_dtype(d)
 
 
-@pytest.mark.skip(reason="Pending ParticleFile refactor; see issue #2386")
-@pytest.mark.parametrize("dt", [-np.timedelta64(1, "s"), np.timedelta64(1, "s")])
-@pytest.mark.parametrize("maxvar", [2, 4, 10])
-def test_pset_repeated_release_delayed_adding_deleting(fieldset, tmp_parquet, dt, maxvar):
-    """Tests that if particles are released and deleted based on age that resulting output file is correct."""
-    npart = 10
-    fieldset.add_context("maxvar", maxvar)
-
-    MyParticle = Particle.add_variable(
-        [Variable("sample_var", initial=0.0), Variable("v_once", dtype=np.float64, initial=0.0)]
-    )
-
-    pset = ParticleSet(
-        fieldset,
-        x=np.zeros(npart),
-        y=np.zeros(npart),
-        pclass=MyParticle,
-        t=fieldset.time_interval.left + [np.timedelta64(i + 1, "s") for i in range(npart)],
-    )
-    pfile = ParticleFile(tmp_parquet, outputdt=abs(dt))
-
-    def IncrLon(particles, fieldset):  # pragma: no cover
-        particles.sample_var += 1.0
-        particles.state = np.where(
-            particles.sample_var > fieldset.maxvar,
-            StatusCode.Delete,
-            particles.state,
-        )
-
-    for _ in range(npart):
-        pset.execute(IncrLon, dt=dt, runtime=np.timedelta64(1, "s"), output_file=pfile)
-
-    ds = xr.open_zarr(tmp_parquet)
-    samplevar = ds["sample_var"][:]
-    assert samplevar.shape == (npart, min(maxvar, npart + 1))
-    # test whether samplevar[:, k] = k
-    for k in range(samplevar.shape[1]):
-        assert np.allclose([p for p in samplevar[:, k] if np.isfinite(p)], k + 1)
-
-
 def test_file_warnings(fieldset, tmp_parquet):
     pset = ParticleSet(fieldset, x=[0, 0], y=[0, 0], t=[np.timedelta64(0, "s"), np.timedelta64(1, "s")])
     pfile = ParticleFile(tmp_parquet, outputdt=np.timedelta64(2, "s"))