__init__ docstrings

ecomodeller · ecomodeller · commit 6bb10a677356 · 2025-03-05T11:45:09.000+01:00
diff --git a/mikeio/dataset/_dataarray.py b/mikeio/dataset/_dataarray.py
@@ -132,12 +132,23 @@ def __call__(self, tail: bool = True) -> "DataArray":
 class DataArray:
     """DataArray with data and metadata for a single item in a dfs file.
 
-    The DataArray has these main properties:
+    Parameters
+    ----------
+    data:
+        a numpy array containing the data
+    time:
+        a pandas.DatetimeIndex with the time instances of the data
+    item:
+        an ItemInfo with name, type and unit
+    geometry:
+        a geometry object e.g. Grid2D or GeometryFM2D
+    zn:
+        only relevant for Dfsu3d
+    dims:
+        named dimensions
+    dt:
+        placeholder timestep
 
-    * time - a pandas.DatetimeIndex with the time instances of the data
-    * geometry - a geometry object e.g. Grid2D or GeometryFM
-    * values - a numpy array containing the data
-    * item - an ItemInfo with name, type and unit
 
     Examples
     --------
diff --git a/mikeio/dataset/_dataset.py b/mikeio/dataset/_dataset.py
@@ -56,14 +56,29 @@ class Dataset:
 
     The Dataset is primarily a container for one or more DataArrays
     all having the same time and geometry (and shape, dims, etc).
-    For convenience, the Dataset provides access to these common properties:
 
-    * time - a pandas.DatetimeIndex with the time instances of the data
-    * geometry - a geometry object e.g. Grid2D or GeometryFM
-    * shape - a tuple of array dimensions (for each DataArray)
-    * dims - a tuple of dimension labels
-
-    Selecting items
+    Parameters
+    ----------
+    data:
+        a sequence or mapping of numpy arrays
+        By providing a mapping of data arrays, the remaining parameters are not needed
+    time:
+        a pandas.DatetimeIndex with the time instances of the data
+    item:
+        an ItemInfo with name, type and unit
+    geometry:
+        a geometry object e.g. Grid2D or GeometryFM2D
+    zn:
+        only relevant for Dfsu3d
+    dims:
+        named dimensions
+    validate:
+        Optional validation of consistency of data arrays.
+    dt:
+        placeholder timestep
+
+
+    Notes
     ---------------
     Selecting a specific item "itemA" (at position 0) from a Dataset ds can be done with:
 
diff --git a/mikeio/dfs/_dfs0.py b/mikeio/dfs/_dfs0.py
@@ -11,6 +11,8 @@
 from mikecore.DfsFileFactory import DfsFileFactory
 from mikecore.eum import eumQuantity
 
+from mikeio.eum._eum import ItemInfoList
+
 from .. import __dfs_version__
 from ..dataset import Dataset, DataArray
 from ._dfs import _get_item_info, _valid_item_numbers, _valid_timesteps
@@ -305,7 +307,7 @@ def n_items(self) -> int:
         return self._n_items
 
     @property
-    def items(self) -> list[ItemInfo]:
+    def items(self) -> ItemInfoList:
         """List of items."""
         return self._items
 
diff --git a/mikeio/dfs/_dfs1.py b/mikeio/dfs/_dfs1.py
@@ -73,7 +73,14 @@ def _write_dfs1_header(filename: str | Path, ds: Dataset, title: str) -> DfsFile
 
 
 class Dfs1(_Dfs123):
-    """Class for reading/writing dfs1 files."""
+    """Class for reading/writing dfs1 files.
+
+    Parameters
+    ----------
+    filename:
+        Path to dfs1 file
+
+    """
 
     _ndim = 1
 
diff --git a/mikeio/dfs/_dfs2.py b/mikeio/dfs/_dfs2.py
@@ -108,7 +108,16 @@ def _write_dfs2_spatial_axis(
 
 
 class Dfs2(_Dfs123):
-    """Class for reading/writing dfs2 files."""
+    """Class for reading/writing dfs2 files.
+
+    Parameters
+    ----------
+    filename:
+        Path to dfs2 file
+    type:
+        horizontal, spectral or vertical, default horizontal
+
+    """
 
     _ndim = 2
 
diff --git a/mikeio/dfs/_dfs3.py b/mikeio/dfs/_dfs3.py
@@ -99,7 +99,14 @@ def _write_dfs3_header(filename: str | Path, ds: Dataset, title: str) -> DfsFile
 
 
 class Dfs3(_Dfs123):
-    """Class for reading/writing dfs3 files."""
+    """Class for reading/writing dfs3 files.
+
+    Parameters
+    ----------
+    filename:
+        Path to dfs3 file
+
+    """
 
     _ndim = 3
 
diff --git a/mikeio/dfsu/_dfsu.py b/mikeio/dfsu/_dfsu.py
@@ -170,115 +170,15 @@ def _get_dfsu_info(filename: str | Path) -> _DfsuInfo:
     )
 
 
-# class _Dfsu:
-#     show_progress = False
-
-#     def __init__(self, filename: str | Path) -> None:
-#         """
-#         Create a Dfsu object
-
-#         Parameters
-#         ---------
-#         filename: str
-#             dfsu filename
-#         """
-#         info = _get_dfsu_info(filename)
-#         self._filename = info.filename
-#         self._type = info.type
-#         self._deletevalue = info.deletevalue
-#         self._time = info.time
-#         self._timestep = info.timestep
-#         self._items = info.items
-
-#     def __repr__(self):
-#         out = [f"<mikeio.{self.__class__.__name__}>"]
-
-#         if self._type is not DfsuFileType.DfsuSpectral0D:
-#             if self._type is not DfsuFileType.DfsuSpectral1D:
-#                 out.append(f"number of elements: {self.geometry.n_elements}")
-#             out.append(f"number of nodes: {self.geometry.n_nodes}")
-#         if self.geometry.is_spectral:
-#             if self.geometry.n_directions > 0:
-#                 out.append(f"number of directions: {self.geometry.n_directions}")
-#             if self.geometry.n_frequencies > 0:
-#                 out.append(f"number of frequencies: {self.geometry.n_frequencies}")
-#         if self.geometry.projection_string:
-#             out.append(f"projection: {self.geometry.projection_string}")
-#         if self.geometry.is_layered:
-#             out.append(f"number of sigma layers: {self.geometry.n_sigma_layers}")
-#         if (
-#             self._type == DfsuFileType.DfsuVerticalProfileSigmaZ
-#             or self._type == DfsuFileType.Dfsu3DSigmaZ
-#         ):
-#             out.append(
-#                 f"max number of z layers: {self.geometry.n_layers - self.geometry.n_sigma_layers}"
-#             )
-#         if self.n_items < 10:
-#             out.append("items:")
-#             for i, item in enumerate(self.items):
-#                 out.append(f"  {i}:  {item}")
-#         else:
-#             out.append(f"number of items: {self.geometry.n_items}")
-#         if self.n_timesteps == 1:
-#             out.append(f"time: time-invariant file (1 step) at {self.time[0]}")
-#         else:
-#             out.append(
-#                 f"time: {str(self.time[0])} - {str(self.time[-1])} ({self.n_timesteps} records)"
-#             )
-#         return str.join("\n", out)
-
-#     def _read_items(self, filename: str) -> list[ItemInfo]:
-#         dfs = DfsuFile.Open(filename)
-#         items = _get_item_info(dfs.ItemInfo)
-#         dfs.Close()
-#         return items
-
-#     @property
-#     def geometry(self):
-#         return self._geometry
-
-#     @property
-#     def deletevalue(self) -> float:
-#         """File delete value"""
-#         return self._deletevalue
-
-#     @property
-#     def n_items(self) -> int:
-#         """Number of items"""
-#         return len(self.items)
-
-#     @property
-#     def items(self) -> list[ItemInfo]:
-#         """List of items"""
-#         return self._items
-
-#     @property
-#     def start_time(self) -> pd.Timestamp:
-#         """File start time"""
-#         return self._time[0]
-
-#     @property
-#     def n_timesteps(self) -> int:
-#         """Number of time steps"""
-#         return len(self._time)
-
-#     @property
-#     def timestep(self) -> float:
-#         """Time step size in seconds"""
-#         return self._timestep
-
-#     @property
-#     def end_time(self) -> pd.Timestamp:
-#         """File end time"""
-#         return self._time[-1]
-
-#     @property
-#     def time(self) -> pd.DatetimeIndex:
-#        return self._time
+class Dfsu2DH:
+    """Class for reading/writing dfsu 2d horizontal files.
 
+    Parameters
+    ----------
+    filename:
+        Path to dfsu file
 
-class Dfsu2DH:
-    """Class for reading/writing dfsu 2d horizontal files."""
+    """
 
     show_progress = False
 
