Skip to content

Commit

Permalink
Generic
Browse files Browse the repository at this point in the history
  • Loading branch information
ecomodeller committed Mar 5, 2024
1 parent 740a8cc commit ab8c918
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions docs/user-guide/generic.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,26 @@ The generic module contains functionality that works for all types of dfs (dfs0,
* [`avg_time()`](`mikeio.generic.avg_time`) - Create a temporally averaged dfs file
* [`quantile()`](`mikeio.generic.quantile`) - Create a dfs file with temporal quantiles

## When to use the generic module

* The processing is not tied to the spatial dimension of the data
* When the files are large and you want to avoid reading the entire file into memory

All methods in the generic module creates a new dfs file.
## When not to use the generic module

* When you need processing depending on the spatial information in the file. For example, spatial interpolation, subsetting, etc.
* When you need more complex processing, not covered by the generic module
* When the input files data are not dfs files
* When the end result is not a dfs file

## Example

```python
>>> from mikeio import generic
>>> generic.concat(["fileA.dfs2", "fileB.dfs2"], "new_file.dfs2")
```

## Generic example notebooks
## More examples

See the [Generic notebook](../examples/Generic.qmd) for more examples.

0 comments on commit ab8c918

Please sign in to comment.