Skip to content

Commit

Permalink
Fix page titles
Browse files Browse the repository at this point in the history
  • Loading branch information
ecomodeller committed Aug 7, 2024
1 parent 720612d commit 2f80349
Show file tree
Hide file tree
Showing 7 changed files with 10 additions and 11 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ cov_annotate
htmlcov

docs/_site
docs/user-guide/*.dfs*

# generated by quartodoc
docs/api/
Expand Down
3 changes: 1 addition & 2 deletions docs/user-guide/dataarray.qmd
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
3 changes: 1 addition & 2 deletions docs/user-guide/dataset.qmd
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
3 changes: 1 addition & 2 deletions docs/user-guide/dfs0.qmd
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
3 changes: 1 addition & 2 deletions docs/user-guide/dfs1.qmd
Original file line number Diff line number Diff line change
@@ -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.


Expand Down
3 changes: 1 addition & 2 deletions docs/user-guide/dfs2.qmd
Original file line number Diff line number Diff line change
@@ -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.


Expand Down
5 changes: 4 additions & 1 deletion docs/user-guide/dfsu.qmd
Original file line number Diff line number Diff line change
@@ -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.
Expand Down

0 comments on commit 2f80349

Please sign in to comment.