From a558df9158d32047cc1820b64975c1fc9151be1c Mon Sep 17 00:00:00 2001 From: Henrik Andersson Date: Sat, 5 Sep 2026 15:41:17 +0200 Subject: [PATCH] Add README and MIT license MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The repo had neither, so a visitor saw a bare file tree of docs/, tutorials/ and .fem data with nothing explaining what any of it is, and no license meant none of it could legally be reused. The README is deliberately short: what the repo is, a link to the documentation site it builds, and the point most likely to confuse a newcomer — that the ifm package itself ships inside FEFLOW and is not what this repository contains. The maintainers should extend it. MIT matches mikeio1d, modelskill, tsod and terracotta. It covers the documentation, tutorials and examples here only; the README says so explicitly, so it cannot be read as licensing FEFLOW or the ifm package. Co-Authored-By: Claude Opus 5 (1M context) --- LICENSE | 22 ++++++++++++++++++++++ README.md | 34 ++++++++++++++++++++++++++++++++++ 2 files changed, 56 insertions(+) create mode 100644 LICENSE create mode 100644 README.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..cd86402 --- /dev/null +++ b/LICENSE @@ -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. + diff --git a/README.md b/README.md new file mode 100644 index 0000000..d4a9d47 --- /dev/null +++ b/README.md @@ -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.