search

DHI / mikeio

Read, write and manipulate dfs0, dfs1, dfs2, dfs3, dfsu and mesh files.
https://dhi.github.io/mikeio
BSD 3-Clause "New" or "Revised" License
137 stars 55 forks source link

Collect functionality from similar (competing) libraries #8

Closed ecomodeller closed 3 years ago

ecomodeller commented 4 years ago

dhitools seem to have a lot of useful functionality

https://github.com/robjameswall/dhitools https://pypi.org/project/dhitools/

j08lue commented 4 years ago

dhitools seem to have a lot of useful functionality

Yes. The library is well maintained and well documented. So why copy? Just use it...

j08lue commented 4 years ago

sorry, did not mean to close

halvgaard commented 4 years ago

Seems that https://github.com/robjameswall/dhitools could benefit from mikeio. But mikeio should avoid the GDAL and geopandas dependencies and not consume dhitools, or did you decide on something here?

halvgaard commented 4 years ago

I needed to load a dfs0, scale the time series data and write a new dfs0 file. I compiled @jsmariegaard 's github.com/DHI/dfs-utils instead and used from python. Maybe these tools can be merged as well?

ecomodeller commented 4 years ago

GDAL and geopandas seems difficult to install via pip, and I don't want to make mikeio only available via conda. Thus, I think we have to leave GIS functionality out of mikeio.

Is there any other functionality from dhitools that we should include in mikeio somehow? Or close this issue?

j08lue commented 4 years ago

GDAL and geopandas seems difficult to install via pip

Only on Windows. On Linux there are by now zero issues with that (manylinux wheels galore).

j08lue commented 4 years ago

Still, avoiding very heavy dependencies that are only needed for an isolated set of features is a great idea. You can still ease the interface to e.g. GeoDataFrames, by returning dictionaries to directly create them from.

jsmariegaard commented 3 years ago

To qualify this discussion a bit more, I have tried to collect some important functionality in other mike libraries in the below lists. Please extend as needed. With such a list, we can prioritize what functionalities we would like to port to mikeio.

dhitools by robjameswall https://github.com/robjameswall/dhitools

DHI Matlab toolbox https://github.com/DHI/DHI-MATLAB-Toolbox

mikepy by Florian Monetti (DHI internal)

halvgaard commented 3 years ago

Nice. One way to prioritize could be to create an issue for each feature described with a few sentences and maybe with code snippets from the original source. If users and contributors really need these features then they will get implemented eventually or commented on in the issue. If there is a description there is a better chance someone might grab it. Maybe as part of a bigger related feature they are working on.

ecomodeller commented 3 years ago

Annotated list

Implemented = ✔️ Notebook example = 📓

dhitools by robjameswall https://github.com/robjameswall/dhitools

DHI Matlab toolbox https://github.com/DHI/DHI-MATLAB-Toolbox

mikepy by Florian Monetti (DHI internal)

jsmariegaard commented 3 years ago

Annotated list

Implemented = ✔️ Notebook example = 📓

dhitools by robjameswall https://github.com/robjameswall/dhitools

DHI Matlab toolbox https://github.com/DHI/DHI-MATLAB-Toolbox

mikepy by Florian Monetti (DHI internal)

MIKE Zero

MIKE Zero toolbox

MIKE tools in bin folder (no GUI)

ecomodeller commented 3 years ago

It is apparent that there is a lot of useful functionality in MIKE IO. I will close this issue and we can open more specific feature requests as the need arises.