def setupDfs0():
global shePath
global dfs
global dfsDataX
global dfsDataY
global nX
global nY
global nZ
import clr
global simStart
global simStart
now = MShePy.wm.currentTime()
clr.AddReference("DHI.Mike.Install, Version=1.0.0.0, Culture=neutral, PublicKeyToken=c513450b5d0bf0bf") # "fully qualified" name required!
from DHI.Mike.Install import MikeImport, MikeProducts
MikeImport.SetupLatest()
clr.AddReference("DHI.Generic.MikeZero.DFS")
clr.AddReference("DHI.Generic.MikeZero.EUM")
clr.AddReference("System")
import System
from System import Array
from DHI.Generic.MikeZero import eumUnit, eumItem, eumQuantity
from DHI.Generic.MikeZero.DFS import DfsFactory, DfsBuilder, DfsSimpleType, DataValueType
shePath = MShePy.wm.getSheFilePath()
sheDir = os.path.dirname(shePath)
filename = os.path.join(sheDir, 'BndFluxes.dfs2')
builder = DfsBuilder.Create(filename, "MSHE SZ boundary fluxes output per layer", 0)
builder.SetDataType(1)
factory = DfsFactory()
builder.SetGeographicalProjection(factory.CreateProjectionGeoOrigin("NON-UTM", 0, 0, 0))
simStart = now
nowSys = System.DateTime(now.year, now.month, now.day, now.hour, now.minute, now.second)
# note: time unit given here has to be used in WriteItemTimeStepNext
axis = factory.CreateTemporalNonEqCalendarAxis(eumUnit.eumUsec, nowSys)
builder.SetTemporalAxis(axis)
builder.DeleteValueFloat = -1e-30
(startTime, endTime, values) = MShePy.wm.getValues(MShePy.paramTypes.SZ_X_FLO) # just for the geometry
(nX, nY, nZ) = values.shape()
(x0, y0) = MShePy.wm.gridCellToCoord(0, 0)
(x1, y1) = MShePy.wm.gridCellToCoord(1, 1)
dfsDataX = Array.CreateInstance(System.Single, nX * nY)
dfsDataY = Array.CreateInstance(System.Single, nX * nY)
for x in range(nX):
for y in range(nY):
if(not MShePy.wm.gridIsInModel(x, y)):
dfsDataX[x + y * nX] = builder.DeleteValueFloat
dfsDataY[x + y * nX] = builder.DeleteValueFloat
dx = x1 - x0 # cell size, dx == dy
axis = factory.CreateAxisEqD2(eumUnit.eumUmeter, nX, x0 - dx / 2, dx, nY, y0 - dx / 2, dx)
itemBuilder = builder.CreateDynamicItemBuilder()
itemBuilder.SetValueType(DataValueType.MeanStepBackward)
itemBuilder.SetAxis(axis)
for iz in range(nZ):
for xy in ['x', 'y']:
itemBuilder.Set('Boundary inflow layer {0}, {1}-direction'.format(iz + 1, xy), eumQuantity.Create(eumItem.eumIDischarge, eumUnit.eumUm3PerSec), DfsSimpleType.Float)
builder.AddDynamicItem(itemBuilder.GetDynamicItemInfo())
builder.CreateFile(filename)
dfs = builder.GetFile()
def to_mesh(self, outfilename, projection=None, z=None):
"""export grid to mesh file
Parameters
----------
outfilename : str
path of new mesh file
projection : str, optional
WKT projection string, by default 'LONG/LAT'
z : float or array(float), optional
bathymetry values for each node, by default 0
if array: must have length=(nx+1)*(ny+1)
"""
if projection is None:
projection = "LONG/LAT"
# get node based grid
xn = Grid2D._centers_to_nodes(self.x)
yn = Grid2D._centers_to_nodes(self.y)
gn = Grid2D(xn, yn)
x = gn.xy[:, 0]
y = gn.xy[:, 1]
if z is None:
z = np.zeros(gn.n)
else:
if np.isscalar(z):
z = z * np.ones(gn.n)
else:
if len(z) != gn.n:
raise ValueError(
"z must either be scalar or have length of nodes ((nx+1)*(ny+1))"
)
codes = np.zeros(gn.n, dtype=int)
codes[y == gn.bbox.top] = 5 # north
codes[x == gn.bbox.right] = 4 # east
codes[y == gn.bbox.bottom] = 3 # south
codes[x == gn.bbox.left] = 2 # west
codes[(y == gn.bbox.top) & (x == gn.bbox.left)] = 5 # corner->north
builder = MeshBuilder()
builder.SetNodes(x, y, z, codes)
elem_table = gn._to_element_table(index_base=1)
builder.SetElements(asnetarray_v2(elem_table))
builder.SetProjection(projection)
quantity = eumQuantity.Create(EUMType.Bathymetry, EUMUnit.meter)
builder.SetEumQuantity(quantity)
newMesh = builder.CreateMesh()
newMesh.Write(outfilename)
def _setup_header(self):
factory = DfsFactory()
builder = DfsBuilder.Create(self._title, "DFS", 0)
builder.SetDataType(1)
builder.SetGeographicalProjection(factory.CreateProjectionUndefined())
system_start_time = to_dotnet_datetime(self._start_time)
if self._is_equidistant:
temporal_axis = factory.CreateTemporalEqCalendarAxis(
self._timeseries_unit, system_start_time, 0, self._dt
)
else:
temporal_axis = factory.CreateTemporalNonEqCalendarAxis(
self._timeseries_unit, system_start_time
)
builder.SetTemporalAxis(temporal_axis)
builder.SetItemStatisticsType(StatType.RegularStat)
dtype_dfs = self._to_dfs_datatype(self._dtype)
for i in range(self._n_items):
item = self._items[i]
newitem = builder.CreateDynamicItemBuilder()
quantity = eumQuantity.Create(item.type, item.unit)
newitem.Set(
item.name, quantity, dtype_dfs,
)
if self._data_value_type is not None:
newitem.SetValueType(self._data_value_type[i])
else:
newitem.SetValueType(DataValueType.Instantaneous)
newitem.SetAxis(factory.CreateAxisEqD0())
builder.AddDynamicItem(newitem.GetDynamicItemInfo())
try:
builder.CreateFile(self._filename)
except IOError:
raise IOError(f"Cannot create dfs0 file: {self._filename}")
return builder.GetFile()
def _setup_header(self, filename):
system_start_time = to_dotnet_datetime(self._start_time)
self._builder.SetDataType(0)
if self._coordinate[0] == "LONG/LAT":
proj = self._factory.CreateProjectionGeoOrigin(*self._coordinate)
else:
if self._override_coordinates:
proj = self._factory.CreateProjectionProjOrigin(*self._coordinate)
else:
proj = self._factory.CreateProjectionGeoOrigin(*self._coordinate)
self._builder.SetGeographicalProjection(proj)
if self._is_equidistant:
self._builder.SetTemporalAxis(
self._factory.CreateTemporalEqCalendarAxis(
self._timeseries_unit, system_start_time, 0, self._dt
)
)
else:
self._builder.SetTemporalAxis(
self._factory.CreateTemporalNonEqCalendarAxis(
self._timeseries_unit, system_start_time
)
)
for item in self._items:
self._builder.AddDynamicItem(
item.name,
eumQuantity.Create(item.type, item.unit),
DfsSimpleType.Float,
DataValueType.Instantaneous,
)
try:
self._builder.CreateFile(filename)
except IOError:
# TODO does this make sense?
print("cannot create dfs file: ", filename)
return self._builder.GetFile()
def to_mesh(self, outfilename, projection=None, z=None):
"""export grid to mesh file
Parameters
----------
outfilename : str
path of new mesh file
projection : str, optional
WKT projection string, by default 'LONG/LAT'
z : array, optional
array of bathymetry values for each node, by default 0
"""
if projection is None:
projection = "LONG/LAT"
x = self.xy[:, 0]
y = self.xy[:, 1]
if z is None:
z = np.zeros(self.n)
codes = np.zeros(self.n, dtype=int)
codes[y == self.y1] = 5 # north
codes[x == self.x1] = 4 # east
codes[y == self.y0] = 3 # south
codes[x == self.x0] = 2 # west
codes[(y == self.y1) & (x == self.x0)] = 5 # corner->north
builder = MeshBuilder()
builder.SetNodes(x, y, z, codes)
elem_table = self._to_element_table(index_base=1)
builder.SetElements(asnetarray_v2(elem_table))
builder.SetProjection(projection)
quantity = eumQuantity.Create(EUMType.Bathymetry, EUMUnit.meter)
builder.SetEumQuantity(quantity)
newMesh = builder.CreateMesh()
newMesh.Write(outfilename)
def create(
self,
filename,
data,
start_time=None,
dt=1,
datetimes=None,
items=None,
length_x=1,
length_y=1,
x0=0,
y0=0,
coordinate=None,
timeseries_unit=TimeStep.SECOND,
title=None,
):
"""
Create a dfs2 file
Parameters
----------
filename: str
Location to write the dfs2 file
data: list[np.array]
list of matrices, one for each item. Matrix dimension: time, y, x
start_time: datetime, optional
start date of type datetime.
timeseries_unit: Timestep, optional
TimeStep default TimeStep.SECOND
dt: float, optional
The time step. Therefore dt of 5.5 with timeseries_unit of TimeStep.MINUTE
means 5 mins and 30 seconds. Default 1
datetimes: list[datetime], optional
datetimes, creates a non-equidistant calendar axis
items: list[ItemInfo], optional
List of ItemInfo corresponding to a variable types (ie. Water Level).
coordinate:
['UTM-33', 12.4387, 55.2257, 327] for UTM, Long, Lat, North to Y orientation. Note: long, lat in decimal degrees
x0: float, optional
Lower right position
x0: float, optional
Lower right position
length_x: float, optional
length of each grid in the x direction (projection units)
length_y: float, optional
length of each grid in the y direction (projection units)
title: str, optional
title of the dfs2 file. Default is blank.
"""
if title is None:
title = ""
n_time_steps = np.shape(data[0])[0]
number_y = np.shape(data[0])[1]
number_x = np.shape(data[0])[2]
n_items = len(data)
if start_time is None:
start_time = datetime.now()
if coordinate is None:
coordinate = ["LONG/LAT", 0, 0, 0]
if items is None:
items = [ItemInfo(f"temItem {i+1}") for i in range(n_items)]
if not all(np.shape(d)[0] == n_time_steps for d in data):
raise Warning(
"ERROR data matrices in the time dimension do not all match in the data list. "
"Data is list of matices [t,y,x]")
if not all(np.shape(d)[1] == number_y for d in data):
raise Warning(
"ERROR data matrices in the Y dimension do not all match in the data list. "
"Data is list of matices [t,y,x]")
if not all(np.shape(d)[2] == number_x for d in data):
raise Warning(
"ERROR data matrices in the X dimension do not all match in the data list. "
"Data is list of matices [t,y,x,]")
if len(items) != n_items:
raise Warning(
"number of items must correspond to the number of arrays in data list"
)
if datetimes is None:
equidistant = True
if not type(start_time) is datetime:
raise Warning("start_time must be of type datetime ")
else:
equidistant = False
start_time = datetimes[0]
# if not isinstance(timeseries_unit, int):
# raise Warning("timeseries_unit must be an integer. timeseries_unit: second=1400, minute=1401, hour=1402, "
# "day=1403, month=1405, year= 1404See dfsutil options for help ")
system_start_time = System.DateTime(
start_time.year,
start_time.month,
start_time.day,
start_time.hour,
start_time.minute,
start_time.second,
)
# Create an empty dfs2 file object
factory = DfsFactory()
builder = Dfs2Builder.Create(title, "mikeio", 0)
# Set up the header
builder.SetDataType(0)
if coordinate[0] == "LONG/LAT":
builder.SetGeographicalProjection(
factory.CreateProjectionGeoOrigin(coordinate[0], coordinate[1],
coordinate[2],
coordinate[3]))
else:
builder.SetGeographicalProjection(
factory.CreateProjectionProjOrigin(coordinate[0],
coordinate[1],
coordinate[2],
coordinate[3]))
if equidistant:
builder.SetTemporalAxis(
factory.CreateTemporalEqCalendarAxis(timeseries_unit,
system_start_time, 0, dt))
else:
builder.SetTemporalAxis(
factory.CreateTemporalNonEqCalendarAxis(
eumUnit.eumUsec, system_start_time))
builder.SetSpatialAxis(
factory.CreateAxisEqD2(eumUnit.eumUmeter, number_x, x0, length_x,
number_y, y0, length_y))
for i in range(n_items):
builder.AddDynamicItem(
items[i].name,
eumQuantity.Create(items[i].type, items[i].unit),
DfsSimpleType.Float,
DataValueType.Instantaneous,
)
try:
builder.CreateFile(filename)
except IOError:
print("cannot create dfs2 file: ", filename)
dfs = builder.GetFile()
deletevalue = dfs.FileInfo.DeleteValueFloat # -1.0000000031710769e-30
for i in range(n_time_steps):
for item in range(n_items):
d = data[item][i, :, :]
d[np.isnan(d)] = deletevalue
d = d.reshape(number_y, number_x)
d = np.flipud(d)
darray = Array[System.Single](np.array(
d.reshape(d.size, 1)[:, 0]))
if equidistant:
dfs.WriteItemTimeStepNext(0, darray)
else:
t = datetimes[i]
relt = (t - start_time).seconds
dfs.WriteItemTimeStepNext(relt, darray)
dfs.Close()
def create(
self,
filename,
data,
start_time=None,
timeseries_unit=TimeStep.SECOND,
dt=1.0,
datetimes=None,
items=None,
title=None,
data_value_type=None,
):
"""Create a dfs0 file.
Parameters
----------
filename: str
Full path and filename to dfs0 to be created.
data: list[np.array]
values
start_time: datetime.datetime, , optional
start date of type datetime.
timeseries_unit: Timestep, optional
Timestep unitdefault Timestep.SECOND
dt: float, optional
the time step. Therefore dt of 5.5 with timeseries_unit of minutes
means 5 mins and 30 seconds. default to 1.0
items: list[ItemInfo], optional
List of ItemInfo corresponding to a variable types (ie. Water Level).
title: str, optional
title
data_value_type: list[DataValueType], optional
DataValueType default DataValueType.INSTANTANEOUS
"""
if title is None:
title = "dfs0 file"
n_items = len(data)
n_time_steps = np.shape(data[0])[0]
if start_time is None:
start_time = datetime.now()
if items is None:
items = [ItemInfo(f"temItem {i+1}") for i in range(n_items)]
if len(items) != n_items:
raise Warning(
"names must be an array of strings with the same number of elements as data columns"
)
if datetimes is None:
equidistant = True
if not type(start_time) is datetime:
raise Warning("start_time must be of type datetime ")
dt = np.float(dt)
datetimes = np.array(
[
start_time + timedelta(seconds=(step * dt))
for step in np.arange(n_time_steps)
]
)
else:
start_time = datetimes[0]
equidistant = False
# if not isinstance(timeseries_unit, int):
# raise Warning("timeseries_unit must be an integer. See dfsutil options for help ")
system_start_time = to_dotnet_datetime(start_time)
factory = DfsFactory()
builder = DfsBuilder.Create(title, "DFS", 0)
builder.SetDataType(1)
builder.SetGeographicalProjection(factory.CreateProjectionUndefined())
if equidistant:
builder.SetTemporalAxis(
factory.CreateTemporalEqCalendarAxis(
timeseries_unit, system_start_time, 0, dt
)
)
else:
builder.SetTemporalAxis(
factory.CreateTemporalNonEqCalendarAxis(
timeseries_unit, system_start_time
)
)
builder.SetItemStatisticsType(StatType.RegularStat)
for i in range(n_items):
item = builder.CreateDynamicItemBuilder()
item.Set(
items[i].name,
eumQuantity.Create(items[i].type, items[i].unit),
DfsSimpleType.Float,
)
if data_value_type is not None:
item.SetValueType(data_value_type[i])
else:
item.SetValueType(DataValueType.Instantaneous)
item.SetAxis(factory.CreateAxisEqD0())
builder.AddDynamicItem(item.GetDynamicItemInfo())
try:
builder.CreateFile(filename)
except IOError:
print("cannot create dfso file: ", filename)
dfs = builder.GetFile()
delete_value = dfs.FileInfo.DeleteValueFloat
for i in range(n_items):
d = data[i]
d[np.isnan(d)] = delete_value
data1 = np.stack(data, axis=1)
t_seconds = [(t - datetimes[0]).total_seconds() for t in datetimes]
Dfs0Util.WriteDfs0DataDouble(dfs, t_seconds, to_dotnet_array(data1))
dfs.Close()
def create(
self,
meshfilename,
filename,
data,
start_time=None,
dt=1,
timeseries_unit=TimeStep.SECOND,
items=None,
title=None,
):
"""Create a dfsu file
Parameters
-----------
meshfilename: str,
full path to a mesh or dfsu file
filename: str
full path to the new dfsu file
data: list[np.array]
list of matrices, one for each item. Matrix dimension: time, y, x
start_time: datetime, optional
start datetime, default is datetime.now()
dt: float
The time step. Therefore dt of 5.5 with timeseries_unit of TimeStep.MINUTE
means 5 mins and 30 seconds. Default 1
timeseries_unit: TimeStep, optional
default TimeStep.SECOND
unit: list[ItemInfo], optional
Name, item, unit, default is undefined
title: str
title of the dfsu file. Default is blank.
"""
n_items = len(data)
n_time_steps = np.shape(data[0])[0]
if start_time is None:
start_time = datetime.now()
if items is None:
items = [ItemInfo(f"temItem {i+1}") for i in range(n_items)]
if title is None:
title = ""
system_start_time = to_dotnet_datetime(start_time)
# Default filetype;
filetype = DfsuFileType.Dfsu2D
_, ext = os.path.splitext(meshfilename)
if ext == ".mesh":
source = MeshFile.ReadMesh(meshfilename)
projstr = source.ProjectionString
elif ext == ".dfsu":
source = DfsuFile.Open(meshfilename)
projstr = source.Projection.WKTString
filetype = source.DfsuFileType
xn = source.X
yn = source.Y
# zn have to be Single precision??
zn = to_dotnet_float_array(np.array(list(source.Z)))
nodecodes = source.Code
elementtable = source.ElementTable
builder = DfsuBuilder.Create(filetype)
builder.SetNodes(xn, yn, zn, nodecodes)
builder.SetElements(elementtable)
builder.SetNodeIds(source.NodeIds)
builder.SetElementIds(source.ElementIds)
factory = DfsFactory()
proj = factory.CreateProjection(projstr)
builder.SetProjection(proj)
builder.SetTimeInfo(system_start_time, dt)
builder.SetZUnit(eumUnit.eumUmeter)
if filetype != DfsuFileType.Dfsu2D:
builder.SetNumberOfSigmaLayers(source.NumberOfSigmaLayers)
for item in items:
if item.name != "Z coordinate":
builder.AddDynamicItem(
item.name, eumQuantity.Create(item.type, item.unit))
try:
dfs = builder.CreateFile(filename)
except IOError:
print("cannot create dfsu file: ", filename)
deletevalue = dfs.DeleteValueFloat
try:
# Add data for all item-timesteps, copying from source
for i in range(n_time_steps):
for item in range(n_items):
d = data[item][i, :]
d[np.isnan(d)] = deletevalue
darray = to_dotnet_float_array(d)
dfs.WriteItemTimeStepNext(0, darray)
dfs.Close()
except Exception as e:
print(e)
dfs.Close()
os.remove(filename)
def write(
self,
filename,
data,
start_time=None,
dt=1,
items=None,
dx=1.0,
dy=1.0,
dz=1.0,
x0=0,
y0=0,
coordinate=None,
timeseries_unit=TimeStepUnit.SECOND,
title=None,
):
"""
Write a dfs3 file
Parameters
----------
filename: str
Location to write the dfs3 file
data: list[np.array]
list of matrices, one for each item. Matrix dimension: time, z, y, x
start_time: datetime, optional
start date of type datetime.
timeseries_unit: Timestep, optional
TimeStep default TimeStep.SECOND
dt: float, optional
The time step. Therefore dt of 5.5 with timeseries_unit of TimeStep.MINUTE
means 5 mins and 30 seconds. Default 1
items: list[ItemInfo], optional
List of ItemInfo corresponding to a variable types (ie. Water Level).
coordinate:
['UTM-33', 12.4387, 55.2257, 327] for UTM, Long, Lat, North to Y orientation. Note: long, lat in decimal degrees
x0: float, optional
Lower right position
y0: float, optional
Lower right position
dx: float, optional
length of each grid in the x direction (projection units)
dy: float, optional
length of each grid in the y direction (projection units)
dz: float, optional
length of each grid in the z direction (projection units)
title: str, optional
title of the dfs2 file. Default is blank.
"""
if title is None:
title = "dfs3 file"
n_time_steps = np.shape(data[0])[0]
number_z = np.shape(data[0])[1]
number_y = np.shape(data[0])[2]
number_x = np.shape(data[0])[3]
n_items = len(data)
system_start_time = to_dotnet_datetime(start_time)
# Create an empty dfs3 file object
factory = DfsFactory()
builder = Dfs3Builder.Create(title, "mikeio", 0)
# Set up the header
builder.SetDataType(1)
builder.SetGeographicalProjection(
factory.CreateProjectionGeoOrigin(*coordinate))
builder.SetTemporalAxis(
factory.CreateTemporalEqCalendarAxis(timeseries_unit,
system_start_time, 0, dt))
builder.SetSpatialAxis(
factory.CreateAxisEqD3(
eumUnit.eumUmeter,
number_x,
x0,
dx,
number_y,
y0,
dy,
number_z,
0,
dz,
))
for i in range(n_items):
builder.AddDynamicItem(
items[i].name,
eumQuantity.Create(items[i].type, items[i].unit),
DfsSimpleType.Float,
DataValueType.Instantaneous,
)
try:
builder.CreateFile(filename)
except IOError:
print("cannot create dfs3 file: ", filename)
dfs = builder.GetFile()
deletevalue = dfs.FileInfo.DeleteValueFloat # -1.0000000031710769e-30
for i in range(n_time_steps):
for item in range(n_items):
d = data[item][i]
d[np.isnan(d)] = deletevalue
d = np.flipud(d)
darray = to_dotnet_float_array(d.reshape(d.size, 1)[:, 0])
dfs.WriteItemTimeStepNext(0, darray)
dfs.Close()
def create(self,
filename,
data,
start_time=None,
dt=1,
length_x=1,
x0=0,
coordinate=None,
timeseries_unit=TimeStep.SECOND,
variable_type=None,
unit=None,
names=None,
title=None):
"""
Creates a dfs1 file
filename:
Location to write the dfs1 file
data:
list of matrices, one for each item. Matrix dimension: x, time
start_time:
start date of type datetime.
timeseries_unit:
TimeStep default TimeStep.SECOND
dt:
The time step (double based on the timeseries_unit). Therefore dt of 5.5 with timeseries_unit of minutes
means 5 mins and 30 seconds.
variable_type:
Array integers corresponding to a variable types (ie. Water Level). Use dfsutil type_list
to figure out the integer corresponding to the variable.
unit:
Array integers corresponding to the unit corresponding to the variable types The unit (meters, seconds),
use dfsutil unit_list to figure out the corresponding unit for the variable.
coordinate:
['UTM-33', 12.4387, 55.2257, 327] for UTM, Long, Lat, North to Y orientation. Note: long, lat in decimal degrees
OR
[TODO: Support not Local Coordinates ...]
x0:
Lower right position
length_x:
length of each grid in the x direction (meters)
names:
array of names (ie. array of strings). (can be blank)
title:
title of the dfs2 file (can be blank)
"""
if title is None:
title = ""
n_time_steps = np.shape(data[0])[0]
number_x = np.shape(data[0])[1]
n_items = len(data)
if start_time is None:
start_time = datetime.now()
if coordinate is None:
coordinate = ['LONG/LAT', 0, 0, 0]
if names is None:
names = [f"Item {i+1}" for i in range(n_items)]
if variable_type is None:
variable_type = [999] * n_items
if unit is None:
unit = [0] * n_items
if not all(np.shape(d)[0] == n_time_steps for d in data):
raise Warning(
"ERROR data matrices in the time dimension do not all match in the data list. "
"Data is list of matices [t, x]")
if not all(np.shape(d)[1] == number_x for d in data):
raise Warning(
"ERROR data matrices in the X dimension do not all match in the data list. "
"Data is list of matices [t, x]")
if len(names) != n_items:
raise Warning(
"names must be an array of strings with the same number as matrices in data list"
)
if len(variable_type) != n_items or not all(
isinstance(item, int) and 0 <= item < 1e15
for item in variable_type):
raise Warning(
"type if specified must be an array of integers (enuType) with the same number of "
"elements as data columns")
if len(unit) != n_items or not all(
isinstance(item, int) and 0 <= item < 1e15 for item in unit):
raise Warning(
"unit if specified must be an array of integers (enuType) with the same number of "
"elements as data columns")
if not type(start_time) is datetime:
raise Warning("start_time must be of type datetime ")
#if not isinstance(timeseries_unit, int):
# raise Warning("timeseries_unit must be an integer. timeseries_unit: second=1400, minute=1401, hour=1402, "
# "day=1403, month=1405, year= 1404See dfsutil options for help ")
system_start_time = System.DateTime(start_time.year, start_time.month,
start_time.day, start_time.hour,
start_time.minute,
start_time.second)
# Create an empty dfs1 file object
factory = DfsFactory()
builder = Dfs1Builder.Create(title, 'mikeio', 0)
# Set up the header
builder.SetDataType(0)
builder.SetGeographicalProjection(
factory.CreateProjectionGeoOrigin(coordinate[0], coordinate[1],
coordinate[2], coordinate[3]))
builder.SetTemporalAxis(
factory.CreateTemporalEqCalendarAxis(timeseries_unit,
system_start_time, 0, dt))
builder.SetSpatialAxis(
factory.CreateAxisEqD1(eumUnit.eumUmeter, number_x, x0, length_x))
for i in range(n_items):
builder.AddDynamicItem(
names[i], eumQuantity.Create(variable_type[i], unit[i]),
DfsSimpleType.Float, DataValueType.Instantaneous)
try:
builder.CreateFile(filename)
except IOError:
print('cannot create dfs2 file: ', filename)
dfs = builder.GetFile()
deletevalue = dfs.FileInfo.DeleteValueFloat #-1.0000000031710769e-30
for i in range(n_time_steps):
for item in range(n_items):
d = data[item][i, :]
d[np.isnan(d)] = deletevalue
darray = Array[System.Single](np.array(
d.reshape(d.size, 1)[:, 0]))
dfs.WriteItemTimeStepNext(0, darray)
dfs.Close()
# Add custom block
# M21_Misc : {orientation (should match projection), drying depth, -900=has projection, land value, 0, 0, 0}
cbdata = Array.CreateInstance(System.Single, 7)
cbdata[0] = 327
cbdata[1] = 0.2
cbdata[2] = -900
cbdata[3] = 10
cbdata[4] = 0
cbdata[5] = 0
cbdata[6] = 0
builder.AddCustomBlock(factory.CreateCustomBlock('M21_Misc', cbdata))
# Add two items
builder.AddDynamicItem(
'H Water Depth m',
eumQuantity.Create(eumItem.eumIWaterLevel, eumUnit.eumUmeter),
DfsSimpleType.Float, DataValueType.Instantaneous)
builder.AddDynamicItem(
'P Flux m^3/s/m',
eumQuantity.Create(eumItem.eumIFlowFlux, eumUnit.eumUm3PerSecPerM),
DfsSimpleType.Float, DataValueType.Instantaneous)
builder.AddDynamicItem(
'Q Flux m^3/s/m',
eumQuantity.Create(eumItem.eumIFlowFlux, eumUnit.eumUm3PerSecPerM),
DfsSimpleType.Float, DataValueType.Instantaneous)
# Create the file ready for data
builder.CreateFile(filename)
# Add one static item, containing bathymetry data
data = Array.CreateInstance(System.Single, xysize)
def create(
self,
filename,
data,
start_time=None,
dt=1,
items=None,
length_x=1,
x0=0,
coordinate=None,
timeseries_unit=TimeStep.SECOND,
title=None,
):
"""
Create a dfs1 file
Parameters
----------
filename: str
Location to write the dfs1 file
data: list[np.array]
list of matrices, one for each item. Matrix dimension: x, time
start_time: datetime, optional
start datetime
timeseries_unit: Timestep, optional
TimeStep unit default TimeStep.SECOND
dt: float
The time step (double based on the timeseries_unit). Therefore dt of 5.5 with timeseries_unit of minutes
means 5 mins and 30 seconds.
items: list[ItemInfo], optional
List of ItemInfo corresponding to a variable types (ie. Water Level).
coordinate:
['UTM-33', 12.4387, 55.2257, 327] for UTM, Long, Lat, North to Y orientation. Note: long, lat in decimal degrees
OR
[TODO: Support not Local Coordinates ...]
x0:
Lower right position
length_x:
length of each grid in the x direction (meters)
title:
title of the dfs2 file (can be blank)
"""
if title is None:
title = ""
n_time_steps = np.shape(data[0])[0]
number_x = np.shape(data[0])[1]
n_items = len(data)
if start_time is None:
start_time = datetime.now()
if coordinate is None:
coordinate = ["LONG/LAT", 0, 0, 0]
if items is None:
items = [ItemInfo(f"temItem {i+1}") for i in range(n_items)]
if not all(np.shape(d)[0] == n_time_steps for d in data):
raise Warning(
"ERROR data matrices in the time dimension do not all match in the data list. "
"Data is list of matices [t, x]")
if not all(np.shape(d)[1] == number_x for d in data):
raise Warning(
"ERROR data matrices in the X dimension do not all match in the data list. "
"Data is list of matices [t, x]")
if len(items) != n_items:
raise Warning(
"names must be an array of strings with the same number as matrices in data list"
)
if not type(start_time) is datetime:
raise Warning("start_time must be of type datetime ")
system_start_time = System.DateTime(
start_time.year,
start_time.month,
start_time.day,
start_time.hour,
start_time.minute,
start_time.second,
)
# Create an empty dfs1 file object
factory = DfsFactory()
builder = Dfs1Builder.Create(title, "mikeio", 0)
# Set up the header
builder.SetDataType(0)
builder.SetGeographicalProjection(
factory.CreateProjectionGeoOrigin(coordinate[0], coordinate[1],
coordinate[2], coordinate[3]))
builder.SetTemporalAxis(
factory.CreateTemporalEqCalendarAxis(timeseries_unit,
system_start_time, 0, dt))
builder.SetSpatialAxis(
factory.CreateAxisEqD1(eumUnit.eumUmeter, number_x, x0, length_x))
for i in range(n_items):
builder.AddDynamicItem(
items[i].name,
eumQuantity.Create(items[i].type, items[i].unit),
DfsSimpleType.Float,
DataValueType.Instantaneous,
)
try:
builder.CreateFile(filename)
except IOError:
print("cannot create dfs2 file: ", filename)
dfs = builder.GetFile()
deletevalue = dfs.FileInfo.DeleteValueFloat # -1.0000000031710769e-30
for i in range(n_time_steps):
for item in range(n_items):
d = data[item][i, :]
d[np.isnan(d)] = deletevalue
darray = Array[System.Single](np.array(
d.reshape(d.size, 1)[:, 0]))
dfs.WriteItemTimeStepNext(0, darray)
dfs.Close()
def create(
self,
meshfilename,
filename,
data,
start_time=None,
dt=1,
timeseries_unit=TimeStep.SECOND,
variable_type=None,
unit=None,
names=None,
title=None,
):
n_items = len(data)
n_time_steps = np.shape(data[0])[0]
if start_time is None:
start_time = datetime.now()
if names is None:
names = [f"Item {i+1}" for i in range(n_items)]
if variable_type is None:
variable_type = [999] * n_items
if unit is None:
unit = [0] * n_items
if title is None:
title = ""
system_start_time = System.DateTime(
start_time.year,
start_time.month,
start_time.day,
start_time.hour,
start_time.minute,
start_time.second,
)
mesh = MeshFile.ReadMesh(meshfilename)
# TODO support all types of Dfsu
builder = DfsuBuilder.Create(DfsuFileType.Dfsu2D)
# Setup header and geometry, copy from source file
# zn have to be Single precision??
zn = Array[System.Single](list(mesh.Z))
builder.SetNodes(mesh.X, mesh.Y, zn, mesh.Code)
builder.SetElements(mesh.ElementTable)
factory = DfsFactory()
proj = factory.CreateProjection(mesh.ProjectionString)
builder.SetProjection(proj)
builder.SetTimeInfo(system_start_time, dt)
builder.SetZUnit(eumUnit.eumUmeter)
for i in range(n_items):
builder.AddDynamicItem(
names[i], eumQuantity.Create(variable_type[i], unit[i])
)
try:
dfs = builder.CreateFile(filename)
except IOError:
print("cannot create dfsu file: ", filename)
deletevalue = dfs.DeleteValueFloat
# Add data for all item-timesteps, copying from source
for i in range(n_time_steps):
for item in range(n_items):
d = data[item][i, :]
d[np.isnan(d)] = deletevalue
darray = Array[System.Single](np.array(d.reshape(d.size, 1)[:, 0]))
dfs.WriteItemTimeStepNext(0, darray)
dfs.Close()
def create(
self,
meshfilename,
filename,
data,
start_time=None,
dt=1,
timeseries_unit=TimeStep.SECOND,
items=None,
title=None,
):
"""Create a dfsu file
Parameters
-----------
meshfilename: str,
full path to a valid mesh file
filename: str
full path to the new dfsu file
data: list[np.array]
list of matrices, one for each item. Matrix dimension: time, y, x
start_time: datetime, optional
start datetime, default is datetime.now()
dt: float
The time step. Therefore dt of 5.5 with timeseries_unit of TimeStep.MINUTE
means 5 mins and 30 seconds. Default 1
timeseries_unit: TimeStep, optional
default TimeStep.SECOND
unit: list[ItemInfo], optional
Name, item, unit, default is undefined
title: str
title of the dfsu file. Default is blank.
"""
n_items = len(data)
n_time_steps = np.shape(data[0])[0]
if start_time is None:
start_time = datetime.now()
if items is None:
items = [ItemInfo(f"temItem {i+1}") for i in range(n_items)]
if title is None:
title = ""
system_start_time = System.DateTime(
start_time.year,
start_time.month,
start_time.day,
start_time.hour,
start_time.minute,
start_time.second,
)
mesh = MeshFile.ReadMesh(meshfilename)
# TODO support all types of Dfsu
builder = DfsuBuilder.Create(DfsuFileType.Dfsu2D)
# Setup header and geometry, copy from source file
# zn have to be Single precision??
zn = Array[System.Single](list(mesh.Z))
builder.SetNodes(mesh.X, mesh.Y, zn, mesh.Code)
builder.SetElements(mesh.ElementTable)
factory = DfsFactory()
proj = factory.CreateProjection(mesh.ProjectionString)
builder.SetProjection(proj)
builder.SetTimeInfo(system_start_time, dt)
builder.SetZUnit(eumUnit.eumUmeter)
for item in items:
builder.AddDynamicItem(item.name,
eumQuantity.Create(item.type, item.unit))
try:
dfs = builder.CreateFile(filename)
except IOError:
print("cannot create dfsu file: ", filename)
deletevalue = dfs.DeleteValueFloat
# Add data for all item-timesteps, copying from source
for i in range(n_time_steps):
for item in range(n_items):
d = data[item][i, :]
d[np.isnan(d)] = deletevalue
darray = Array[System.Single](np.array(
d.reshape(d.size, 1)[:, 0]))
dfs.WriteItemTimeStepNext(0, darray)
dfs.Close()
def create(self,
filename,
data,
start_time=None,
timeseries_unit=TimeStep.SECOND,
dt=1,
datetimes=None,
variable_type=None,
unit=None,
names=None,
title=None,
data_value_type=None):
"""create creates a dfs0 file.
filename:
Full path and filename to dfs0 to be created.
data:
a numpy matrix
start_time:
start date of type datetime.
timeseries_unit:
Timestep default Timestep.SECOND
dt:
the time step. Therefore dt of 5.5 with timeseries_unit of minutes
means 5 mins and 30 seconds. default to 1
variable_type:
Array integers corresponding to a variable types (ie. Water Level). Use dfsutil type_list
to figure out the integer corresponding to the variable.
unit:
Array integers corresponding to the unit corresponding to the variable types The unit (meters, seconds),
use dfsutil unit_list to figure out the corresponding unit for the variable.
names:
array of names (ie. array of strings)
title:
title (string)
data_value_type:
DataValueType default DataValueType.INSTANTANEOUS
"""
if title is None:
title = "dfs0 file"
n_items = len(data)
n_time_steps = np.shape(data[0])[0]
if start_time is None:
start_time = datetime.now()
if names is None:
names = [f"Item {i+1}" for i in range(n_items)]
if variable_type is None:
variable_type = [999] * n_items
if unit is None:
unit = [0] * n_items
if names is not None and len(names) != n_items:
raise Warning(
"names must be an array of strings with the same number of elements as data columns"
)
if len(variable_type) != n_items:
raise Warning(
"type if specified must be an array of integers (eumType) with the same number of "
"elements as data columns")
if len(unit) != n_items:
raise Warning(
"unit if specified must be an array of integers (eumType) with the same number of "
"elements as data columns")
if datetimes is None:
equidistant = True
if not type(start_time) is datetime:
raise Warning("start_time must be of type datetime ")
else:
start_time = datetimes[0]
equidistant = False
#if not isinstance(timeseries_unit, int):
# raise Warning("timeseries_unit must be an integer. See dfsutil options for help ")
system_start_time = System.DateTime(start_time.year, start_time.month,
start_time.day, start_time.hour,
start_time.minute,
start_time.second)
factory = DfsFactory()
builder = DfsBuilder.Create(title, 'DFS', 0)
builder.SetDataType(1)
builder.SetGeographicalProjection(factory.CreateProjectionUndefined())
if equidistant:
builder.SetTemporalAxis(
factory.CreateTemporalEqCalendarAxis(timeseries_unit,
system_start_time, 0, dt))
else:
builder.SetTemporalAxis(
factory.CreateTemporalNonEqCalendarAxis(
timeseries_unit, system_start_time))
builder.SetItemStatisticsType(StatType.RegularStat)
for i in range(n_items):
item = builder.CreateDynamicItemBuilder()
if type is not None:
item.Set(names[i], eumQuantity.Create(variable_type[i],
unit[i]),
DfsSimpleType.Float)
else:
item.Set(str(i),
eumQuantity.Create(eumItem.eumIItemUndefined, 0),
DfsSimpleType.Float)
if data_value_type is not None:
item.SetValueType(data_value_type[i])
else:
item.SetValueType(DataValueType.Instantaneous)
item.SetAxis(factory.CreateAxisEqD0())
builder.AddDynamicItem(item.GetDynamicItemInfo())
try:
builder.CreateFile(filename)
except IOError:
print('cannot create dfso file: ', filename)
dfs = builder.GetFile()
delete_value = dfs.FileInfo.DeleteValueFloat
for i in range(n_items):
d = data[i]
d[np.isnan(d)] = delete_value
# COPY OVER THE DATA
for it in range(n_time_steps):
for ii in range(n_items):
d = Array[System.Single](np.array(data[ii][it:it + 1]))
if equidistant:
dfs.WriteItemTimeStepNext(it, d)
else:
dt = (datetimes[it] - datetimes[0]).total_seconds()
dfs.WriteItemTimeStepNext(dt, d)
dfs.Close()
