From 5aefebf53b0ad938a6252aa9a72ecb8a04207133 Mon Sep 17 00:00:00 2001 From: wpbonelli Date: Wed, 24 Jan 2024 16:56:08 -0500 Subject: [PATCH] fix(dist): multiple fixes following review (#1573) * omit utils/idmloader subdir * update distribution checks * rerun mf6ivar.py to update mf6io files * fix typo in gwf-maw.dfn (missing and) * use latex-friendly quotes in gwf-rcha dfn and tex description --- .github/workflows/release.yml | 3 +- distribution/build_dist.py | 47 ++++++++++++++--------- distribution/check_dist.py | 11 ++++++ doc/mf6io/mf6ivar/dfn/gwf-maw.dfn | 2 +- doc/mf6io/mf6ivar/dfn/gwf-rcha.dfn | 2 +- doc/mf6io/mf6ivar/md/mf6ivar.md | 10 +++-- doc/mf6io/mf6ivar/tex/gwf-evt-period.dat | 4 +- doc/mf6io/mf6ivar/tex/gwf-evta-desc.tex | 4 +- doc/mf6io/mf6ivar/tex/gwf-evta-period.dat | 4 +- doc/mf6io/mf6ivar/tex/gwf-rcha-desc.tex | 4 +- doc/mf6io/mf6ivar/tex/gwt-lkt-desc.tex | 2 +- doc/mf6io/mf6ivar/tex/gwt-mwt-desc.tex | 2 +- doc/mf6io/mf6ivar/tex/utl-spc-desc.tex | 2 +- doc/mf6io/mf6noname.tex | 4 +- doc/mf6io/mf6output.tex | 36 ++++++++--------- doc/mf6io/mf6switches.tex | 23 ++++++----- 16 files changed, 89 insertions(+), 71 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 0b38bea885c..5d8808d774e 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -346,7 +346,8 @@ jobs: cp modflow6/meson.build "$distname/meson.build" cp -r modflow6-examples/examples "$distname" cp -r modflow6/src "$distname" - cp -r modflow6/utils "$distname" + cp -r modflow6/utils/mf5to6 "$distname/utils/mf5to6" + cp -r modflow6/utils/zonebudget "$distname/utils/zonebudget" # create LaTeX file describing the folder structure cd modflow6/doc/ReleaseNotes diff --git a/distribution/build_dist.py b/distribution/build_dist.py index 3c9e490b7f4..4d8efdfc8f6 100644 --- a/distribution/build_dist.py +++ b/distribution/build_dist.py @@ -1,13 +1,12 @@ import argparse import os import platform -import shutil import sys import textwrap from os import PathLike, environ from pathlib import Path from pprint import pprint -from shutil import copytree +from shutil import copy, copyfile, copytree, ignore_patterns import pytest from modflow_devtools.build import meson_build @@ -16,8 +15,11 @@ from modflow_devtools.misc import get_model_paths from build_docs import build_documentation -from build_makefiles import (build_mf5to6_makefile, build_mf6_makefile, - build_zbud6_makefile) +from build_makefiles import ( + build_mf5to6_makefile, + build_mf6_makefile, + build_zbud6_makefile, +) from utils import get_project_root_path, run_command # default paths @@ -54,31 +56,32 @@ def copy_sources(output_path: PathLike): str(source_msvs_path / "mf6bmi.sln"), str(source_msvs_path / "mf6bmi.vfproj"), ]: - shutil.copy(d, output_path / "msvs") + copy(d, output_path / "msvs") - ignored = shutil.ignore_patterns(".DS_Store") + ignored = [".DS_Store"] # copy top-level meson.build and meson.options - shutil.copy(_project_root_path / "meson.build", output_path) - shutil.copy(_project_root_path / "meson.options", output_path) + copy(_project_root_path / "meson.build", output_path) + copy(_project_root_path / "meson.options", output_path) # copy source folder src_path = _project_root_path / "src" dst_path = output_path / "src" print(f"Copying {src_path} to {dst_path}") - copytree(src_path, dst_path, ignore=ignored) + copytree(src_path, dst_path, ignore=ignore_patterns(*ignored)) # copy srcbmi folder src_path = _project_root_path / "srcbmi" dst_path = output_path / "srcbmi" print(f"Copying {src_path} to {dst_path}") - copytree(src_path, dst_path, ignore=ignored) + copytree(src_path, dst_path, ignore=ignore_patterns(*ignored)) # copy utils folder src_path = _project_root_path / "utils" dst_path = output_path / "utils" print(f"Copying {src_path} to {dst_path}") - copytree(src_path, dst_path, ignore=ignored) + ignored.extend(["idmloader"]) + copytree(src_path, dst_path, ignore=ignore_patterns(*ignored)) def test_copy_sources(tmp_path): @@ -94,6 +97,14 @@ def test_copy_sources(tmp_path): assert (tmp_path / "utils" / "meson.build").is_file() assert (tmp_path / "msvs" / "mf6.sln").is_file() + assert (tmp_path / "utils").is_dir() + assert (tmp_path / "utils" / "mf5to6").is_dir() + assert (tmp_path / "utils" / "zonebudget").is_dir() + assert (tmp_path / "utils" / "mf5to6" / "pymake").is_dir() + assert (tmp_path / "utils" / "zonebudget" / "pymake").is_dir() + assert not (tmp_path / "utils" / "idmloader").is_dir() + + def build_examples(examples_repo_path: PathLike, overwrite: bool = False): examples_repo_path = Path(examples_repo_path).expanduser().absolute() @@ -234,10 +245,10 @@ def build_makefiles(output_path: PathLike): # create and copy mf6 makefile build_mf6_makefile() (output_path / "make").mkdir(parents=True, exist_ok=True) - shutil.copyfile( + copyfile( _project_root_path / "make" / "makefile", output_path / "make" / "makefile" ) - shutil.copyfile( + copyfile( _project_root_path / "make" / "makedefaults", output_path / "make" / "makedefaults", ) @@ -246,10 +257,10 @@ def build_makefiles(output_path: PathLike): build_zbud6_makefile() rel_path = Path("utils") / "zonebudget" / "make" (output_path / rel_path).mkdir(parents=True, exist_ok=True) - shutil.copyfile( + copyfile( _project_root_path / rel_path / "makefile", output_path / rel_path / "makefile" ) - shutil.copyfile( + copyfile( _project_root_path / rel_path / "makedefaults", output_path / rel_path / "makedefaults", ) @@ -258,10 +269,10 @@ def build_makefiles(output_path: PathLike): build_mf5to6_makefile() rel_path = Path("utils") / "mf5to6" / "make" (output_path / rel_path).mkdir(parents=True, exist_ok=True) - shutil.copyfile( + copyfile( _project_root_path / rel_path / "makefile", output_path / rel_path / "makefile" ) - shutil.copyfile( + copyfile( _project_root_path / rel_path / "makedefaults", output_path / rel_path / "makedefaults", ) @@ -301,7 +312,7 @@ def build_distribution( ) # code.json metadata - shutil.copy(_project_root_path / "code.json", output_path) + copy(_project_root_path / "code.json", output_path) # full releases include examples, source code, makefiles and docs if not full: diff --git a/distribution/check_dist.py b/distribution/check_dist.py index 719199a8ed6..f8eab4355d6 100644 --- a/distribution/check_dist.py +++ b/distribution/check_dist.py @@ -75,8 +75,11 @@ def test_sources(dist_dir_path, releasemode, full): if not full: pytest.skip(reason="sources not included in minimal distribution") + # check top-level meson files assert (dist_dir_path / "meson.build").is_file() assert (dist_dir_path / "meson.options").is_file() + + # check src subdir assert (dist_dir_path / "src").is_dir() assert (dist_dir_path / "src" / "mf6.f90").is_file() version_file_path = dist_dir_path / "src" / "Utilities" / "version.f90" @@ -90,6 +93,14 @@ def test_sources(dist_dir_path, releasemode, full): idevelopmode = 0 if releasemode else 1 assert f"IDEVELOPMODE = {idevelopmode}" in line + # check utils subdir + assert (dist_dir_path / "utils").is_dir() + assert (dist_dir_path / "utils" / "mf5to6").is_dir() + assert (dist_dir_path / "utils" / "zonebudget").is_dir() + assert (dist_dir_path / "utils" / "mf5to6" / "pymake").is_dir() + assert (dist_dir_path / "utils" / "zonebudget" / "pymake").is_dir() + assert not (dist_dir_path / "utils" / "idmloader").is_dir() + @pytest.mark.skipif(not _fc, reason="needs Fortran compiler") def test_makefiles(dist_dir_path, full): diff --git a/doc/mf6io/mf6ivar/dfn/gwf-maw.dfn b/doc/mf6io/mf6ivar/dfn/gwf-maw.dfn index 4a7784baf33..2e957ec2c82 100644 --- a/doc/mf6io/mf6ivar/dfn/gwf-maw.dfn +++ b/doc/mf6io/mf6ivar/dfn/gwf-maw.dfn @@ -485,7 +485,7 @@ tagged false in_record true reader urword longname screen bottom -description value that defines the bottom elevation of the screen for the multi-aquifer well connection. If CONDEQN is SPECIFIED, THIEM, SKIN, or COMPOSITE, SCRN\_BOT can be any value is set to the bottom of the cell. If CONDEQN is MEAN, SCRN\_BOT is set to the multi-aquifer well connection cell bottom if the specified value is less than the cell bottom. The program will terminate with an error if the screen bottom is greater than the screen top. +description value that defines the bottom elevation of the screen for the multi-aquifer well connection. If CONDEQN is SPECIFIED, THIEM, SKIN, or COMPOSITE, SCRN\_BOT can be any value and is set to the bottom of the cell. If CONDEQN is MEAN, SCRN\_BOT is set to the multi-aquifer well connection cell bottom if the specified value is less than the cell bottom. The program will terminate with an error if the screen bottom is greater than the screen top. block connectiondata name hk_skin diff --git a/doc/mf6io/mf6ivar/dfn/gwf-rcha.dfn b/doc/mf6io/mf6ivar/dfn/gwf-rcha.dfn index 88774e8dae8..a0fb9ec0f60 100644 --- a/doc/mf6io/mf6ivar/dfn/gwf-rcha.dfn +++ b/doc/mf6io/mf6ivar/dfn/gwf-rcha.dfn @@ -107,7 +107,7 @@ reader urword optional false tagged false longname file name of time series information -description defines a time-array-series file defining a time-array series that can be used to assign time-varying values. See the Time-Variable Input section for instructions on using the time-array series capability. +description defines a time-array-series file defining a time-array series that can be used to assign time-varying values. See the ``Time-Variable Input'' section for instructions on using the time-array series capability. block options name obs_filerecord diff --git a/doc/mf6io/mf6ivar/md/mf6ivar.md b/doc/mf6io/mf6ivar/md/mf6ivar.md index f2fdfdd12fd..cb4ed9623b7 100644 --- a/doc/mf6io/mf6ivar/md/mf6ivar.md +++ b/doc/mf6io/mf6ivar/md/mf6ivar.md @@ -321,6 +321,7 @@ | GWF | CHD | OPTIONS | TS6_FILENAME | STRING | defines a time-series file defining time series that can be used to assign time-varying values. See the ``Time-Variable Input'' section for instructions on using the time-series capability. | | GWF | CHD | OPTIONS | OBS6 | KEYWORD | keyword to specify that record corresponds to an observations file. | | GWF | CHD | OPTIONS | OBS6_FILENAME | STRING | name of input file to define observations for the constant-head package. See the ``Observation utility'' section for instructions for preparing observation input files. Tables \ref{table:gwf-obstypetable} and \ref{table:gwt-obstypetable} lists observation type(s) supported by the constant-head package. | +| GWF | CHD | OPTIONS | DEV_NO_NEWTON | KEYWORD | turn off Newton for unconfined cells | | GWF | CHD | DIMENSIONS | MAXBOUND | INTEGER | integer value specifying the maximum number of constant-head cells that will be specified for use during any stress period. | | GWF | CHD | PERIOD | IPER | INTEGER | integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block. | | GWF | CHD | PERIOD | CELLID | INTEGER (NCELLDIM) | is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. | @@ -362,6 +363,7 @@ | GWF | DRN | OPTIONS | OBS6 | KEYWORD | keyword to specify that record corresponds to an observations file. | | GWF | DRN | OPTIONS | OBS6_FILENAME | STRING | name of input file to define observations for the Drain package. See the ``Observation utility'' section for instructions for preparing observation input files. Tables \ref{table:gwf-obstypetable} and \ref{table:gwt-obstypetable} lists observation type(s) supported by the Drain package. | | GWF | DRN | OPTIONS | MOVER | KEYWORD | keyword to indicate that this instance of the Drain Package can be used with the Water Mover (MVR) Package. When the MOVER option is specified, additional memory is allocated within the package to store the available, provided, and received water. | +| GWF | DRN | OPTIONS | DEV_CUBIC_SCALING | KEYWORD | cubic-scaling is used to scale the drain conductance | | GWF | DRN | DIMENSIONS | MAXBOUND | INTEGER | integer value specifying the maximum number of drains cells that will be specified for use during any stress period. | | GWF | DRN | PERIOD | IPER | INTEGER | integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block. | | GWF | DRN | PERIOD | CELLID | INTEGER (NCELLDIM) | is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. | @@ -484,7 +486,7 @@ | GWF | EVTA | PERIOD | SURFACE | DOUBLE PRECISION (NCOL*NROW; NCPL) | is the elevation of the ET surface ($L$). | | GWF | EVTA | PERIOD | RATE | DOUBLE PRECISION (NCOL*NROW; NCPL) | is the maximum ET flux rate ($LT^{-1}$). | | GWF | EVTA | PERIOD | DEPTH | DOUBLE PRECISION (NCOL*NROW; NCPL) | is the ET extinction depth ($L$). | -| GWF | EVTA | PERIOD | AUX(IAUX) | DOUBLE PRECISION (NCOL*NROW; NCPL) | is an array of values for auxiliary variable AUX(IAUX), where iaux is a value from 1 to NAUX, and AUX(IAUX) must be listed as part of the auxiliary variables. A separate array can be specified for each auxiliary variable. If an array is not specified for an auxiliary variable, then a value of zero is assigned. If the value specified here for the auxiliary variable is the same as auxmultname, then the evapotranspiration rate will be multiplied by this array. | +| GWF | EVTA | PERIOD | AUX | DOUBLE PRECISION (NCOL*NROW; NCPL) | is an array of values for auxiliary variable AUX(IAUX), where iaux is a value from 1 to NAUX, and AUX(IAUX) must be listed as part of the auxiliary variables. A separate array can be specified for each auxiliary variable. If an array is not specified for an auxiliary variable, then a value of zero is assigned. If the value specified here for the auxiliary variable is the same as auxmultname, then the evapotranspiration rate will be multiplied by this array. | | GWF | MAW | OPTIONS | AUXILIARY | STRING (NAUX) | defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block. | | GWF | MAW | OPTIONS | BOUNDNAMES | KEYWORD | keyword to indicate that boundary names may be provided with the list of multi-aquifer well cells. | | GWF | MAW | OPTIONS | PRINT_INPUT | KEYWORD | keyword to indicate that the list of multi-aquifer well information will be written to the listing file immediately after it is read. | @@ -1058,7 +1060,7 @@ | GWT | LKT | PACKAGEDATA | BOUNDNAME | STRING | name of the lake cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes. | | GWT | LKT | PERIOD | IPER | INTEGER | integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block. | | GWT | LKT | PERIOD | IFNO | INTEGER | integer value that defines the feature (lake) number associated with the specified PERIOD data on the line. IFNO must be greater than zero and less than or equal to NLAKES. | -| GWT | LKT | PERIOD | LAKSETTING | KEYSTRING | line of information that is parsed into a keyword and values. Keyword values that can be used to start the LAKSETTING string include: STATUS, CONCENTRATION, RAINFALL, EVAPORATION, RUNOFF, and AUXILIARY. These settings are used to assign the concentration of associated with the corresponding flow terms. Concentrations cannot be specified for all flow terms. For example, the Lake Package supports a ``WITHDRAWAL'' flow term. If this withdrawal term is active, then water will be withdrawn from the lake at the calculated concentration of the lake. | +| GWT | LKT | PERIOD | LAKSETTING | KEYSTRING | line of information that is parsed into a keyword and values. Keyword values that can be used to start the LAKSETTING string include: STATUS, CONCENTRATION, RAINFALL, EVAPORATION, RUNOFF, EXT-INFLOW, and AUXILIARY. These settings are used to assign the concentration of associated with the corresponding flow terms. Concentrations cannot be specified for all flow terms. For example, the Lake Package supports a ``WITHDRAWAL'' flow term. If this withdrawal term is active, then water will be withdrawn from the lake at the calculated concentration of the lake. | | GWT | LKT | PERIOD | STATUS | STRING | keyword option to define lake status. STATUS can be ACTIVE, INACTIVE, or CONSTANT. By default, STATUS is ACTIVE, which means that concentration will be calculated for the lake. If a lake is inactive, then there will be no solute mass fluxes into or out of the lake and the inactive value will be written for the lake concentration. If a lake is constant, then the concentration for the lake will be fixed at the user specified value. | | GWT | LKT | PERIOD | CONCENTRATION | STRING | real or character value that defines the concentration for the lake. The specified CONCENTRATION is only applied if the lake is a constant concentration lake. If the Options block includes a TIMESERIESFILE entry (see the ``Time-Variable Input'' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. | | GWT | LKT | PERIOD | RAINFALL | STRING | real or character value that defines the rainfall solute concentration $(ML^{-3})$ for the lake. If the Options block includes a TIMESERIESFILE entry (see the ``Time-Variable Input'' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. | @@ -1094,7 +1096,7 @@ | GWT | MWT | PACKAGEDATA | BOUNDNAME | STRING | name of the well cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes. | | GWT | MWT | PERIOD | IPER | INTEGER | integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block. | | GWT | MWT | PERIOD | IFNO | INTEGER | integer value that defines the feature (well) number associated with the specified PERIOD data on the line. IFNO must be greater than zero and less than or equal to NMAWWELLS. | -| GWT | MWT | PERIOD | MWTSETTING | KEYSTRING | line of information that is parsed into a keyword and values. Keyword values that can be used to start the MWTSETTING string include: STATUS, CONCENTRATION, RAINFALL, EVAPORATION, RUNOFF, and AUXILIARY. These settings are used to assign the concentration associated with the corresponding flow terms. Concentrations cannot be specified for all flow terms. For example, the Multi-Aquifer Well Package supports a ``WITHDRAWAL'' flow term. If this withdrawal term is active, then water will be withdrawn from the well at the calculated concentration of the well. | +| GWT | MWT | PERIOD | MWTSETTING | KEYSTRING | line of information that is parsed into a keyword and values. Keyword values that can be used to start the MWTSETTING string include: STATUS, CONCENTRATION, RATE, and AUXILIARY. These settings are used to assign the concentration associated with the corresponding flow terms. Concentrations cannot be specified for all flow terms. For example, the Multi-Aquifer Well Package supports a ``WITHDRAWAL'' flow term. If this withdrawal term is active, then water will be withdrawn from the well at the calculated concentration of the well. | | GWT | MWT | PERIOD | STATUS | STRING | keyword option to define well status. STATUS can be ACTIVE, INACTIVE, or CONSTANT. By default, STATUS is ACTIVE, which means that concentration will be calculated for the well. If a well is inactive, then there will be no solute mass fluxes into or out of the well and the inactive value will be written for the well concentration. If a well is constant, then the concentration for the well will be fixed at the user specified value. | | GWT | MWT | PERIOD | CONCENTRATION | STRING | real or character value that defines the concentration for the well. The specified CONCENTRATION is only applied if the well is a constant concentration well. If the Options block includes a TIMESERIESFILE entry (see the ``Time-Variable Input'' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. | | GWT | MWT | PERIOD | RATE | STRING | real or character value that defines the injection solute concentration $(ML^{-3})$ for the well. If the Options block includes a TIMESERIESFILE entry (see the ``Time-Variable Input'' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. | @@ -1164,7 +1166,7 @@ | UTL | SPC | DIMENSIONS | MAXBOUND | INTEGER | integer value specifying the maximum number of spc cells that will be specified for use during any stress period. | | UTL | SPC | PERIOD | IPER | INTEGER | integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block. | | UTL | SPC | PERIOD | BNDNO | INTEGER | integer value that defines the boundary package feature number associated with the specified PERIOD data on the line. BNDNO must be greater than zero and less than or equal to MAXBOUND. | -| UTL | SPC | PERIOD | SPCSETTING | KEYSTRING | line of information that is parsed into a keyword and values. Keyword values that can be used to start the MAWSETTING string include: CONCENTRATION. | +| UTL | SPC | PERIOD | SPCSETTING | KEYSTRING | line of information that is parsed into a keyword and values. Keyword values that can be used to start the SPCSETTING string include: CONCENTRATION. | | UTL | SPC | PERIOD | CONCENTRATION | DOUBLE PRECISION | is the boundary concentration. If the Options block includes a TIMESERIESFILE entry (see the ``Time-Variable Input'' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. By default, the CONCENTRATION for each boundary feature is zero. | | UTL | SPCA | OPTIONS | READASARRAYS | KEYWORD | indicates that array-based input will be used for the SPC Package. This keyword must be specified to use array-based input. | | UTL | SPCA | OPTIONS | PRINT_INPUT | KEYWORD | keyword to indicate that the list of spc information will be written to the listing file immediately after it is read. | diff --git a/doc/mf6io/mf6ivar/tex/gwf-evt-period.dat b/doc/mf6io/mf6ivar/tex/gwf-evt-period.dat index 380761217d9..8b5288455ce 100644 --- a/doc/mf6io/mf6ivar/tex/gwf-evt-period.dat +++ b/doc/mf6io/mf6ivar/tex/gwf-evt-period.dat @@ -1,5 +1,5 @@ BEGIN PERIOD - <@surface@> <@rate@> <@depth@> <@pxdp(nseg-1)@> <@petm(nseg-1)@> [<@petm0@>] [<@aux(naux)@>] [] - <@surface@> <@rate@> <@depth@> <@pxdp(nseg-1)@> <@petm(nseg-1)@> [<@petm0@>] [<@aux(naux)@>] [] + <@surface@> <@rate@> <@depth@> [<@pxdp(nseg-1)@>] [<@petm(nseg-1)@>] [<@petm0@>] [<@aux(naux)@>] [] + <@surface@> <@rate@> <@depth@> [<@pxdp(nseg-1)@>] [<@petm(nseg-1)@>] [<@petm0@>] [<@aux(naux)@>] [] ... END PERIOD diff --git a/doc/mf6io/mf6ivar/tex/gwf-evta-desc.tex b/doc/mf6io/mf6ivar/tex/gwf-evta-desc.tex index 3dbded6c6c1..987b185558b 100644 --- a/doc/mf6io/mf6ivar/tex/gwf-evta-desc.tex +++ b/doc/mf6io/mf6ivar/tex/gwf-evta-desc.tex @@ -37,11 +37,11 @@ \item \texttt{surface}---is the elevation of the ET surface ($L$). -\item \texttt{rate}---is the maximum ET flux rate ($LT^{-1}$). +\item \textcolor{blue}{\texttt{rate}---is the maximum ET flux rate ($LT^{-1}$).} \item \texttt{depth}---is the ET extinction depth ($L$). -\item \texttt{aux(iaux)}---is an array of values for auxiliary variable AUX(IAUX), where iaux is a value from 1 to NAUX, and AUX(IAUX) must be listed as part of the auxiliary variables. A separate array can be specified for each auxiliary variable. If an array is not specified for an auxiliary variable, then a value of zero is assigned. If the value specified here for the auxiliary variable is the same as auxmultname, then the evapotranspiration rate will be multiplied by this array. +\item \textcolor{blue}{\texttt{aux}---is an array of values for auxiliary variable AUX(IAUX), where iaux is a value from 1 to NAUX, and AUX(IAUX) must be listed as part of the auxiliary variables. A separate array can be specified for each auxiliary variable. If an array is not specified for an auxiliary variable, then a value of zero is assigned. If the value specified here for the auxiliary variable is the same as auxmultname, then the evapotranspiration rate will be multiplied by this array.} \end{description} diff --git a/doc/mf6io/mf6ivar/tex/gwf-evta-period.dat b/doc/mf6io/mf6ivar/tex/gwf-evta-period.dat index 2fe138e798b..185b433f84e 100644 --- a/doc/mf6io/mf6ivar/tex/gwf-evta-period.dat +++ b/doc/mf6io/mf6ivar/tex/gwf-evta-period.dat @@ -7,6 +7,6 @@ BEGIN PERIOD -- READARRAY DEPTH -- READARRAY - AUX(IAUX) - -- READARRAY + AUX + -- READARRAY END PERIOD diff --git a/doc/mf6io/mf6ivar/tex/gwf-rcha-desc.tex b/doc/mf6io/mf6ivar/tex/gwf-rcha-desc.tex index c8ed6e6cda9..aab5a2209fe 100644 --- a/doc/mf6io/mf6ivar/tex/gwf-rcha-desc.tex +++ b/doc/mf6io/mf6ivar/tex/gwf-rcha-desc.tex @@ -35,9 +35,9 @@ \item \texttt{irch}---IRCH is the layer number that defines the layer in each vertical column where recharge is applied. If IRCH is omitted, recharge by default is applied to cells in layer 1. IRCH can only be used if READASARRAYS is specified in the OPTIONS block. If IRCH is specified, it must be specified as the first variable in the PERIOD block or MODFLOW will terminate with an error. -\item \texttt{recharge}---is the recharge flux rate ($LT^{-1}$). This rate is multiplied inside the program by the surface area of the cell to calculate the volumetric recharge rate. The recharge array may be defined by a time-array series (see the "Using Time-Array Series in a Package" section). +\item \textcolor{blue}{\texttt{recharge}---is the recharge flux rate ($LT^{-1}$). This rate is multiplied inside the program by the surface area of the cell to calculate the volumetric recharge rate. The recharge array may be defined by a time-array series (see the ``Using Time-Array Series in a Package'' section).} -\item \texttt{aux}---is an array of values for auxiliary variable aux(iaux), where iaux is a value from 1 to naux, and aux(iaux) must be listed as part of the auxiliary variables. A separate array can be specified for each auxiliary variable. If an array is not specified for an auxiliary variable, then a value of zero is assigned. If the value specified here for the auxiliary variable is the same as auxmultname, then the recharge array will be multiplied by this array. +\item \textcolor{blue}{\texttt{aux}---is an array of values for auxiliary variable aux(iaux), where iaux is a value from 1 to naux, and aux(iaux) must be listed as part of the auxiliary variables. A separate array can be specified for each auxiliary variable. If an array is not specified for an auxiliary variable, then a value of zero is assigned. If the value specified here for the auxiliary variable is the same as auxmultname, then the recharge array will be multiplied by this array.} \end{description} diff --git a/doc/mf6io/mf6ivar/tex/gwt-lkt-desc.tex b/doc/mf6io/mf6ivar/tex/gwt-lkt-desc.tex index 0cb746186ca..052725643c4 100644 --- a/doc/mf6io/mf6ivar/tex/gwt-lkt-desc.tex +++ b/doc/mf6io/mf6ivar/tex/gwt-lkt-desc.tex @@ -63,7 +63,7 @@ \item \texttt{ifno}---integer value that defines the feature (lake) number associated with the specified PERIOD data on the line. IFNO must be greater than zero and less than or equal to NLAKES. -\item \texttt{laksetting}---line of information that is parsed into a keyword and values. Keyword values that can be used to start the LAKSETTING string include: STATUS, CONCENTRATION, RAINFALL, EVAPORATION, RUNOFF, and AUXILIARY. These settings are used to assign the concentration of associated with the corresponding flow terms. Concentrations cannot be specified for all flow terms. For example, the Lake Package supports a ``WITHDRAWAL'' flow term. If this withdrawal term is active, then water will be withdrawn from the lake at the calculated concentration of the lake. +\item \texttt{laksetting}---line of information that is parsed into a keyword and values. Keyword values that can be used to start the LAKSETTING string include: STATUS, CONCENTRATION, RAINFALL, EVAPORATION, RUNOFF, EXT-INFLOW, and AUXILIARY. These settings are used to assign the concentration of associated with the corresponding flow terms. Concentrations cannot be specified for all flow terms. For example, the Lake Package supports a ``WITHDRAWAL'' flow term. If this withdrawal term is active, then water will be withdrawn from the lake at the calculated concentration of the lake. \begin{lstlisting}[style=blockdefinition] STATUS diff --git a/doc/mf6io/mf6ivar/tex/gwt-mwt-desc.tex b/doc/mf6io/mf6ivar/tex/gwt-mwt-desc.tex index e86f1b25d5e..76beee6ffa4 100644 --- a/doc/mf6io/mf6ivar/tex/gwt-mwt-desc.tex +++ b/doc/mf6io/mf6ivar/tex/gwt-mwt-desc.tex @@ -63,7 +63,7 @@ \item \texttt{ifno}---integer value that defines the feature (well) number associated with the specified PERIOD data on the line. IFNO must be greater than zero and less than or equal to NMAWWELLS. -\item \texttt{mwtsetting}---line of information that is parsed into a keyword and values. Keyword values that can be used to start the MWTSETTING string include: STATUS, CONCENTRATION, RAINFALL, EVAPORATION, RUNOFF, and AUXILIARY. These settings are used to assign the concentration associated with the corresponding flow terms. Concentrations cannot be specified for all flow terms. For example, the Multi-Aquifer Well Package supports a ``WITHDRAWAL'' flow term. If this withdrawal term is active, then water will be withdrawn from the well at the calculated concentration of the well. +\item \texttt{mwtsetting}---line of information that is parsed into a keyword and values. Keyword values that can be used to start the MWTSETTING string include: STATUS, CONCENTRATION, RATE, and AUXILIARY. These settings are used to assign the concentration associated with the corresponding flow terms. Concentrations cannot be specified for all flow terms. For example, the Multi-Aquifer Well Package supports a ``WITHDRAWAL'' flow term. If this withdrawal term is active, then water will be withdrawn from the well at the calculated concentration of the well. \begin{lstlisting}[style=blockdefinition] STATUS diff --git a/doc/mf6io/mf6ivar/tex/utl-spc-desc.tex b/doc/mf6io/mf6ivar/tex/utl-spc-desc.tex index bba10d98e87..3e5c0ccf826 100644 --- a/doc/mf6io/mf6ivar/tex/utl-spc-desc.tex +++ b/doc/mf6io/mf6ivar/tex/utl-spc-desc.tex @@ -25,7 +25,7 @@ \item \texttt{bndno}---integer value that defines the boundary package feature number associated with the specified PERIOD data on the line. BNDNO must be greater than zero and less than or equal to MAXBOUND. -\item \texttt{spcsetting}---line of information that is parsed into a keyword and values. Keyword values that can be used to start the MAWSETTING string include: CONCENTRATION. +\item \texttt{spcsetting}---line of information that is parsed into a keyword and values. Keyword values that can be used to start the SPCSETTING string include: CONCENTRATION. \begin{lstlisting}[style=blockdefinition] CONCENTRATION <@concentration@> diff --git a/doc/mf6io/mf6noname.tex b/doc/mf6io/mf6noname.tex index 2a1d08622d2..6671ddbe223 100644 --- a/doc/mf6io/mf6noname.tex +++ b/doc/mf6io/mf6noname.tex @@ -3,8 +3,6 @@ ERROR REPORT: - 1. mf6.exe: mfsim.nam is not present in working directory. - - + 1. mf6: mfsim.nam is not present in working directory. \end{lstlisting} } diff --git a/doc/mf6io/mf6output.tex b/doc/mf6io/mf6output.tex index 6c982d2f831..a62c97b6d73 100644 --- a/doc/mf6io/mf6output.tex +++ b/doc/mf6io/mf6output.tex @@ -2,37 +2,33 @@ \begin{lstlisting}[style=modeloutput] MODFLOW 6 U.S. GEOLOGICAL SURVEY MODULAR HYDROLOGIC MODEL - VERSION 6.3.0 03/04/2022 + VERSION 6.5.0.dev0 (preliminary) 07/13/2023 + ***DEVELOP MODE*** - MODFLOW 6 compiled Mar 02 2022 15:29:04 with Intel(R) Fortran Intel(R) 64 - Compiler Classic for applications running on Intel(R) 64, Version 2021.5.0 - Build 20211109_000000 + MODFLOW 6 compiled Jan 24 2024 12:12:59 with GCC version 13.2.0 -This software has been approved for release by the U.S. Geological -Survey (USGS). Although the software has been subjected to rigorous -review, the USGS reserves the right to update the software as needed -pursuant to further analysis and review. No warranty, expressed or -implied, is made by the USGS or the U.S. Government as to the -functionality of the software and related material nor shall the -fact of release constitute any such warranty. Furthermore, the -software is released on condition that neither the USGS nor the U.S. -Government shall be held liable for any damages resulting from its -authorized or unauthorized use. Also refer to the USGS Water -Resources Software User Rights Notice for complete use, copyright, -and distribution information. +This software is preliminary or provisional and is subject to +revision. It is being provided to meet the need for timely best +science. The software has not received final approval by the U.S. +Geological Survey (USGS). No warranty, expressed or implied, is made +by the USGS or the U.S. Government as to the functionality of the +software and related material nor shall the fact of release +constitute any such warranty. The software is provided on the +condition that neither the USGS nor the U.S. Government shall be held +liable for any damages resulting from the authorized or unauthorized +use of the software. - Run start date and time (yyyy/mm/dd hh:mm:ss): 2022/03/04 12:00:35 + Run start date and time (yyyy/mm/dd hh:mm:ss): 2024/01/24 12:13:22 Writing simulation list file: mfsim.lst Using Simulation name file: mfsim.nam Solving: Stress period: 1 Time step: 1 - Run end date and time (yyyy/mm/dd hh:mm:ss): 2022/03/04 12:00:36 - Elapsed run time: 0.156 Seconds + Run end date and time (yyyy/mm/dd hh:mm:ss): 2024/01/24 12:13:22 + Elapsed run time: 0.034 Seconds Normal termination of simulation. - \end{lstlisting} } diff --git a/doc/mf6io/mf6switches.tex b/doc/mf6io/mf6switches.tex index 280a969fdd6..bd204027dce 100644 --- a/doc/mf6io/mf6switches.tex +++ b/doc/mf6io/mf6switches.tex @@ -1,14 +1,15 @@ {\small \begin{lstlisting}[style=modeloutput] -mf6.exe - MODFLOW 6.3.0 03/04/2022 (compiled Mar 02 2022 15:29:04) -usage: mf6.exe run MODFLOW 6 using "mfsim.nam" - or: mf6.exe [options] retrieve program information +mf6 - MODFLOW 6.5.0.dev0 (preliminary) 07/13/2023 (compiled Jan 24 2024 12:12:59) +usage: mf6 run MODFLOW 6 using "mfsim.nam" + or: mf6 [options] retrieve program information -Options GNU long option Meaning +Options GNU long option Meaning -h, -? --help Show this message -v --version Display program version information. -dev --develop Display program develop option mode. -d --disclaimer Display program disclaimer. + -p --parallel Run program in parallel mode. -lic --license Display program license information. -c --compiler Display compiler information. -co --compiler-opt Display compiler options. @@ -18,19 +19,17 @@ =debug Enhanced output to STDOUT. -m --mode MODFLOW 6 simulation mode based on . =validate Check model input for - errors but do not - assemble or solve matrix - equations or write + errors but do not + assemble or solve matrix + equations or write solution output. - -Bug reporting and contributions are welcome from the community. + +Bug reporting and contributions are welcome from the community. Questions can be asked on the issues page[1]. Before creating a new issue, please take a moment to search and make sure a similar issue does not already exist. If one does exist, you can comment (most simply even with just :+1:) to show your support for that issue. - + [1] https://github.com/MODFLOW-USGS/modflow6/issues - - \end{lstlisting} }