mikeio

Read, write and manipulate dfs0, dfs1, dfs2, dfs3, dfsu and mesh files.

https://github.com/dhi/mikeio

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (13.1%) to scientific vocabulary

Keywords

dfs dhi input-output python

Keywords from Contributors

mesh interactive

Last synced: 6 months ago · JSON representation ·

Repository

Read, write and manipulate dfs0, dfs1, dfs2, dfs3, dfsu and mesh files.

Basic Info

Host: GitHub
Owner: DHI
License: bsd-3-clause
Language: Python
Default Branch: main
Homepage: https://dhi.github.io/mikeio
Size: 160 MB

Statistics

Stars: 166
Watchers: 12
Forks: 58
Open Issues: 20
Releases: 76

Topics

dfs dhi input-output python

Created about 7 years ago · Last pushed 6 months ago

Metadata Files

Readme Contributing License Code of conduct Citation

MIKE IO: input/output of MIKE files in Python

Python version Downloads

Read, write and manipulate dfs0, dfs1, dfs2, dfs3, dfsu and mesh files.

MIKE IO facilitates common data processing workflows for MIKE files using Python.

Requirements

Windows or Linux operating system
Python x64 3.10 - 3.13
(Windows) VC++ redistributables (already installed if you have MIKE)

Installation

From PyPI:

pip install mikeio

Or development version:

pip install https://github.com/DHI/mikeio/archive/main.zip

:warning: Don't use conda to install MIKE IO!, the version on conda is outdated.

Getting started

The material from the last Academy by DHI course is available here: Getting started with Dfs files in Python using MIKE IO

Where can I get help?

Documentation - https://dhi.github.io/mikeio/
General help, new ideas and feature requests - GitHub Discussions
Bugs - GitHub Issues

Tested

MIKE IO is tested extensively.

See detailed test coverage report below: bash $ pytest --cov=mikeio

---------- coverage: platform linux, python 3.13.0-final-0 -----------

Name Stmts Miss Cover

mikeio/init.py 33 5 85% mikeio/interpolation.py 68 6 91% mikeio/spectral.py 97 7 93% mikeio/time.py 28 1 96% mikeio/track.py 119 9 92% mikeio/dataset/init.py 4 0 100% mikeio/dataset/dataplot.py 359 38 89% mikeio/dataset/datautils.py 19 0 100% mikeio/dataset/dataarray.py 725 46 94% mikeio/dataset/dataset.py 766 51 93% mikeio/dfs/init.py 5 0 100% mikeio/dfs/dfs0.py 205 13 94% mikeio/dfs/dfs1.py 89 2 98% mikeio/dfs/dfs2.py 142 3 98% mikeio/dfs/dfs3.py 157 11 93% mikeio/dfs/dfs.py 251 14 94% mikeio/dfsu/init.py 6 0 100% mikeio/dfsu/common.py 36 1 97% mikeio/dfsu/dfsu.py 239 6 97% mikeio/dfsu/factory.py 20 1 95% mikeio/dfsu/layered.py 204 9 96% mikeio/dfsu/mesh.py 54 8 85% mikeio/dfsu/spectral.py 234 42 82% mikeio/eum/init.py 2 0 100% mikeio/eum/eum.py 1353 9 99% mikeio/exceptions.py 24 4 83% mikeio/generic.py 475 13 97% mikeio/pfs/init.py 7 0 100% mikeio/pfs/pfsdocument.py 233 4 98% mikeio/pfs/pfssection.py 225 11 95% mikeio/spatial/FMgeometry.py 511 13 97% mikeio/spatial/FMgeometrylayered.py 417 30 93% mikeio/spatial/FMgeometryspectral.py 94 9 90% mikeio/spatial/FMutils.py 306 22 93% mikeio/spatial/init.py 6 0 100% mikeio/spatial/geometry.py 100 8 92% mikeio/spatial/gridgeometry.py 629 41 93% mikeio/spatial/utils.py 38 0 100%

