Add input validation

Author: BrianMichell

src/mdio/converters/numpy.py

@@ -49,6 +49,42 @@ def _build_dataset(
     return mdio_ds
 
 
+def _validate_coordinates(
+    index_coords: dict[str, NDArray],
+    mdio_template: AbstractDatasetTemplate,
+    array: NDArray,
+) -> None:
+    """Validate user-provided coordinates against template and array dimensions.
+
+    Args:
+        index_coords: Dictionary mapping dimension names to coordinate arrays.
+        mdio_template: The MDIO template defining expected dimensions.
+        array: The numpy array being converted.
+
+    Raises:
+        ValueError: If coordinate names or sizes don't match requirements.
+    """
+    # Validate that coordinate names match template dimension names
+    for coord_name in index_coords:
+        if coord_name not in mdio_template.dimension_names:
+            available_dims = sorted(mdio_template.dimension_names)
+            err = (
+                f"Coordinate name '{coord_name}' not found in template dimensions. "
+                f"Available dimensions: {available_dims}"
+            )
+            raise ValueError(err)
+
+    # Validate coordinate array sizes match array dimensions
+    for dim_name, coord_array in index_coords.items():
+        expected_size = array.shape[mdio_template.dimension_names.index(dim_name)]
+        if coord_array.size != expected_size:
+            err = (
+                f"Size of coordinate '{dim_name}' ({coord_array.size}) does not match "
+                f"array dimension size ({expected_size})"
+            )
+            raise ValueError(err)
+
+
 def _populate_coordinates_and_write(
     xr_dataset: xr_Dataset,
     index_coords: dict[str, NDArray],
@@ -111,6 +147,10 @@ def numpy_to_mdio(  # noqa: PLR0913
         err = f"Output location '{output_path.as_posix()}' exists. Set `overwrite=True` if intended."
         raise FileExistsError(err)
 
+    # Validate coordinates if provided
+    if index_coords:
+        _validate_coordinates(index_coords, mdio_template, array)
+
     # Build dataset
     mdio_ds = _build_dataset(
         array=array,

tests/integration/test_import_numpy.py

@@ -118,3 +118,50 @@ def test_npy_to_mdio_seismic_template(mock_array: NDArray) -> None:
     npt.assert_array_equal(ds[data_var].values, mock_array)
     assert list(ds.sizes.keys()) == ["inline", "crossline", "time"]
     assert ds[data_var].shape == mock_array.shape
+
+
+def test_npy_to_mdio_invalid_coordinate_names(mock_array: NDArray, mock_template: AbstractDatasetTemplate) -> None:
+    """Test NumPy to MDIO conversion with invalid coordinate names."""
+    index_coords = {
+        "inline": np.arange(15),  # valid
+        "crossline": np.arange(10),  # valid
+        "invalid_dim": np.arange(20),  # invalid dimension name
+    }
+
+    with pytest.raises(ValueError, match=r"Coordinate name 'invalid_dim' not found in template dimensions"):
+        numpy_to_mdio(mock_array, mock_template, "memory://npy_invalid.mdio", index_coords=index_coords)
+
+
+def test_npy_to_mdio_invalid_coordinate_sizes(mock_array: NDArray, mock_template: AbstractDatasetTemplate) -> None:
+    """Test NumPy to MDIO conversion with invalid coordinate array sizes."""
+    index_coords = {
+        "inline": np.arange(10),  # wrong size (should be 15)
+        "crossline": np.arange(10),  # valid
+        "time": np.arange(20),  # valid
+    }
+
+    with pytest.raises(
+        ValueError, match=r"Size of coordinate 'inline' \(10\) does not match array dimension size \(15\)"
+    ):
+        numpy_to_mdio(mock_array, mock_template, "memory://npy_wrong_size.mdio", index_coords=index_coords)
+
+
+def test_npy_to_mdio_valid_custom_coordinates(mock_array: NDArray, mock_template: AbstractDatasetTemplate) -> None:
+    """Test NumPy to MDIO conversion with valid custom coordinates."""
+    index_coords = {
+        "inline": np.arange(100, 115),  # valid size (15)
+        "crossline": np.arange(200, 210),  # valid size (10)
+        "time": np.arange(0, 20),  # valid size (20)
+    }
+
+    numpy_to_mdio(mock_array, mock_template, "memory://npy_valid_custom.mdio", index_coords=index_coords)
+    ds = open_mdio("memory://npy_valid_custom.mdio")
+
+    # Check data
+    data_var = ds.attrs.get("defaultVariableName", "amplitude")
+    npt.assert_array_equal(ds[data_var].values, mock_array)
+
+    # Check coordinates are correctly set
+    npt.assert_array_equal(ds["inline"].values, index_coords["inline"])
+    npt.assert_array_equal(ds["crossline"].values, index_coords["crossline"])
+    npt.assert_array_equal(ds["time"].values, index_coords["time"])