diff --git a/.gitignore b/.gitignore index 6a6a3c09c..edfdf44cf 100644 --- a/.gitignore +++ b/.gitignore @@ -25,6 +25,7 @@ cov_annotate htmlcov docs/_site +docs/user-guide/*.dfs* # generated by quartodoc docs/api/ diff --git a/docs/user-guide/dataarray.qmd b/docs/user-guide/dataarray.qmd index dcfe693e9..2019a6713 100644 --- a/docs/user-guide/dataarray.qmd +++ b/docs/user-guide/dataarray.qmd @@ -1,10 +1,9 @@ --- +title: DataArray aliases: - ../dataarray.html --- -# DataArray - The [DataArray](`mikeio.DataArray`) is the common MIKE IO data structure for *item* data from dfs files. The [](`mikeio.read`) methods returns a Dataset as a container of DataArrays (Dfs items) diff --git a/docs/user-guide/dataset.qmd b/docs/user-guide/dataset.qmd index eeb163d38..cc98fccf9 100644 --- a/docs/user-guide/dataset.qmd +++ b/docs/user-guide/dataset.qmd @@ -1,10 +1,9 @@ --- +title: Dataset aliases: - ../dataset.html --- -# Dataset - The [Dataset](`mikeio.Dataset`) is the MIKE IO data structure for data from dfs files. The [](`mikeio.read`) methods returns a Dataset as a container of [DataArray](`mikeio.DataArray`) (Dfs items). Each DataArray has the properties, *item*, *time*, *geometry* and *values*. The time and geometry are common to all DataArrays in the Dataset. diff --git a/docs/user-guide/dfs0.qmd b/docs/user-guide/dfs0.qmd index 979a0c088..b1a48c6df 100644 --- a/docs/user-guide/dfs0.qmd +++ b/docs/user-guide/dfs0.qmd @@ -1,10 +1,9 @@ --- +title: Dfs0 aliases: - ../dfs0.html --- -# Dfs0 - A dfs0 file is also called a time series file. Working with data from dfs0 files are conveniently done in one of two ways: diff --git a/docs/user-guide/dfs1.qmd b/docs/user-guide/dfs1.qmd index 9e365e9da..5e9fb09b6 100644 --- a/docs/user-guide/dfs1.qmd +++ b/docs/user-guide/dfs1.qmd @@ -1,10 +1,9 @@ --- +title: Dfs1 aliases: - ../dfs1.html --- -# Dfs1 - A dfs1 file contains node-based line series data. Dfs1 files do not contain enough metadata to determine their geographical position, but have a relative distance from the origo. diff --git a/docs/user-guide/dfs2.qmd b/docs/user-guide/dfs2.qmd index 9c869ffad..51f808899 100644 --- a/docs/user-guide/dfs2.qmd +++ b/docs/user-guide/dfs2.qmd @@ -1,11 +1,10 @@ --- +title: Dfs2 aliases: - ../dfs2.html --- -# Dfs2 - A dfs2 file is also called a grid series file. Values in a dfs2 file are ‘element based’, i.e. values are defined in the centre of each grid cell. diff --git a/docs/user-guide/dfsu.qmd b/docs/user-guide/dfsu.qmd index 567a131c4..ba522ffa4 100644 --- a/docs/user-guide/dfsu.qmd +++ b/docs/user-guide/dfsu.qmd @@ -1,4 +1,7 @@ -# Dfsu and Mesh Overview +--- +title: Dfsu +--- + Dfsu and mesh files are both flexible mesh file formats used by MIKE 21/3 engines. The .mesh file is an ASCII file for storing the flexible mesh geometry.