Merge pull request #818 from DHI/move/rename_utils

Renaming utils/common to more descriptive name

Author: ecomodeller

docs/examples/dfsu/spatial_interpolation.qmd

@@ -135,10 +135,8 @@ We want to interpolate scatter data onto an existing mesh and create a new dfsu
 
 **This uses lower level private utility methods not part of the public API**.
 
-Interpolating from scatter data will soon be possible in a simpler way.
-
 ```{python}
-from mikeio.spatial._utils import dist_in_meters
+from mikeio.spatial._distance import dist_in_meters
 from mikeio._interpolation import get_idw_interpolant
 ```
 

mikeio/_time.py

@@ -2,10 +2,31 @@
 from datetime import datetime
 from dataclasses import dataclass
 from collections.abc import Iterable
+from typing import Sized
 
 import pandas as pd
 
 
+def _n_selected_timesteps(x: Sized, k: slice | Sized) -> int:
+    if isinstance(k, slice):
+        k = list(range(*k.indices(len(x))))
+    return len(k)
+
+
+def _get_time_idx_list(
+    time: pd.DatetimeIndex,
+    steps: int | Iterable[int] | str | datetime | pd.DatetimeIndex | slice,
+) -> list[int] | slice:
+    """Find list of idx in DatetimeIndex."""
+    # indexing with a slice needs to be handled differently, since slicing returns a view
+
+    if isinstance(steps, slice):
+       if isinstance(steps.start, int) and isinstance(steps.stop, int):
+         return steps
+
+    dts = DateTimeSelector(time)
+    return dts.isel(steps)
+
 @dataclass
 class DateTimeSelector:
     """Helper class for selecting time steps from a pandas DatetimeIndex."""

mikeio/dataset/_data_plot.py

@@ -6,7 +6,7 @@
 import matplotlib.pyplot as plt
 from matplotlib.axes import Axes
 
-from ..spatial._FM_utils import _plot_map, _plot_vertical_profile
+from ..spatial._FM_plot import _plot_map, _plot_vertical_profile
 
 from .._spectral import plot_2dspectrum
 

mikeio/dataset/_data_utils.py

@@ -26,7 +26,7 @@
 from mikecore.DfsuFile import DfsuFileType
 
 from ..eum import EUMType, EUMUnit, ItemInfo
-from ._data_utils import _get_time_idx_list, _n_selected_timesteps
+from .._time import _get_time_idx_list, _n_selected_timesteps
 
 if TYPE_CHECKING:
     from ._dataset import Dataset
@@ -620,8 +620,8 @@ def __getitem__(self, key: Any) -> "DataArray":
             if isinstance(k, Iterable) or k != slice(None):
                 if dims[j] == "time":
                     # getitem accepts fancy indexing only for time
-                    k = self._get_time_idx_list(self.time, k)
-                    if self._n_selected_timesteps(self.time, k) == 0:
+                    k = _get_time_idx_list(self.time, k)
+                    if _n_selected_timesteps(self.time, k) == 0:
                         raise IndexError("No timesteps found!")
                 da = da.isel(**{dims[j]: k})
         return da
@@ -2088,17 +2088,6 @@ def _time_by_agg_axis(
 
         return time
 
-    @staticmethod
-    def _get_time_idx_list(
-        time: pd.DatetimeIndex,
-        steps: int | Iterable[int] | str | datetime | pd.DatetimeIndex | slice,
-    ) -> list[int] | slice:
-        """Find list of idx in DatetimeIndex."""
-        return _get_time_idx_list(time, steps)
-
-    @staticmethod
-    def _n_selected_timesteps(time: Sized, k: slice | Sized) -> int:
-        return _n_selected_timesteps(time, k)
 
     @staticmethod
     def _is_boolean_mask(x: Any) -> bool:

mikeio/dataset/_dataarray.py

@@ -2,6 +2,7 @@
 from pathlib import Path
 from datetime import datetime
 from copy import deepcopy
+import re
 from typing import (
     Iterable,
     Iterator,
@@ -30,7 +31,7 @@
     import polars as pl
 
 from ._dataarray import DataArray
-from ._data_utils import _to_safe_name, _get_time_idx_list, _n_selected_timesteps
+from .._time import _get_time_idx_list, _n_selected_timesteps
 from ..eum import EUMType, EUMUnit, ItemInfo
 from ..spatial import (
     GeometryFM2D,
@@ -48,6 +49,10 @@
 
 from ._dataarray import IndexType
 
+def _to_safe_name(name: str) -> str:
+    tmp = re.sub("[^0-9a-zA-Z]", "_", name)
+    return re.sub("_+", "_", tmp)  # Collapse multiple underscores
+
 
 class Dataset:
     """Dataset containing one or more DataArrays with common geometry and time.

mikeio/dataset/_dataset.py

@@ -16,7 +16,7 @@
 from mikecore.eum import eumQuantity, eumUnit
 from tqdm import trange
 
-from mikeio.spatial._utils import xy_to_bbox
+from mikeio.spatial._distance import xy_to_bbox
 
 from .. import __dfs_version__
 from ..dataset import Dataset
@@ -31,7 +31,7 @@
 )
 from ..spatial import Grid2D
 from .._track import _extract_track
-from ._common import get_elements_from_source, get_nodes_from_source
+from ._topology import get_elements_from_source, get_nodes_from_source
 from ..eum import ItemInfo, TimeStepUnit
 
 

mikeio/dfsu/_dfsu.py

@@ -25,7 +25,7 @@
     GeometryPoint3D,
     GeometryFM2D,
 )
-from ..spatial._FM_utils import _plot_vertical_profile
+from ..spatial._FM_plot import _plot_vertical_profile
 from ._dfsu import (
     _get_dfsu_info,
     get_nodes_from_source,

mikeio/dfsu/_layered.py

@@ -10,7 +10,7 @@
 
 
 from ..spatial import GeometryFM2D
-from ._common import (
+from ._topology import (
     get_elements_from_source,
     get_nodes_from_source,
 )