diff --git a/mikeio/dfsu/_layered.py b/mikeio/dfsu/_layered.py
@@ -411,7 +411,14 @@ def append(self, ds: Dataset, validate: bool = True) -> None:
 
 
 class Dfsu2DV(DfsuLayered):
-    """Class for reading/writing dfsu 2d vertical files."""
+    """Class for reading/writing dfsu 2d vertical files.
+
+    Parameters
+    ----------
+    filename:
+        Path to dfsu file
+
+    """
 
     def plot_vertical_profile(
         self,
@@ -467,7 +474,14 @@ def plot_vertical_profile(
 
 
 class Dfsu3D(DfsuLayered):
-    """Class for reading/writing dfsu 3d files."""
+    """Class for reading/writing dfsu 3d files.
+
+    Parameters
+    ----------
+    filename:
+        Path to dfsu file
+
+    """
 
     @property
     def geometry2d(self) -> GeometryFM2D:
diff --git a/mikeio/dfsu/_spectral.py b/mikeio/dfsu/_spectral.py
@@ -26,7 +26,14 @@
 
 
 class DfsuSpectral:
-    """Dfsu for Spectral data."""
+    """Dfsu for Spectral data.
+
+    Parameters
+    ----------
+    filename:
+        Path to dfsu file
+
+    """
 
     show_progress = False
 
diff --git a/mikeio/eum/_eum.py b/mikeio/eum/_eum.py
@@ -1404,7 +1404,8 @@ class ItemInfo:
     Parameters
     ----------
     name: str or EUMType, optional
-    type: EUMType or int, optional
+        User defined name
+    itemtype: EUMType or int, optional
         Default EUMType.Undefined
     unit: EUMUnit or int, optional
         Default unit matching EUMType
diff --git a/mikeio/spatial/_grid_geometry.py b/mikeio/spatial/_grid_geometry.py
