API Reference

Main

open	Open a dfs/mesh file (and read the header).
read	Read all or a subset of the data from a dfs file.
read_pfs	Read a pfs file to a Pfs object for further analysis/manipulation.
from_pandas	Create a Dataset from a pandas DataFrame.
from_polars	Create a Dataset from a polars DataFrame.

Dataset

DataArray	DataArray with data and metadata for a single item in a dfs file.
Dataset	Dataset containing one or more DataArrays with common geometry and time.

Geometry

Grid1D	1d spatial grid.
Grid2D	2D grid.
Grid3D	3D grid.
Mesh	The Mesh class is initialized with a mesh file.
spatial.GeometryFM2D	Flexible 2d mesh geometry.
spatial.GeometryFM3D	Flexible 3d mesh geometry.
spatial.GeometryFMVerticalProfile	Flexible mesh 2d vertical profile geometry.
spatial.GeometryFMVerticalColumn	A 3d geometry with consisting of a single vertical column.
spatial._FM_geometry._GeometryFMPlotter	Plot GeometryFM.

Spectral

dfsu.DfsuSpectral	Dfsu for Spectral data.
spatial.GeometryFMPointSpectrum	Flexible mesh point spectrum.
spatial.GeometryFMLineSpectrum	Flexible mesh line spectrum geometry.
spatial.GeometryFMAreaSpectrum	Flexible mesh area spectrum geometry.

EUM

ItemInfo	Info for dynamic items (variables).
EUMType	EUM type.
EUMUnit	EUM unit.

Dfs

Dfs0	Class for reading/writing dfs0 files.
Dfs1	Class for reading/writing dfs1 files.
Dfs2	Class for reading/writing dfs2 files.
Dfs3	Class for reading/writing dfs3 files.
Dfsu	Factory class for dfsu files.
dfsu.Dfsu2DH	Class for reading/writing dfsu 2d horizontal files.
dfsu.Dfsu2DV	Class for reading/writing dfsu 2d vertical files.
dfsu.Dfsu3D	Class for reading/writing dfsu 3d files.

Generic

Generic functions for working with all types of dfs files.

Pfs

PfsDocument	Create a PfsDocument object for reading, writing and manipulating pfs files.
PfsSection	Class for reading/writing sections in a pfs file.

Dataset plotting

Plotting functions for Dataset and DataArray objects.

dataset._DatasetPlotter	Class for plotting scatter plots from datasets.
dataset._DataArrayPlotter	Context aware plotter (sensible plotting according to geometry).
dataset._DataArrayPlotterGrid1D	Plot a DataArray with a Grid1D geometry.
dataset._DataArrayPlotterGrid2D	Plot a DataArray with a Grid2D geometry.
dataset._DataArrayPlotterFM	Plot a DataArray with a GeometryFM geometry.
dataset._DataArrayPlotterFMVerticalProfile	Plot a DataArray with a 2DV GeometryFMVerticalProfile geometry.
dataset._DataArrayPlotterFMVerticalColumn	Plot a DataArray with a GeometryFMVerticalColumn geometry.