MF6 Desktop Linux

Native MODFLOW 6 groundwater modeling for Linux.

MF6 Desktop Linux is a native Linux desktop application for building and running basic steady-state MODFLOW 6 groundwater models through an interactive graphical interface. It is an independent open-source project, not affiliated with the USGS or the Qt Company. This is alpha-quality software.

Español: README.es.md

• Interactive rectangular structured grid (rows, columns, cell size).
• Single-layer, steady-state flow models (one stress period).
• Uniform aquifer properties: hydraulic conductivity, top, bottom, initial head.
• Fixed-head (CHD) and well (WEL) boundary conditions assigned per cell.
• Automatic generation of a MODFLOW 6 model (DIS, IC, NPF, CHD/WEL, OC) with a fixed SIMPLE IMS configuration.
• Execution of the external MODFLOW 6 executable via FloPy.
• Final heads read back and shown as a color raster plus contours, with the head value available for the selected cell.
• Saving and opening project files (.mf6d.json, format_version = 1).
• Unsaved-changes protection before New/Open/Close.
• Failure diagnostics persisted locally when a simulation fails.

Current version: MF6 Desktop Linux 0.1.0-alpha.2.

This is an early alpha release. Please note:

• This is alpha software and may contain bugs.
• It is not yet a replacement for production modeling tools.
• Model inputs, assumptions, convergence and results should be reviewed before using them for real-world decisions.

• One layer only; multi-layer models are not supported.
• Steady state only; no transient simulations.
• Only CHD and WEL stress packages; no RCH, RIV, DRN, EVT or others.
• Uniform hydraulic conductivity only; no zonation or array editing.
• Structured DIS grid only; no DISV/DISU grids.
• No transport, calibration, parameter estimation, GIS import/export, or model export features.
• Developed and tested on Linux; other platforms have not been validated.

• Linux.
• Python 3.12 (>=3.12,<3.13).
• Git.

Python dependencies are installed automatically.

Copy the entire block below, paste it into a terminal, and press Enter:

git clone https://github.com/jvo1452/mf6-desktop-linux.git "$HOME/mf6-desktop-linux" &&
cd "$HOME/mf6-desktop-linux" &&
python3.12 -m venv .venv &&
source .venv/bin/activate &&
python -m pip install -e . &&
get-modflow :python --repo modflow6 --release-id 6.7.0 --subset mf6 &&
mf6 -v &&
mf6desktop

This installs MF6 Desktop Linux and MODFLOW 6.7.0 inside the same virtual environment. No system-wide MODFLOW installation or sudo is required.

cd "$HOME/mf6-desktop-linux" &&
source .venv/bin/activate &&
mf6desktop

1. Define the grid (rows, columns, cell size) and create it.
2. Set the aquifer properties (K, top, bottom, initial head).
3. Select cells and assign CHD and/or WEL conditions.
4. Run MODFLOW 6.
5. Inspect the resulting heads raster and contours.
6. Save the project to keep the editable model.

Projects are stored as .mf6d.json files containing the editable source data of the model. The current on-disk format is format_version = 1; files from other versions are rejected rather than migrated.

MF6 Desktop Linux is licensed under the GNU General Public License v3.0 or later (GPL-3.0-or-later).

Third-party dependencies are used but not redistributed; see THIRD_PARTY_NOTICES.md for details.

MF6 Desktop Linux is an independent project. It is not an official product of, endorsed by, or affiliated with the U.S. Geological Survey (USGS), the Qt Company, or the FloPy project. MODFLOW 6 is developed by the USGS.