mikeio/spatial/crs.py 51 5 90%

TOTAL 8331 442 95%

Cloud enabled

It is possible to run MIKE IO in your favorite cloud notebook environment e.g. Deepnote, Google Colab, etc...

DeepNote

Colab

Owner

Name: DHI
Login: DHI
Kind: organization
Location: Global

Website: www.dhigroup.com
Repositories: 33
Profile: https://github.com/DHI

Repositories for DHI Solution Software Components

Citation (CITATION.cff)

cff-version: 1.2.0
message: If you use this software, please cite it as below.
authors:
- family-names: Andersson
  given-names: Johan Henrik
  affiliation: DHI
- family-names: Mariegaard
  given-names: Jesper Sandvig
  affiliation: DHI
title: "MIKE IO"
license: BSD-3-Clause
repository-code: 'https:///github.com/DHI/mikeio'
url: "https://dhi.github.io/mikeio/"
version: 1.6.1
date-released: 2023-06-09

GitHub Events

Total

Fork event: 4
Create event: 75
Commit comment event: 1
Release event: 7
Issues event: 43
Watch event: 31
Delete event: 78
Member event: 1
Issue comment event: 103
Push event: 392
Pull request review comment event: 35
Pull request review event: 52
Pull request event: 138

Last Year

Fork event: 4
Create event: 75
Commit comment event: 1
Release event: 7
Issues event: 43
Watch event: 31
Delete event: 78
Member event: 1
Issue comment event: 103
Push event: 392
Pull request review comment event: 35
Pull request review event: 52
Pull request event: 138

Committers

Last synced: 9 months ago

All Time

Total Commits: 3,428
Total Committers: 28
Avg Commits per committer: 122.429
Development Distribution Score (DDS): 0.445

Past Year

Commits: 375
Committers: 11
Avg Commits per committer: 34.091
Development Distribution Score (DDS): 0.091

Top Committers

Name	Email	Commits
Henrik Andersson	j**n@d**m	1,903
Jesper Sandvig Mariegaard	3****d	1,178
rha	r**a@d**m	100
github-actions	$****}	78
laurafroelich	l**r@d**m	26
maximelqt	m**t@f**r	26
Clemens Cremer	c**r@d**m	20
marcridler	4****r	15
georgebv	g**7@g**m	14
mohm-dhi	m**m@d**m	13
otzi5300	l**n@g**m	7
Quentin Barbier	1****B	6
jpalm3r	r**e@g**m	6
watermain	u**a@d**m	5
Hendrik Wrenger	h**r@d**m	4
Michael Bell	m**b@d**m	4
BRPC003	m**a@g**m	3
abja-dhi	a**a@d**m	3
cmitR	c****R	3
j08lue	j**e@g**m	2
Stephan Kistner	s**i@d**m	2
Ola Haugen Havrevoll	h**l@g**m	2
Daniel.Caichac	9****I	2
Raphael Schneider	rs@g****k	2
Ryan Murray	7****i	1
Sara Roth	s**h@s**e	1
dependabot[bot]	4****]	1
dyk dhi	d**k@d**m	1

Committer Domains (Top 20 + Academic)

dhigroup.com: 11 swrab.se: 1 geus.dk: 1 free.fr: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 98
Total pull requests: 291
Average time to close issues: 5 months
Average time to close pull requests: about 2 months
Total issue authors: 47
Total pull request authors: 17
Average comments per issue: 2.72
Average comments per pull request: 0.86
Merged pull requests: 222
Bot issues: 0
Bot pull requests: 1

Past Year

Issues: 21
Pull requests: 125
Average time to close issues: about 1 month
Average time to close pull requests: 14 days
Issue authors: 15
Pull request authors: 8
Average comments per issue: 1.86
Average comments per pull request: 0.41
Merged pull requests: 98
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

