Skip to content

v0.9.0

Compare
Choose a tag to compare
@ecomodeller ecomodeller released this 22 Oct 11:03
· 2925 commits to main since this release

Note The default axis in all dataset aggregation functions, have changed from axis=1 (some spatial axis) to "time". See details below:

What's Changed

Full Changelog: v0.8.0...v0.9.0

Dataset aggregation (mean(), max(), ...)

>>> import mikeio
>>> ds = mikeio.read("HD2D.dfsu")
>>> ds.shape
(9, 884)
>>> ds.mean() # the new default is to aggregate along the time dimension
<mikeio.Dataset>
Dimensions: (1, 884)
Time: 1985-08-06 07:00:00 - 1985-08-06 07:00:00
Items:
  0:  Surface elevation <Surface Elevation> (meter)
  1:  U velocity <u velocity component> (meter per sec)
  2:  V velocity <v velocity component> (meter per sec)
  3:  Current speed <Current Speed> (meter per sec)
>>> ds.mean(axis="spatial")
<mikeio.Dataset>
Dimensions: (9,)
Time: 1985-08-06 07:00:00 - 1985-08-07 03:00:00
Items:
  0:  Surface elevation <Surface Elevation> (meter)
  1:  U velocity <u velocity component> (meter per sec)
  2:  V velocity <v velocity component> (meter per sec)
  3:  Current speed <Current Speed> (meter per sec)
>>> ds.mean(axis="time") # you can also be explicit about using the time axis
<mikeio.Dataset>
Dimensions: (1, 884)
Time: 1985-08-06 07:00:00 - 1985-08-06 07:00:00
Items:
  0:  Surface elevation <Surface Elevation> (meter)
  1:  U velocity <u velocity component> (meter per sec)
  2:  V velocity <v velocity component> (meter per sec)
  3:  Current speed <Current Speed> (meter per sec)