Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(release): minor clarifications in release notes #1842

Merged
merged 1 commit into from
May 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions doc/ReleaseNotes/ReleaseNotes.tex
Original file line number Diff line number Diff line change
Expand Up @@ -228,14 +228,17 @@ \section{Known Issues and Incompatibilities}
\item
If a GWF-GWF Exchange is active, then neither of the connected GWF Models can have an active Viscosity (VSC) Package.

\item
If a GWT-GWT Exchange is active, then constant concentration conditions cannot be assigned on the interface between the two connected models.

\end{enumerate}

In addition to the issues shown here, a comprehensive and up-to-date list is available under the issues tab at \url{https://github.com/MODFLOW-USGS/modflow6}.


% -------------------------------------------------
\section{Distribution File}
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}.
The MODFLOW~6 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 the current release are labeled as \texttt{\modflowversion\_[ostag].zip}. Thus, the distribution file for Windows for the current release is \texttt{\modflowversion\_win64.zip}.

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.

Expand All @@ -245,9 +248,9 @@ \section{Installation and Execution}

To make the executable versions of MODFLOW~6 accessible from any directory, the directory containing the executables should be included in the PATH environment variable. Also, if a prior release of MODFLOW~6 is installed on your system, the directory containing the executables for the prior release should be removed from the PATH environment variable.

As an alternative, the executable file, named ``\texttt{mf6.exe}'' on Windows, in the \modflowversion\_[ostag]/bin directory can be copied into a directory already included in the PATH environment variable.
As an alternative, the executable file (named ``\texttt{mf6.exe}'' on Windows or ``\texttt{mf6}'' on Mac and Linux) in the \modflowversion\_[ostag]/bin directory can be copied into a directory already included in the PATH environment variable.

To run MODFLOW~6, simply type \texttt{mf6} in a terminal window. The current working directory must be set to a location where the model input files are located. Upon execution, MODFLOW~6 will immediately look for file with the name \texttt{mfsim.nam} in the current working directory, and will terminate with an error if it does not find this file.
To run MODFLOW~6, simply type \texttt{mf6} in a terminal window. The current working directory must be set to a location where the model input files are located. Upon execution, MODFLOW~6 will immediately look for a file with the name \texttt{mfsim.nam} in the current working directory, and will terminate with an error if it does not find this file.

% -------------------------------------------------
\section{Compiling MODFLOW~6}
Expand Down
6 changes: 3 additions & 3 deletions doc/ReleaseNotes/develop.tex
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

\underline{NEW FUNCTIONALITY}
\begin{itemize}
\item A new Groundwater Energy (GWE) transport model is introduced to the code base for simulating heat transport in the subsurface. GWE Models can be coupled together using a new GWE-GWE Exchange. Additional information for activating the GWE model type within a MODFLOW 6 simulation is available within the mf6io.pdf document. Technical details about the GWE Model are given in the supplemental technical information document (mf6suptechinfo) provided with the release. New example problems have been developed for testing and demonstrating GWE capabilities (in addition to other internal tests that help verify the accuracy of GWE); however, additional changes to the code and input may be necessary in response to user needs and further testing.
\item A new Groundwater Energy (GWE) transport model was added to simulate heat transport in the subsurface. GWE Models can be coupled together using a new GWE-GWE Exchange. Additional information for activating the GWE model type within a MODFLOW 6 simulation is available within the mf6io.pdf document. Technical details about the GWE Model are given in the supplemental technical information document (mf6suptechinfo) provided with the release. New example problems have been developed for testing and demonstrating GWE capabilities (in addition to other internal tests that help verify the accuracy of GWE); however, additional changes to the code and input may be necessary in response to user needs and further testing.
\item A new Particle Tracking (PRT) Model was added to simulate forward tracking of particles for Groundwater Flow (GWF) Models. Additional information for activating the PRT model type within a MODFLOW 6 simulation is available within the mf6io.pdf document. Technical details about the PRT Model are given in the supplemental technical information document (mf6suptechinfo) provided with the release. New example problems have been developed for testing and demonstrating PRT capabilities (in addition to other internal tests that help verify the accuracy of PRT); however, additional changes to the code and input may be necessary in response to user needs and further testing.
\item A new capability has been introduced to optionally write user-provided input arrays to external ASCII files. In some cases, such as when the user provides binary files as input, it can be useful to inspect the text representation of that input. Exporting to external ASCII files can be turned on for supported packages by specifying the EXPORT\_ARRAY\_ASCII option. When activated supported variables will be written to files that are named based on the model, package, variable, and layer. Only those arrays specified for the model grid can be exported.
\item Added capability to vary the hydraulic conductivity of the reach streambed (RHK) by stress period in the Streamflow Routing (SFR) package. RHK can be modified by stress period using the BEDK SFRSETTING. RHK can also be defined using a timeseries string in the PACKAGEDATA or PERIOD blocks.
Expand All @@ -15,8 +15,8 @@

\underline{EXAMPLES}
\begin{itemize}
\item New examples were added to demonstrate the new Groundwater Energy (GWE) Model. These examples include: danckwerts, geotherm, gwe-prt, and gwe-radial.
\item New examples were added to demonstrate the new Particle Tracking (PRT) Model. These examples include four of the test problems used to demonstrate MODPATH Version 7.
\item Examples were added to demonstrate the new Groundwater Energy (GWE) Model. These examples include: danckwerts, geotherm, gwe-prt, and gwe-radial.
\item Examples were added to demonstrate the new Particle Tracking (PRT) Model. These examples include two of the test problems used to demonstrate MODPATH Version 7.
\end{itemize}

\textbf{\underline{BUG FIXES AND OTHER CHANGES TO EXISTING FUNCTIONALITY}} \\
Expand Down
Loading