ecomodeller (22)
jsmariegaard (15)
daniel-caichac-DHI (6)
Snowthe (4)
AL89 (2)
ryan-kipawa (2)
bhlevca (2)
wu-hao-liang (2)
Hendrik1987 (2)
stkistner (2)
mohm-dhi (2)
lihu8918 (1)
lj512lj512 (1)
chrisawhitwell (1)
zhangr4 (1)

Pull Request Authors

ecomodeller (307)
jsmariegaard (23)
otzi5300 (5)
dykdhi (4)
daniel-caichac-DHI (3)
mohm-dhi (2)
dependabot[bot] (2)
stkistner (2)
abja-dhi (2)
ryan-kipawa (2)
srwater (2)
clemenscremer (2)
Havrevoll (1)
Snowthe (1)
cmitR (1)

Top Labels

Issue Labels

enhancement (7) bug (5) visualization (3) pfs (3) raster (2) help wanted (2) performance (2) duplicate (1) wontfix (1) question (1) FAQ (1) NetCDF (1) good first issue (1) documentation (1) out of scope (1) CI (1)

Pull Request Labels

dependencies (2) notebook example (2) help wanted (1)

Packages

Total packages: 2
Total downloads:
- pypi 2,777 last-month

Total dependent packages: 2
(may contain duplicates)
Total dependent repositories: 6
(may contain duplicates)
Total versions: 79
Total maintainers: 1

pypi.org: mikeio

A package that uses the DHI dfs libraries to create, write and read dfs and mesh files.

Homepage: https://github.com/DHI/mikeio
Documentation: https://mikeio.readthedocs.io/
License: BSD License
Latest release: 2.6.0
published 9 months ago

Versions: 74
Dependent Packages: 2
Dependent Repositories: 5
Downloads: 2,777 Last month

Rankings

Dependent packages count: 3.2%

Downloads: 4.6%

Average: 5.4%

Forks count: 5.8%

Stargazers count: 6.6%

Dependent repos count: 6.7%

Maintainers (1)

jsmariegaard

Last synced: 6 months ago

conda-forge.org: mikeio

Read, write and manipulate dfs0, dfs1, dfs2, dfs3, dfsu and mesh files. Read res1d and xns11 files.

Homepage: https://github.com/DHI/mikeio
License: BSD-3-Clause
Latest release: 0.6.4
published over 4 years ago

Versions: 5
Dependent Packages: 0
Dependent Repositories: 1

Rankings

Dependent repos count: 24.1%

Forks count: 26.2%

Stargazers count: 33.0%

Average: 33.7%

Dependent packages count: 51.5%

Last synced: 6 months ago

Dependencies

.github/workflows/build_docs.yml actions

actions/checkout v3 composite
actions/setup-python v4 composite
actions/upload-artifact v2 composite

.github/workflows/docs.yml actions

actions/checkout v3 composite
actions/setup-python v4 composite
peaceiris/actions-gh-pages v3.6.1 composite

.github/workflows/downstream_test.yml actions

actions/checkout v3 composite
actions/setup-python v4 composite

.github/workflows/full_test.yml actions

actions/checkout v3 composite
actions/setup-python v4 composite
chartboost/ruff-action v1 composite

.github/workflows/notebooks_test.yml actions

actions/checkout v3 composite
actions/setup-python v4 composite

.github/workflows/perf_test.yml actions

actions/checkout v3 composite
actions/setup-python v4 composite

.github/workflows/python-publish.yml actions

actions/checkout v3 composite
actions/setup-python v4 composite

pyproject.toml pypi

PyYAML *
mikecore >=0.2.1
numpy >=1.15.0
pandas >1.3
scipy >1.0
tqdm *
xarray *

mikeio

Science Score: 44.0%

Keywords

Keywords from Contributors

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

MIKE IO: input/output of MIKE files in Python

Requirements

Installation

Getting started

Where can I get help?

Tested

Name Stmts Miss Cover

mikeio/spatial/crs.py 51 5 90%

Cloud enabled

Owner

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

pypi.org: mikeio

Rankings

Maintainers (1)

conda-forge.org: mikeio

Rankings

Dependencies