Skip to content

Commit 6fca5e6

Browse files
docs(releasenotes): more cleanup for 6.5.0 release (#1838)
* docs(releasenotes): more cleanup for 6.5.0 release * fix ftype table links in mf6io
1 parent c291c89 commit 6fca5e6

21 files changed

+113
-59
lines changed

doc/ReleaseNotes/ReleaseNotes.tex

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ \section{Known Issues and Incompatibilities}
202202
\begin{enumerate}
203203

204204
\item
205-
The READARRAY utility is used by some packages to read arrays of numeric values provided by the user. The READARRAY utility has an IPRN option (as described in the MODFLOW 6 Description of Input and Output), which will cause the array to be written to the model listing file. Support for the IPRN option has been removed for some packages and will ultimately be removed for all packages. An alternative for IPRN functionality is presently under development.
205+
The READARRAY utility is used by some packages to read arrays of numeric values provided by the user. The READARRAY utility has an IPRN option (as described in the MODFLOW 6 Description of Input and Output), which will cause the array to be written to the model listing file. Support for the IPRN option has been removed for some packages and will ultimately be removed for all packages. A new option, called ``EXPORT\_ARRAY\_ASCII'' has been implemented for some packages to support writing of gridded data to external text files. This option has been implemented to replace the IPRN functionality.
206206

207207
\item
208208
The capability to use Unsaturated Zone Flow (UZF) routing beneath lakes and streams has not been implemented.
@@ -235,10 +235,7 @@ \section{Known Issues and Incompatibilities}
235235

236236
% -------------------------------------------------
237237
\section{Distribution File}
238-
The following distribution file is for use on personal computers: \texttt{\modflowversion\_[ostag].zip}. The distribution file is a compressed zip file. The following directory structure is incorporated in the zip file:
239-
240-
% folder structured created by python script
241-
\input{folder_struct.tex}
238+
The distribution is provided in the form of a compressed zip file. Distributions are available for several different operating systems, including Windows, Mac, and Linux. Distributions are marked with an operating system tag, called ``ostag''. Values for ``ostag'' include ``win64'', ``mac'', and ``linux'', for example. Distribution files for this release are labeled as \texttt{\modflowversion\_[ostag].zip}. Thus, the distribution file for Windows for this release is \texttt{\modflowversion\_win64.zip}.
242239

243240
It is recommended that no user files are kept in the release directory. If you do plan to put your own files in the release directory, do so only by creating additional subdirectories.
244241

doc/SuppTechInfo/mf6suptechinfo.bbl

Lines changed: 81 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,52 @@
1-
\begin{thebibliography}{21}
1+
\begin{thebibliography}{30}
22
\providecommand{\natexlab}[1]{#1}
33
\expandafter\ifx\csname urlstyle\endcsname\relax
4-
\providecommand{\doi}[1]{doi:\discretionary{}{}{}#1}\else
5-
\providecommand{\doi}{doi:\discretionary{}{}{}\begingroup
4+
\providecommand{\doiagency}[1]{doi:\discretionary{}{}{}#1}\else
5+
\providecommand{\doiagency}{doi:\discretionary{}{}{}\begingroup
66
\urlstyle{rm}\Url}\fi
77

8+
\bibitem[{Bakker and others(2016)Bakker, Post, Langevin, Hughes, White, Starn,
9+
and Fienen}]{bakker2016flopy}
10+
Bakker, M., Post, V., Langevin, C.D., Hughes, J.D., White, J.T., Starn, J.J.,
11+
and Fienen, M.N., 2016, Scripting modflow model development using python and
12+
flopy: Groundwater, \url{https://doi.org/https://doi.org/10.1111/gwat.12413}.
13+
14+
\bibitem[{Bakker and others(2024)Bakker, Post, Hughes, Langevin, White, Leaf,
15+
Paulinski, Bellino, Morway, Toews, Larsen, Fienen, Starn, Brenhoff, and
16+
Bonelli}]{flopysoftware}
17+
Bakker, M., Post, V., Hughes, J.D., Langevin, C.D., White, J.T., Leaf, A.T.,
18+
Paulinski, S.R., Bellino, J.C., Morway, E.D., Toews, M.W., Larsen, J.D.,
19+
Fienen, M.N., Starn, J.J., Brenhoff, D.A., and Bonelli, W.P., 2024, FloPy
20+
v3.7.0dev0 (preliminary): {U.S. Geological Survey Software Release},
21+
\url{https://doi.org/10.5066/F7BK19FH}.
22+
23+
\bibitem[{Bedekar and others(2016)Bedekar, Morway, Langevin, and
24+
Tonkin}]{mt3dusgs}
25+
Bedekar, V., Morway, E.D., Langevin, C.D., and Tonkin, M.J., 2016, MT3D-USGS
26+
version 1: A U.S. Geological Survey release of MT3DMS updated with new and
27+
expanded transport capabilities for use with MODFLOW: {U.S. Geological Survey
28+
Techniques and Methods, book 6, chap. A53, 69 p.},
29+
\url{https://doi.org/10.3133/tm6a53}, \url{http://dx.doi.org/10.3133/tm6A53}.
30+
831
\bibitem[{Campbell and others(1994)Campbell, Jungbauer, Bidlake, and
932
Hungerford}]{campbell1994}
1033
Campbell, G.S., Jungbauer, J.D., Bidlake, W.R., and Hungerford, R.D., 1994,
1134
Predicting the effect of temperature on soil thermal conductivity: Soil
1235
Science, v. 158, no.~5, p.~307--313.
1336

37+
\bibitem[{Cordes and Kinzelbach(1992)}]{cordes1992}
38+
Cordes, C., and Kinzelbach, W., 1992, Continuous groundwater velocity fields
39+
and path lines in linear, bilinear, and trilinear finite elements: Water
40+
Resources Research, v.~28, p.~2903--2911,
41+
\url{https://doi.org/10.1029/92WR01686}.
42+
1443
\bibitem[{Guo and Langevin(2002)}]{langevin2002seawat}
15-
Guo, Weixing, and Langevin, C.D., 2002, User's Guide to SEAWAT: A Computer
16-
Program for Simulation of Three-Dimensional Variable-Density Ground-Water
17-
Flow: {U.S. Geological Survey Techniques of Water-Resources Investigations
18-
book 6, Chapter A7, 77 p.}, accessed July 25, 2019, at
19-
\url{https://pubs.er.usgs.gov/publication/ofr03426}.
44+
Guo, W., and Langevin, C.D., 2002, User's Guide to SEAWAT: A Computer Program
45+
for Simulation of Three-Dimensional Variable-Density Ground-Water Flow: {U.S.
46+
Geological Survey Techniques of Water-Resources Investigations book 6,
47+
Chapter A7, 77 p.}, accessed July 25, 2019, at
48+
\url{https://doi.org/https://doi.org/10.3133/twri06A7}, at
49+
\url{https://pubs.usgs.gov/publication/twri06A7}.
2050

2151
\bibitem[{Harbaugh(2005)}]{modflow2005}
2252
Harbaugh, A.W., 2005, MODFLOW-2005, the U.S. Geological Survey modular
@@ -52,9 +82,16 @@ Hughes, J.D., Langevin, C.D., and Banta, E.R., 2017, Documentation for the
5282
MODFLOW 6 framework: {U.S. Geological Survey Techniques and Methods, book 6,
5383
chap. A57, 36 p.}, \url{https://doi.org/10.3133/tm6A57}.
5484

85+
\bibitem[{Hughes and others(2024)Hughes, Langevin, Paulinski, Larsen, and
86+
Brakenhoff}]{hughes2023flopy}
87+
Hughes, J.D., Langevin, C.D., Paulinski, S.R., Larsen, J.D., and Brakenhoff,
88+
D., 2024, {FloPy} workflows for creating structured and unstructured
89+
{MODFLOW} models: Groundwater, v.~62, no.~1, p.~124--139,
90+
\url{https://doi.org/10.1111/gwat.13327}.
91+
5592
\bibitem[{Kavetski and Kuczera(2007)}]{doi:10.1029/2006WR005195}
56-
Kavetski, Dmitri, and Kuczera, George, 2007, Model smoothing strategies to
57-
remove microscale discontinuities and spurious secondary optima in objective
93+
Kavetski, D., and Kuczera, G., 2007, Model smoothing strategies to remove
94+
microscale discontinuities and spurious secondary optima in objective
5895
functions in hydrological calibration: Water Resources Research, v.~43,
5996
no.~3, \url{https://doi.org/10.1029/2006WR005195},
6097
\url{https://agupubs.onlinelibrary.wiley.com/doi/abs/10.1029/2006WR005195}.
@@ -67,30 +104,30 @@ Kipp, K.L., 1987, HST3D: A Computer Code for Simulation of Heat and Solute
67104

68105
\bibitem[{Langevin and others(2008)Langevin, Thorne~Jr, Dausman, Sukop, and
69106
Guo}]{langevin2008seawat}
70-
Langevin, C.D., Thorne~Jr, D.T., Dausman, A.M., Sukop, M.C., and Guo, Weixing,
71-
2008, {SEAWAT} Version 4---A computer program for simulation of multi-species
107+
Langevin, C.D., Thorne~Jr, D.T., Dausman, A.M., Sukop, M.C., and Guo, W., 2008,
108+
{SEAWAT} Version 4---A computer program for simulation of multi-species
72109
solute and heat transport: {U.S. Geological Survey Techniques and Methods,
73110
book 6, chap. A22, 39 p.}, accessed June 27, 2017, at
74111
\url{https://pubs.er.usgs.gov/publication/tm6A22}.
75112

76113
\bibitem[{Langevin and others(2017)Langevin, Hughes, Provost, Banta, Niswonger,
77114
and Panday}]{modflow6gwf}
78115
Langevin, C.D., Hughes, J.D., Provost, A.M., Banta, E.R., Niswonger, R.G., and
79-
Panday, Sorab, 2017, Documentation for the MODFLOW 6 Groundwater Flow (GWF)
116+
Panday, S., 2017, Documentation for the MODFLOW 6 Groundwater Flow (GWF)
80117
Model: {U.S. Geological Survey Techniques and Methods, book 6, chap. A55, 197
81118
p.}, \url{https://doi.org/10.3133/tm6A55}.
82119

83120
\bibitem[{Langevin and others(2022)Langevin, Provost, Panday, and
84121
Hughes}]{modflow6gwt}
85-
Langevin, C.D., Provost, A.M., Panday, Sorab, and Hughes, J.D., 2022,
122+
Langevin, C.D., Provost, A.M., Panday, S., and Hughes, J.D., 2022,
86123
Documentation for the MODFLOW 6 Groundwater Transport (GWT) Model: {U.S.
87124
Geological Survey Techniques and Methods, book 6, chap. A61, 56 p.},
88125
\url{https://doi.org/10.3133/tm6A61}.
89126

90127
\bibitem[{Ma and Zheng(2010)}]{mazheng2010}
91-
Ma, Rui, and Zheng, Chunmiao, 2010, Effects of density and viscosity in
92-
modeling heat as a groundwater tracer: Groundwater, v.~48, no.~3,
93-
p.~380--389, \url{https://doi.org/10.1111/j.1745-6584.2009.00660.x}.
128+
Ma, R., and Zheng, C., 2010, Effects of density and viscosity in modeling heat
129+
as a groundwater tracer: Groundwater, v.~48, no.~3, p.~380--389,
130+
\url{https://doi.org/10.1111/j.1745-6584.2009.00660.x}.
94131

95132
\bibitem[{Maidment(1993)}]{maidment1993}
96133
Maidment, D.R., 1993, Handbook of Hydrology: New York, USA, McGraw-Hill.
@@ -103,23 +140,38 @@ Markle, J.M., Schincariol, R.A., Sass, J.H., and Molson, J.W., 2006,
103140
no.~4, p.~1281--1294,
104141
\url{https://doi.org/https://doi.org/10.2136/sssaj2005.0293}.
105142

143+
\bibitem[{Panday(2019)}]{panday2019bct}
144+
Panday, S., 2019, USG-Transport Version 1.4.0: The Block-Centered Transport
145+
Process for MODFLOW-USG: ,
146+
\url{http://gmsdocs.aquaveo.com.s3.amazonaws.com/GWT_v1-4-0.pdf}.
147+
106148
\bibitem[{Panday and others(2013)Panday, Langevin, Niswonger, Ibaraki, and
107149
Hughes}]{modflowusg}
108-
Panday, Sorab, Langevin, C.D., Niswonger, R.G., Ibaraki, Motomu, and Hughes,
109-
J.D., 2013, MODFLOW-USG version 1---An unstructured grid version of MODFLOW
110-
for simulating groundwater flow and tightly coupled processes using a control
150+
Panday, S., Langevin, C.D., Niswonger, R.G., Ibaraki, M., and Hughes, J.D.,
151+
2013, MODFLOW-USG version 1---An unstructured grid version of MODFLOW for
152+
simulating groundwater flow and tightly coupled processes using a control
111153
volume finite-difference formulation: {U.S. Geological Survey Techniques and
112154
Methods, book 6, chap. A45, 66 p.}, accessed June 27, 2017, at
113155
\url{https://pubs.usgs.gov/tm/06/a45/}.
114156

157+
\bibitem[{Pollock(2015)}]{pollock2015}
158+
Pollock, D.W., 2015, Extending the modpath algorithm to rectangular
159+
unstructured grids: Groundwater, v.~54, p.~121--125,
160+
\url{https://doi.org/10.1111/gwat.12328}.
161+
162+
\bibitem[{Pollock(2016)}]{pollock2016modpath7}
163+
Pollock, D.W., 2016, User guide for MODPATH Version 7---A particle-tracking
164+
model for MODFLOW: {U.S. Geological Survey Open-File Report 2016--1086, 35
165+
p.}, accessed June 27, 2017, at \url{https://doi.org/10.3133/ofr20161086}.
166+
115167
\bibitem[{Provost and others(2017)Provost, Langevin, and Hughes}]{modflow6xt3d}
116168
Provost, A.M., Langevin, C.D., and Hughes, J.D., 2017, Documentation for the
117169
``XT3D'' Option in the Node Property Flow (NPF) Package of MODFLOW 6: {U.S.
118170
Geological Survey Techniques and Methods, book 6, chap. A56, 46 p.},
119171
\url{https://doi.org/10.3133/tm6A56}.
120172

121173
\bibitem[{Thorne and others(2006)Thorne, Langevin, and Sukop}]{thorne2006}
122-
Thorne, Danny, Langevin, C.D., and Sukop, M.C., 2006, Addition of simultaneous
174+
Thorne, D., Langevin, C.D., and Sukop, M.C., 2006, Addition of simultaneous
123175
heat and solute transport and variable fluid viscosity to seawat: Computers
124176
and Geosciences, v.~32, no.~10, p.~1758--1768,
125177
\url{https://doi.org/https://doi.org/10.1016/j.cageo.2006.04.005}.
@@ -130,12 +182,17 @@ Voss, C.I., 1984, SUTRA---A finite-element simulation model for
130182
transport or chemically-reactive single-species solute transport: {U.S.
131183
Geological Survey Water-Resources Investigations Report 84--4369, 409 p.}
132184

185+
\bibitem[{Zhang and others(2012)Zhang, King, and Datta-Gupta}]{zhang2012}
186+
Zhang, Y., King, M.J., and Datta-Gupta, A., 2012, Robust streamline tracing
187+
using inter-cell fluxes in locally refined and unstructured grids: Water
188+
Resources Research, v.~48, \url{https://doi.org/10.1029/2011WR011396}.
189+
133190
\bibitem[{Zheng(2010)}]{zheng2010supplemental}
134-
Zheng, Chunmiao, 2010, MT3DMS v5.3, Supplemental User's Guide: {Technical
135-
Report Prepared for the U.S. Army Corps of Engineers, 51 p.}
191+
Zheng, C., 2010, MT3DMS v5.3, Supplemental User's Guide: {Technical Report
192+
Prepared for the U.S. Army Corps of Engineers, 51 p.}
136193

137194
\bibitem[{Zheng and Wang(1999)}]{zheng1999mt3dms}
138-
Zheng, Chunmiao, and Wang, P.P., 1999, MT3DMS---A modular three-dimensional
195+
Zheng, C., and Wang, P.P., 1999, MT3DMS---A modular three-dimensional
139196
multi-species transport model for simulation of advection, dispersion and
140197
chemical reactions of contaminants in groundwater systems; Documentation and
141198
user's guide: {Contract report SERDP--99--1: Vicksburg, Miss., U.S. Army

doc/mf6io/gwe/namefile.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ \subsubsection{Explanation of Variables}
4141
OBS6 & Observations Option \\
4242
\hline
4343
\end{tabular*}
44-
\label{table:ftype}
44+
\label{table:ftype-gwe}
4545
\end{center}
4646
\normalsize
4747
\end{table}

doc/mf6io/gwf/namefile.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ \subsubsection{Explanation of Variables}
4949
OBS6 & Observations Option \\
5050
\hline
5151
\end{tabular*}
52-
\label{table:ftype}
52+
\label{table:ftype-gwf}
5353
\end{center}
5454
\normalsize
5555
\end{table}

doc/mf6io/gwt/namefile.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ \subsubsection{Explanation of Variables}
4343
OBS6 & Observations Option \\
4444
\hline
4545
\end{tabular*}
46-
\label{table:ftype}
46+
\label{table:ftype-gwt}
4747
\end{center}
4848
\normalsize
4949
\end{table}

doc/mf6io/mf6ivar/dfn/gwe-est.dfn

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ shape (nodes)
6161
reader readarray
6262
layered true
6363
longname density of aquifer material
64-
description is a user-specified value of the density of aquifer material not considering the voids. Value will remain fixed for the entire simulation. For example, if working in SI units, values may be entered as kg/m3.
64+
description is a user-specified value of the density of aquifer material not considering the voids. Value will remain fixed for the entire simulation. For example, if working in SI units, values may be entered as kilograms per cubic meter.
6565

6666
# --------------------- gwe est packagedata ---------------------
6767

@@ -91,7 +91,7 @@ tagged false
9191
in_record true
9292
reader urword
9393
longname density of water
94-
description is a user-specified value of the density of water. Value will remain fixed for the entire simulation. For example, if working in SI units, values may be entered as kg/m3.
94+
description is a user-specified value of the density of water. Value will remain fixed for the entire simulation. For example, if working in SI units, values may be entered as kilograms per cubic meter.
9595

9696

9797
block packagedata

doc/mf6io/mf6ivar/dfn/gwe-nam.dfn

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ type string
5050
tagged false
5151
reader urword
5252
longname package type
53-
description is the file type, which must be one of the following character values shown in table~\ref{table:ftype}. Ftype may be entered in any combination of uppercase and lowercase.
53+
description is the file type, which must be one of the following character values shown in table~\ref{table:ftype-gwe}. Ftype may be entered in any combination of uppercase and lowercase.
5454

5555
block packages
5656
name fname

doc/mf6io/mf6ivar/dfn/gwf-nam.dfn

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ type string
7575
tagged false
7676
reader urword
7777
longname package type
78-
description is the file type, which must be one of the following character values shown in table~\ref{table:ftype}. Ftype may be entered in any combination of uppercase and lowercase.
78+
description is the file type, which must be one of the following character values shown in table~\ref{table:ftype-gwf}. Ftype may be entered in any combination of uppercase and lowercase.
7979

8080
block packages
8181
name fname

doc/mf6io/mf6ivar/dfn/gwt-nam.dfn

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ type string
5050
tagged false
5151
reader urword
5252
longname package type
53-
description is the file type, which must be one of the following character values shown in table~\ref{table:ftype}. Ftype may be entered in any combination of uppercase and lowercase.
53+
description is the file type, which must be one of the following character values shown in table~\ref{table:ftype-gwt}. Ftype may be entered in any combination of uppercase and lowercase.
5454

5555
block packages
5656
name fname

doc/mf6io/mf6ivar/dfn/prt-nam.dfn

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ type string
4949
tagged false
5050
reader urword
5151
longname package type
52-
description is the file type, which must be one of the following character values shown in table~\ref{table:ftype}. Ftype may be entered in any combination of uppercase and lowercase.
52+
description is the file type, which must be one of the following character values shown in table~\ref{table:ftype-prt}. Ftype may be entered in any combination of uppercase and lowercase.
5353

5454
block packages
5555
name fname

0 commit comments

Comments
 (0)