More executable examples

Author: ecomodeller

mikeio/dataset/_data_plot.py

@@ -171,13 +171,15 @@ class _DataArrayPlotterGrid1D(_DataArrayPlotter):
 
     Examples
     --------
-    >>> da = mikeio.read("tide1.dfs1")["Level"]
-    >>> da.plot()
-    >>> da.plot.line()
-    >>> da.plot.timeseries()
-    >>> da.plot.imshow()
-    >>> da.plot.pcolormesh()
-    >>> da.plot.hist()
+    ```{python}
+    import mikeio
+    da = mikeio.read("../data/tide1.dfs1")["Level"]
+    da.plot()
+    ```
+    ```{python}
+    da.plot.timeseries()
+    ```
+
 
     """
 
@@ -575,7 +577,6 @@ def _plot_FM_map(self, ax: Axes, **kwargs: Any) -> Axes:
 class _DataArrayPlotterFMVerticalColumn(_DataArrayPlotter):
     """Plot a DataArray with a GeometryFMVerticalColumn geometry.
 
-    If DataArray has multiple time steps, the first step will be plotted.
 
     Examples
     --------
@@ -592,9 +593,6 @@ class _DataArrayPlotterFMVerticalColumn(_DataArrayPlotter):
     ```{python}
     da.plot.pcolormesh()
     ```
-    ```{python}
-    da.plot.hist()
-    ```
 
     """
 
@@ -909,9 +907,15 @@ def scatter(
 
         Examples
         --------
-        >>> ds = mikeio.read("oresund_sigma_z.dfsu")
-        >>> ds.plot.scatter(x="Salinity", y="Temperature", title="S-vs-T")
-        >>> ds.plot.scatter(x=0, y=1, figsize=(9,9), marker='*')
+        ```{python}
+        import mikeio
+        ds = mikeio.read("../data/oresund_sigma_z.dfsu")
+        ds.plot.scatter(x="Salinity", y="Temperature", title="S-vs-T")
+        ```
+
+        ```{python}
+        ds.plot.scatter(x=0, y=1, figsize=(9,9), marker='*')
+        ```
 
         """
         _, ax = self._get_fig_ax(ax, figsize)

mikeio/dataset/_dataarray.py

