ifm_contrib
Description
ifm_contrib is an Open-Source Extension of the IFM, the Python API of the groundwater modellierung software FEFLOW by DHI.
It extents the namespace of the classic IFM to facilitate using FEFLOW in combination with the popular Python datascience libraries pandas, geopandas and matplotlib.
The ifm_contrib namespace is a superset of the classic ifm namespace, thus scripts written for the latter will be back-wards compatible and only one library import statement is required.
Project status
The library has been developed since 2019, and reached maturity around 2021 with most features for (geo-)pandas as matplotlib integration in place.
ifm_contrib is published under the MIT license. It is free to use, share and modify. Users are encouraged to contribute their own code back to the project.
Please note that the maintainer of this project is not associated with DHI.
Development setup
-
Clone this repo
-
Inside the repo:
python -m venv .venv source .venv/bin/activate pip install -e ".[test]"
-
Run unit test with
pytest
If you want to create the documentation:
source .venv/bin/activate
pip install -e ".[test,doc]"
cd doc/sphinx
make html
# Open doc/sphinx/build/html/index.html in a browser
Installation
The recommended way of installing ifm_contrib is by copying or cloning the repository directly into the FEFLOW program director next to the classic IFM.
Installation via pip should be done by:
pip install https://github.com/red5alex/ifm_contrib/archive/refs/heads/master.zip
An installation of FEFLOW (version 7.2 or higher) is required.
Getting started
For a detailed introduction and installation notes, see ifm_contrib: An Introduction
Its not a pretty one, but you can find an (unregularly updated) help system including API reference here](https://red5alex.github.io/ifm_contrib/ifm_contrib.contrib_lib.html).
Troubleshooting and Contribution
If you run into issues please open an issue. Please note that the maintainer may not dedicate significant time to the project at this time but will try its best to respond.
Gallery
Visualize FEFLOW Results directly in Jupyter
Create inline plots with the look-and-feel of FEFLOWs directly within Jupyter. The plots can be exported as GeoDataFrames and saved to shape-files easily.
ifm_contrib adds light support for coordinate systems to FEFLOW.
Process FEFLOWs Time Series with Pandas
Time Series (aka Power functions) and History charts can be easily exported to pandas DataFrames. Automatic conversion to DateTime based on FEFLOWs Reference Time. In-Built Synchronization to observation point reference data.
Pandas-access to Nodal and Elemntal Data, Multi-Layer Wells, and much more
Read more in ifm_contrib: An Introduction
Metadata
Release files for ifm-contrib 0.2.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| ifm_contrib-0.2.4.tar.gz | 8.7 MB | Without provenance | Details for ifm_contrib-0.2.4.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| ifm_contrib-0.2.4-py3-none-any.whl | Python 3 | none | any | Details for ifm_contrib-0.2.4-py3-none-any.whl |
Total release size: 8.7 MB
Release files / ifm_contrib-0.2.4.tar.gz
| Download URL | ifm_contrib-0.2.4.tar.gz |
|---|---|
| Size | 8.7 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
61e7d1aa50f0fbed1d25c04a7ef56144941479eff262a8ba4681ac565b278471
|
|
BLAKE2b-256 checksum How to use checksums |
a888673b4da6fe2e2dbc7ca749962f2c52ded3cb5b5efc55f75837e9e332b9ce
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.0.1 CPython/3.12.8
|
Release files / ifm_contrib-0.2.4-py3-none-any.whl
| Download URL | ifm_contrib-0.2.4-py3-none-any.whl |
|---|---|
| Size | 70.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0b9a8c0013110b90996a7cfdbb1aacb8ac5d8164132efd5172e9fa360c4d0fea
|
|
BLAKE2b-256 checksum How to use checksums |
42a0ee1b748ba7000a4439211807a03427a9f9e66cf382b673c059c6365993e6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.0.1 CPython/3.12.8
|
Security for ifm-contrib 0.2.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.