Github token needed for CI when downloading executables (#349)

* Github token needed for CI when downloading executables

* Envvar NLMOD_SUPPRESS_VERION_CHECK

* Renamed envvar

* Let's see if we can now get by without passing the GITHUB_TOKEN env

* Default to not check version

* Consume version_tag arg when creating model_ds

* Removing env SUPPRESS_EXE_VERSION_CHECK

* Removed dangling argument

* Added version_tag to refine/gridgen

* Also auto-download modpath_provisional for other platforms than win

nlmod/dims/base.py

@@ -14,7 +14,9 @@
 logger = logging.getLogger(__name__)
 
 
-def set_ds_attrs(ds, model_name, model_ws, mfversion="mf6", exe_name=None):
+def set_ds_attrs(
+    ds, model_name, model_ws, mfversion="mf6", exe_name=None, version_tag=None
+):
     """Set the attribute of a model dataset.
 
     Parameters
@@ -31,6 +33,11 @@ def set_ds_attrs(ds, model_name, model_ws, mfversion="mf6", exe_name=None):
         path to modflow executable, default is None, which assumes binaries
         are available in nlmod/bin directory. Binaries can be downloaded
         using `nlmod.util.download_mfbinaries()`.
+    version_tag : str, default None
+        GitHub release ID: for example "18.0" or "latest". If version_tag is provided,
+        the most recent installation location of MODFLOW is found in flopy metadata
+        that respects `version_tag`. If not found, the executables are downloaded.
+        Not compatible with exe_name.
 
     Returns
     -------
@@ -46,7 +53,9 @@ def set_ds_attrs(ds, model_name, model_ws, mfversion="mf6", exe_name=None):
     ds.attrs["created_on"] = dt.datetime.now().strftime(fmt)
 
     if exe_name is None:
-        exe_name = util.get_exe_path(exe_name=mfversion)
+        exe_name = util.get_exe_path(exe_name=mfversion, version_tag=version_tag)
+    else:
+        exe_name = util.get_exe_path(exe_name=exe_name, version_tag=version_tag)
 
     ds.attrs["exe_name"] = exe_name
 
@@ -78,6 +87,7 @@ def to_model_ds(
     drop_attributes=True,
     transport=False,
     remove_nan_layers=True,
+    version_tag=None,
 ):
     """Transform an input dataset to a groundwater model dataset.
 
@@ -136,6 +146,11 @@ def to_model_ds(
     remove_nan_layers : bool, optional
         if True remove layers with only nan values in the botm. Default is
         True.
+    version_tag : str, default None
+        GitHub release ID: for example "18.0" or "latest". If version_tag is provided,
+        the most recent installation location of MODFLOW is found in flopy metadata
+        that respects `version_tag`. If not found, the executables are downloaded.
+        Not compatible with exe_name.
 
     Returns
     -------
@@ -176,7 +191,9 @@ def to_model_ds(
         ds = extrapolate_ds(ds)
 
     # add attributes
-    ds = set_ds_attrs(ds, model_name, model_ws)
+    ds = set_ds_attrs(
+        ds, model_name, model_ws, mfversion="mf6", version_tag=version_tag
+    )
     ds.attrs["transport"] = int(transport)
 
     # fill nan's

nlmod/dims/grid.py

@@ -406,6 +406,7 @@ def refine(
     exe_name=None,
     remove_nan_layers=True,
     model_coordinates=False,
+    version_tag=None,
 ):
     """Refine the grid (discretization by vertices, disv), using Gridgen.
 
@@ -432,6 +433,11 @@ def refine(
         When model_coordinates is True, the features supplied in refinement_features are
         already in model-coordinates. Only used when a grid is rotated. The default is
         False.
+    version_tag : str, default None
+        GitHub release ID: for example "18.0" or "latest". If version_tag is provided,
+        the most recent installation location of MODFLOW is found in flopy metadata
+        that respects `version_tag`. If not found, the executables are downloaded.
+        Not compatible with exe_name.
 
     Returns
     -------
@@ -442,7 +448,9 @@ def refine(
     logger.info("create vertex grid using gridgen")
 
     if exe_name is None:
-        exe_name = util.get_exe_path(exe_name="gridgen")
+        exe_name = util.get_exe_path(exe_name="gridgen", version_tag=version_tag)
+    else:
+        exe_name = util.get_exe_path(exe_name=exe_name, version_tag=version_tag)
 
     if model_ws is None:
         model_ws = os.path.join(ds.model_ws, "gridgen")

nlmod/modpath/modpath.py

@@ -215,9 +215,11 @@ def mpf(gwf, exe_name=None, modelname=None, model_ws=None):
             "the save_flows option of the npf package should be True not None"
         )
 
-    # get executable
+    # get executable. version_tag not supported yet
     if exe_name is None:
         exe_name = util.get_exe_path(exe_name="mp7_2_002_provisional")
+    else:
+        exe_name = util.get_exe_path(exe_name=exe_name)
 
     # create mpf model
     mpf = flopy.modpath.Modpath7(

nlmod/sim/sim.py

@@ -107,7 +107,7 @@ def get_tdis_perioddata(ds, nstp="nstp", tsmult="tsmult"):
     return tdis_perioddata
 
 
-def sim(ds, exe_name=None):
+def sim(ds, exe_name=None, version_tag=None):
     """create sim from the model dataset.
 
     Parameters
@@ -117,9 +117,14 @@ def sim(ds, exe_name=None):
         attributes: model_name, mfversion, model_ws, time_units, start,
         perlen, nstp, tsmult
     exe_name: str, optional
-        path to modflow executable, default is None, which assumes binaries
-        are available in nlmod/bin directory. Binaries can be downloaded
-        using `nlmod.util.download_mfbinaries()`.
+        path to modflow executable, default is None. If None, the path is
+        obtained from the flopy metadata that respects `version_tag`. If not
+        found, the executables are downloaded. Not compatible with version_tag.
+    version_tag : str, default None
+        GitHub release ID: for example "18.0" or "latest". If version_tag is provided,
+        the most recent installation location of MODFLOW is found in flopy metadata
+        that respects `version_tag`. If not found, the executables are downloaded.
+        Not compatible with exe_name.
 
     Returns
     -------
@@ -130,8 +135,19 @@ def sim(ds, exe_name=None):
     # start creating model
     logger.info("creating mf6 SIM")
 
-    if exe_name is None:
-        exe_name = util.get_exe_path(exe_name=ds.mfversion)
+    # Most likely exe_name was previously set with to_model_ds()
+    if exe_name is not None:
+        exe_name = util.get_exe_path(exe_name=exe_name, version_tag=version_tag)
+    elif "exe_name" in ds.attrs:
+        exe_name = util.get_exe_path(
+            exe_name=ds.attrs["exe_name"], version_tag=version_tag
+        )
+    elif "mfversion" in ds.attrs:
+        exe_name = util.get_exe_path(
+            exe_name=ds.attrs["mfversion"], version_tag=version_tag
+        )
+    else:
+        raise ValueError("No exe_name provided and no exe_name found in ds.attrs")
 
     # Create the Flopy simulation object
     sim = flopy.mf6.MFSimulation(