@@ -1010,7 +1010,7 @@ def interp(
         # TODO find out optimal syntax to allow interpolation to single point, new time, grid, mesh...
         self,
         # *, # TODO: make this a keyword-only argument in the future
-        time: pd.DatetimeIndex | DataArray | None = None,
+        time: pd.DatetimeIndex | DataArray | Dataset | int | float | None = None,
         x: float | None = None,
         y: float | None = None,
         z: float | None = None,
@@ -1064,12 +1064,12 @@ def interp(
 
         Examples
         --------
-        >>> da = mikeio.read("random.dfs1")[0]
-        >>> da.interp(time=3600)
-        >>> da.interp(x=110)
+        ```{python}
+        import mikeio
 
-        >>> da = mikeio.read("HD2D.dfsu").Salinity
-        >>> da.interp(x=340000, y=6160000)
+        da = mikeio.read("../data/HD2D.dfsu")["Current speed"]
+        da.interp(x=340000, y=6160000)
+        ```
 
         """
         if z is not None:
@@ -1194,7 +1194,7 @@ def extract_track(
 
     def interp_time(
         self,
-        dt: float | pd.DatetimeIndex | DataArray,
+        dt: pd.DatetimeIndex | DataArray | Dataset | int | float,
         *,
         method: str = "linear",
         extrapolate: bool = True,
@@ -1302,11 +1302,6 @@ def interp_like(
         **kwargs: Any
             additional kwargs are passed to interpolation method
 
-        Examples
-        --------
-        >>> dai = da.interp_like(da2)
-        >>> dae = da.interp_like(da2, extrapolate=True)
-        >>> dat = da.interp_like(da2.time)
 
         Returns
         -------
@@ -1546,10 +1541,12 @@ def average(
 
         Examples
         --------
-        >>> dfs = Dfsu("HD2D.dfsu")
-        >>> da = dfs.read(["Current speed"])[0]
-        >>> area = dfs.get_element_area()
-        >>> da2 = da.average(axis="space", weights=area)
+        ```{python}
+        import mikeio
+        da= mikeio.read("../data/HD2D.dfsu")["Current speed"]
+        area = da.geometry.get_element_area()
+        da.average(axis="space", weights=area)
+        ```
 
         """
 
@@ -2087,7 +2084,8 @@ def _values_txt(self) -> str:
 
     @staticmethod
     def _parse_interp_time(
-        old_time: pd.DatetimeIndex, new_time: Any
+        old_time: pd.DatetimeIndex,
+        new_time: pd.DatetimeIndex | DataArray | Dataset | int | float,
     ) -> pd.DatetimeIndex:
         if isinstance(new_time, pd.DatetimeIndex):
             t_out_index = new_time

mikeio/dataset/_dataset.py

@@ -398,18 +398,7 @@ def create_data_array(
         item: ItemInfo | None = None,
         name: str | None = None,
     ) -> DataArray:
-        """Create a new  DataArray with the same time and geometry as the dataset.
-
-        Examples
-        --------
-
-        >>> ds = mikeio.read("file.dfsu")
-        >>> values = np.zeros(ds.Temperature.shape)
-        >>> da = ds.create_data_array(values)
-        >>> da_name = ds.create_data_array(values,"Foo")
-        >>> da_eum = ds.create_data_array(values, item=mikeio.ItemInfo("TS", mikeio.EUMType.Temperature))
-
-        """
+        """Create a new  DataArray with the same time and geometry as the dataset."""
         return DataArray(
             data=data,
             time=self.time,
@@ -503,9 +492,15 @@ def rename(self, mapper: Mapping[str, str], inplace: bool = False) -> Dataset:
 
         Examples
         --------
-        >>> ds = mikeio.read("tide1.dfs1")
-        >>> newds = ds.rename({"Level":"Surface Elevation"})
-        >>> ds.rename({"Level":"Surface Elevation"}, inplace=True)
+        ```{python}
+        import mikeio
+        ds = mikeio.read("../data/tide1.dfs1")
+        ds
+        ```
+        ```{python}
+        ds.rename({"Level":"Surface Elevation"})
+        ```
+
 
         """
         if inplace:
@@ -701,14 +696,11 @@ def isel(
 
         Examples
         --------
-        >>> ds = mikeio.read("europe_wind_long_lat.dfs2")
-        >>> ds.isel(time=-1)
-        >>> ds.isel(x=slice(10,20), y=slice(40,60))
-        >>> ds.isel(y=34)
-
-        >>> ds = mikeio.read("tests/testdata/HD2D.dfsu")
-        >>> ds2 = ds.isel(time=[0,1,2])
-        >>> ds3 = ds2.isel(elements=[100,200])
+        ```{python}
+        import mikeio
+        ds = mikeio.read("../data/europe_wind_long_lat.dfs2")
+        ds.isel(x=slice(10,20), y=slice(40,60))
+        ```
 
         """
         # TODO deprecate idx, axis to prefer x= instead
@@ -791,15 +783,19 @@ def sel(
 
         Examples
         --------
-        >>> ds = mikeio.read("random.dfs1")
-        >>> ds.sel(time=slice(None, "2012-1-1 00:02"))
-        >>> ds.sel(x=100)
+        ```{python}
+        import mikeio
+        ds = mikeio.read("../data/oresund_sigma_z.dfsu")
+        ds.sel(x=340000, y=6160000, z=-3)
+        ```
 
-        >>> ds = mikeio.read("oresund_sigma_z.dfsu")
-        >>> ds.sel(time="1997-09-15")
-        >>> ds.sel(x=340000, y=6160000, z=-3)
-        >>> ds.sel(area=(340000, 6160000, 350000, 6170000))
-        >>> ds.sel(layers="bottom")
+        ```{python}
+        ds.sel(area=(340000, 6160000, 350000, 6170000))
+        ```
+
+        ```{python}
+        ds.sel(layers="bottom")
+        ```
 
         """
         res = [
@@ -960,7 +956,7 @@ def extract_track(
 
     def interp_time(
         self,
-        dt: float | pd.DatetimeIndex | Dataset | DataArray | None = None,
+        dt: float | int | pd.DatetimeIndex | Dataset | DataArray | None = None,
         *,
         freq: str | None = None,
         method: str = "linear",

mikeio/spatial/_FM_geometry.py

@@ -469,7 +469,7 @@ def __init__(
         self.plot = _GeometryFMPlotter(self)
 
     def __str__(self) -> str:
-        return f"{self.type_name} ({self.n_elements} elements, {self.n_nodes} nodes)"
+        return f"{self._type.name} ({self.n_elements} elements, {self.n_nodes} nodes)"
 
     def __repr__(self) -> str:
         return (
@@ -500,11 +500,6 @@ def _area_is_polygon(area: Sequence[tuple[float, float]] | Sequence[float]) -> b
         polygon = np.array(area)
         return polygon.ndim == 2 and polygon.shape[1] == 2
 
-    @property
-    def type_name(self) -> str:
-        """Type name, e.g. Mesh, Dfsu2D."""
-        return self._type.name if self._type else "Mesh"
-
     @property
     def ndim(self) -> int:
         return 2

mikeio/spatial/_FM_geometry_layered.py

@@ -60,6 +60,9 @@ def __init__(
         self._2d_ids: np.ndarray | None = None
         self._layer_ids: np.ndarray | None = None
 
+    def __str__(self) -> str:
+        return f"{self._type.name} ({self.n_elements} elements, {self.n_nodes} nodes)"
+
     def __repr__(self) -> str:
         return (
             f"Flexible Mesh Geometry: {self._type.name}\n"