mikeio

v1.7.1

A package that uses the DHI dfs libraries to create, write and read dfs and mesh files. For more information about how to use this package see README

Latest version published 5 months ago

License: BSD-3-Clause

PyPI

GitHub

Package Health Score

81 / 100

security
No known security issues
popularity
Small
maintenance
Healthy
community
Active

Explore Similar Packages

Popularity

Small

GitHub Stars: 136
Forks: 53
Contributors: 20

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package mikeio, we found that it has been starred 136 times.

Security

No known security issues

Security and license risk for latest version

Release Date: Feb 13, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
0
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

BSD-3-Clause

Security Policy

We found a way for you to contribute to the project! Looks like mikeio is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Healthy

Commit Frequency

Open Issues: 27
Open PR: 11
Last Release: 5 months ago
Last Commit: 29 days ago

Further analysis of the maintenance status of mikeio based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that mikeio demonstrates a positive version release cadence with at least one new version released in the past 12 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Active

Readme: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 20
Funding: No

With more than 10 contributors for the mikeio repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: >=3.8

Age: 4 years
Latest Release: 2 months ago
Dependencies: 3 Direct
Versions: 61
Maintainers: 2
Wheels: OS Independent

Readme

MIKE IO: input/output of MIKE files in Python

Python version

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

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

Requirements

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

More info about dependencies

Installation

From PyPI:

pip install mikeio

Or development version:

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

⚠️ 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:

---------- coverage: platform linux, python 3.11.1-final-0 -----------
Name                              Stmts   Miss  Cover
-----------------------------------------------------
mikeio/__init__.py                   38      2    95%
mikeio/base.py                       26      5    81%
mikeio/data_utils.py                111      5    95%
mikeio/dataarray.py                 992    152    85%
mikeio/dataset.py                   772    100    87%
mikeio/dfs0.py                      299     24    92%
mikeio/dfs1.py                       67      3    96%
mikeio/dfs2.py                      188      8    96%
mikeio/dfs3.py                      186     26    86%
mikeio/dfs.py                       288     36    88%
mikeio/dfsu/__init__.py               3      0   100%
mikeio/dfsu/dfsu.py                 592     56    91%
mikeio/dfsu/factory.py               41      2    95%
mikeio/dfsu/layered.py              180     20    89%
mikeio/dfsu/spectral.py             127      6    95%
mikeio/dfsutil.py                   129     15    88%
mikeio/eum.py                      1324     12    99%
mikeio/exceptions.py                 25      8    68%
mikeio/generic.py                   433     16    96%
mikeio/interpolation.py              60      5    92%
mikeio/pfs/__init__.py                4      0   100%
mikeio/pfs/pfsdocument.py           242     16    93%
mikeio/pfs/pfssection.py            220      9    96%
mikeio/spatial/FM_geometry.py      1118    102    91%
mikeio/spatial/FM_utils.py          293     30    90%
mikeio/spatial/__init__.py            0      0   100%
mikeio/spatial/crs.py                50      4    92%
mikeio/spatial/geometry.py           90     33    63%
mikeio/spatial/grid_geometry.py     558     42    92%
mikeio/spatial/utils.py              38      0   100%
mikeio/spectral.py                   90      5    94%
mikeio/track.py                     100     14    86%
mikeio/xyz.py                        12      0   100%
-----------------------------------------------------
TOTAL                              8696    756    91%

=========== 697 passed, 3 warnings in 46.01s ========

Cloud enabled

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

DeepNote

Colab

mikeio dependencies

pyyaml tqdm xarray

FAQs

What is mikeio?

A package that uses the DHI dfs libraries to create, write and read dfs and mesh files. Visit Snyk Advisor to see a full health score report for mikeio, including popularity, security, maintenance & community analysis.

Is mikeio popular?

The python package mikeio receives a total of 1,305 weekly downloads. As such, mikeio popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is mikeio well maintained?

We found that mikeio demonstrated a healthy version release cadence and project activity. It has a community of 20 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is mikeio safe to use?

The python package mikeio was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 26 July-2024, at 19:27 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP