Merge pull request #255 from MODFLOW-ORG/v1.8.0

Release 1.8.0

Author: wpbonelli

.github/workflows/ci.yml

@@ -79,7 +79,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ ubuntu-22.04, macos-13, windows-2022 ]
+        os: [ ubuntu-22.04, macos-14, windows-2022 ]
         python: [ "3.10", "3.11", "3.12", "3.13" ]
     env:
       GCC_V: 11

HISTORY.md

@@ -1,3 +1,14 @@
+### Version 1.8.0
+
+#### New features
+
+* [feat(programs)](https://github.com/MODFLOW-ORG/modflow-devtools/commit/7424efa236c67365889081f857127cb2ccfa19c3): Add programs module and database (#243). Committed by wpbonelli on 2025-10-15.
+
+#### Refactoring
+
+* [refactor](https://github.com/MODFLOW-ORG/modflow-devtools/commit/98215fd29a46cd63c964613dba14fbacfed26721): Move drop_none_or_empty to misc module. Committed by w-bonelli on 2025-10-29.
+* [refactor](https://github.com/MODFLOW-ORG/modflow-devtools/commit/e1264de9eef2f63b030cb75584e91d9cb1422d2f): Update programs database (#254). Committed by wpbonelli on 2025-10-29.
+
 ### Version 1.7.0
 
 #### New features

MANIFEST.in

@@ -0,0 +1,2 @@
+include modflow_devtools/programs/*.csv
+include modflow_devtools/registry/*.toml

autotest/test_programs.py

@@ -0,0 +1,34 @@
+import pytest
+
+from modflow_devtools.programs import get_program, get_programs, load_programs
+
+
+def test_load_programs():
+    programs = get_programs()
+    assert isinstance(programs, dict)
+    assert "mf6" in programs
+    mf6 = get_program("mf6")
+    assert mf6 == programs["mf6"]
+    assert isinstance(mf6.version, str)
+    assert isinstance(mf6.current, bool)
+    assert isinstance(mf6.url, str)
+    assert isinstance(mf6.dirname, str)
+    assert isinstance(mf6.srcdir, str)
+    assert isinstance(mf6.standard_switch, bool)
+    assert isinstance(mf6.double_switch, bool)
+    assert isinstance(mf6.shared_object, bool)
+
+
+def test_strict_unrecognized_keys(function_tmpdir):
+    tmp_path = function_tmpdir / "programs.csv"
+    with tmp_path.open("w") as f:
+        f.write(
+            "target,version,current,url,dirname,srcdir,standard_switch,double_switch,shared_object,garbage\n"
+        )
+        f.write(
+            "mf6,6.6.3,True,https://github.com/MODFLOW-ORG/modflow6/releases/download/6.6.3/mf6.6.3_linux.zip,mf6.6.3_linux,src,True,False,False,garbage\n"
+        )
+
+    with pytest.raises(ValueError) as e:
+        load_programs(tmp_path, strict=True)
+        assert "Unrecognized keys in program data: {'unrecognized_key'}" in e.message

docs/conf.py

@@ -8,7 +8,7 @@
 
 project = "modflow-devtools"
 author = "MODFLOW Team"
-release = "1.7.0"
+release = "1.8.0"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

docs/md/models.md

@@ -110,9 +110,9 @@ For example, to create the "default" registry of models in the MF6 examples and
 
 ```shell
 python -m modflow_devtools.make_registry -p ../modflow6-examples/examples --url https://github.com/MODFLOW-ORG/modflow6-examples/releases/download/current/mf6examples.zip --model-name-prefix mf6/example
-python -m modflow_devtools.make_registry -p ../modflow6-testmodels/mf6 --append --url https://github.com/MODFLOW-ORG/modflow6-testmodels/raw/master/mf6 --model-name-prefix mf6/test
-python -m modflow_devtools.make_registry -p ../modflow6-largetestmodels --append --url https://github.com/MODFLOW-ORG/modflow6-largetestmodels/raw/master --model-name-prefix mf6/large
-python -m modflow_devtools.make_registry -p ../modflow6-testmodels/mf5to6 --append --url https://github.com/MODFLOW-ORG/modflow6-testmodels/raw/master/mf5to6 --model-name-prefix mf2005 --namefile "*.nam"
+python -m modflow_devtools.make_registry -p ../modflow6-testmodels/mf6 --url https://github.com/MODFLOW-ORG/modflow6-testmodels/raw/master/mf6 --model-name-prefix mf6/test
+python -m modflow_devtools.make_registry -p ../modflow6-largetestmodels --url https://github.com/MODFLOW-ORG/modflow6-largetestmodels/raw/master --model-name-prefix mf6/large
+python -m modflow_devtools.make_registry -p ../modflow6-testmodels/mf5to6 --url https://github.com/MODFLOW-ORG/modflow6-testmodels/raw/master/mf5to6 --model-name-prefix mf2005 --namefile "*.nam"
 ```
 
 As a shortcut to create the default registry, the script can be run with no arguments: `python -m modflow_devtools.make_registry`.

docs/md/programs.md

@@ -0,0 +1,13 @@
+# MODFLOW and related programs
+
+The `modflow_devtools.programs` module provides a database of programs in the MODFLOW ecosystem. This has previously been housed in [`pymake`](https://github.com/modflowpy/pymake).
+
+The database is accessible as a dictionary of programs:
+
+```python
+from modflow_devtools.programs import get_programs, get_program
+
+programs = get_programs()
+mf6 = programs["mf6"]
+mf6 = get_program("mf6") # equivalent
+```

modflow_devtools/__init__.py

@@ -1,6 +1,6 @@
 __author__ = "Joseph D. Hughes"
-__date__ = "Jun 23, 2025"
-__version__ = "1.7.0"
+__date__ = "Oct 29, 2025"
+__version__ = "1.8.0"
 __maintainer__ = "Joseph D. Hughes"
 __email__ = "[email protected]"
 __status__ = "Production"

modflow_devtools/misc.py

@@ -4,6 +4,7 @@
 import traceback
 from _warnings import warn
 from ast import literal_eval
+from collections.abc import Iterable
 from contextlib import contextmanager
 from enum import Enum
 from functools import wraps
@@ -565,3 +566,24 @@ def try_get_enum_value(v: Any) -> Any:
     of an enumeration, otherwise return it unaltered.
     """
     return v.value if isinstance(v, Enum) else v
+
+
+def try_literal_eval(value: str) -> Any:
+    """
+    Try to parse a string as a literal. If this fails,
+    return the value unaltered.
+    """
+    try:
+        return literal_eval(value)
+    except (SyntaxError, ValueError):
+        return value
+
+
+def drop_none_or_empty(path, key, value):
+    """
+    Drop dictionary items with None or empty values.
+    For use with `boltons.iterutils.remap`.
+    """
+    if value is None or (isinstance(value, Iterable) and not any(value)):
+        return False
+    return True

modflow_devtools/models.py

@@ -21,13 +21,7 @@
 from pooch import Pooch
 
 import modflow_devtools
-from modflow_devtools.misc import get_model_paths
-
-
-def _drop_none_or_empty(path, key, value):
-    if value is None or value == "":
-        return False
-    return True
+from modflow_devtools.misc import drop_none_or_empty, get_model_paths
 
 
 def _model_sort_key(k) -> int:
@@ -421,7 +415,7 @@ def index(
 
         with self._registry_file_path.open("ab+") as registry_file:
             tomli_w.dump(
-                remap(dict(sorted(files.items())), visit=_drop_none_or_empty),
+                remap(dict(sorted(files.items())), visit=drop_none_or_empty),
                 registry_file,
             )