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. |
| dataset._data_plot._DatasetPlotter | |
| dataset._data_plot._DataArrayPlotter | Context aware plotter (sensible plotting according to geometry). |
| dataset._data_plot._DataArrayPlotterGrid1D | Plot a DataArray with a Grid1D geometry. |
| dataset._data_plot._DataArrayPlotterGrid2D | Plot a DataArray with a Grid2D geometry. |
| dataset._data_plot._DataArrayPlotterFM | Plot a DataArray with a GeometryFM geometry. |
| dataset._data_plot._DataArrayPlotterFMVerticalProfile | Plot a DataArray with a 2DV GeometryFMVerticalProfile geometry. |
| dataset._data_plot._DataArrayPlotterFMVerticalColumn | Plot a DataArray with a GeometryFMVerticalColumn geometry. |
Geometry
| Grid1D | |
| Grid2D | 2D grid. |
| Grid3D | 3D grid. |
| Mesh | The Mesh class is initialized with a mesh file. |
| spatial.GeometryFM2D | |
| spatial.GeometryFM3D | |
| spatial.GeometryFMVerticalProfile | |
| spatial.GeometryFMVerticalColumn | A 3d geometry with consisting of a single vertical column. |
| spatial._FM_geometry._GeometryFMPlotter | Plot GeometryFM. |
Spectral
| dfsu.DfsuSpectral | |
| spatial.GeometryFMPointSpectrum | |
| spatial.GeometryFMLineSpectrum | |
| spatial.GeometryFMAreaSpectrum |
EUM
| ItemInfo | ItemInfo. |
| EUMType | EUM type. |
| EUMUnit | EUM unit. |
Dfs
| Dfs0 | |
| Dfs1 | |
| Dfs2 | |
| Dfs3 | |
| Dfsu | |
| dfsu.Dfsu2DH | |
| dfsu.Dfsu2DV | |
| dfsu.Dfsu3D |
Generic
| 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 |