Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
MIT License

Copyright (c) 2020-2026 DHI A/S

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# ifm — Python API for FEFLOW

Documentation, tutorials and examples for `ifm`, the Python interface to FEFLOW,
DHI's groundwater modelling system.

**Documentation: https://dhi.github.io/ifm/**

The `ifm` package is not in this repository — it ships with FEFLOW and is
installed by the FEFLOW installer, with the Python API option selected. What
lives here is the source of the documentation site above, plus the tutorials,
examples and model data that go with it.

```python
import ifm

doc = ifm.loadDocument("myModel.fem")
print(doc.getNumberOfNodes())
```

Requires FEFLOW 11.0 and Python 3.11 or newer.

## Layout

- `docs/` — the documentation site published at dhi.github.io/ifm
- `tutorials/` — getting started, data wrangling, plotting, what's new per release
- `examples/` — short, focused snippets
- `extensions/`, `benchmarks/` — longer worked cases
- `data/` — FEFLOW models used by the notebooks

## License

[MIT](LICENSE), covering the documentation, tutorials and example code in this
repository. FEFLOW and the `ifm` package itself are proprietary DHI software and
are not covered by it.