Deploying to gh-pages from @ 65803fd 🚀

.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 4724ebffb4b01f919207576d4d776997
+tags: 645f666f9bcd5a90fca523b33c5a78b7

_downloads/509f6a4d0dd4389c5a7ae0a232072191/initial_config_full.yaml

@@ -0,0 +1,122 @@
+simulation:
+  sim_name: 'shellmound'
+  version: 'mf6'
+  sim_ws: 'model'
+
+model:
+  simulation: 'shellmound'
+  modelname: 'shellmound'
+  options:
+    print_input: True
+    save_flows: True
+    newton: True
+  packages:
+    - dis
+    - ic
+    - np
+    - oc
+    - sto
+    - rch
+    - sfr
+    - wel
+
+setup_grid:
+  source_data:
+    features_shapefile:
+      filename: '../mfsetup/tests/data/shellmound/tmr_parent/gis/irregular_boundary.shp'
+  buffer: 0
+  dxy: 1000  # Uniform x, y spacing in meters
+  rotation: 0.
+  crs: 5070  # EPSG code for NAD83 CONUS Albers (meters)
+  snap_to_NHG: True  # option to snap to the USGS National Hydrogeologic Grid
+
+dis:
+  remake_top: True
+  options:
+    length_units: 'meters'
+  dimensions:
+    nlay: 1
+  source_data:
+    top:
+      filename: '../mfsetup/tests/data/shellmound/rasters/meras_100m_dem.tif'
+      elevation_units: 'feet'
+    botm:
+      filenames:
+        0: '../mfsetup/tests/data/shellmound/rasters/mdwy_surf.tif'
+      elevation_units: 'feet'
+    idomain:
+      # polygon shapefile of model active area
+      filename: '../mfsetup/tests/data/shellmound/tmr_parent/gis/irregular_boundary.shp'
+
+tdis:
+  options:
+    time_units: 'days'
+    start_date_time: '2020-01-01'
+  perioddata:
+    group 1:
+      perlen: 1
+      nper: 1
+      nstp: 1
+      steady: True
+
+npf:
+  options:
+    save_flows: True
+    rewet: True
+  griddata:
+    icelltype: 1
+    k: 30.
+    k33: 0.3
+
+sto:
+  options:
+    save_flows: True
+  griddata:
+    iconvert: 1  # convertible layers
+    sy: 0.2
+    ss: 1.e-6
+
+rch:
+  options:
+    print_input: True
+    print_flows: False
+    save_flows: True
+    readasarrays: True
+  recharge: 0.00025  # 0.00025 m/d ~ 3.5 inches/year
+
+sfr:
+  options:
+    save_flows: True
+  source_data:
+    flowlines:
+      filename: '../mfsetup/tests/data/shellmound/shps/flowlines.shp'
+      id_column: 'COMID'  # arguments to sfrmaker.lines.from_shapefile
+      routing_column: 'tocomid'
+      width1_column: 'width1'
+      width2_column: 'width2'
+      up_elevation_column: 'elevupsmo'
+      dn_elevation_column: 'elevdnsmo'
+      name_column: 'GNIS_NAME'
+      width_units: 'feet'  # units of flowline widths
+      elevation_units: 'feet'  # units of flowline elevations
+  sfrmaker_options:
+    one_reach_per_cell: True #  consolidate SFR reaches to one per i, j location
+    to_riv: # convert this line and all downstream lines to the RIV package
+      - 18047206
+
+oc:
+  period_options:
+    0: ['save head last','save budget last']
+
+ims:
+  options:
+    print_option: 'all'
+    complexity: 'complex'
+    csv_output_filerecord: 'solver_out.csv'
+  nonlinear:
+    outer_dvclose: 1.  # m3/d in SFR package
+    outer_maximum: 50
+  linear:
+    inner_maximum: 100
+    inner_dvclose: 0.01
+    rcloserecord: [0.001, 'relative_rclose']

_downloads/6ba4574d50dc50b6efce72feea6132c7/update_starting_heads_from_previous.py

@@ -0,0 +1,20 @@
+"""Update model starting heads from previous (initial steady-state) solution
+"""
+from pathlib import Path
+
+import numpy as np
+from flopy.utils import binaryfile as bf
+
+model_ws = Path('.')
+headfile = model_ws / 'model.hds'
+starting_heads_file_fmt = str(model_ws / 'external/strt_{:03d}.dat')
+
+
+hdsobj = bf.HeadFile(headfile)
+print(f'reading {headfile}...')
+
+initial_ss_heads = hdsobj.get_data(kstpkper=(0, 0))
+for per, layer_heads in enumerate(initial_ss_heads):
+    outfile = starting_heads_file_fmt.format(per)
+    np.savetxt(starting_heads_file_fmt.format(per), layer_heads, fmt='%.2f')
+    print(f"updated {outfile}")

_downloads/ad797c943aa792619c7a8c98cfbd6638/initial_config_poly.yaml

@@ -0,0 +1,24 @@
+simulation:
+  sim_name: 'shellmound'
+  version: 'mf6'
+  sim_ws: 'model'
+
+model:
+  simulation: 'shellmound'
+  modelname: 'shellmound'
+  options:
+    print_input: True
+    save_flows: True
+    newton: True
+  packages: [
+  ]
+
+setup_grid:
+  source_data:
+    features_shapefile:
+      filename: '../mfsetup/tests/data/shellmound/tmr_parent/gis/irregular_boundary.shp'
+  buffer: 0
+  dxy: 1000  # Uniform x, y spacing in meters
+  rotation: 0.
+  crs: 5070  # EPSG code for NAD83 CONUS Albers (meters)
+  snap_to_NHG: True  # option to snap to the USGS National Hydrogeologic Grid

_downloads/b6ae5d6478362c1168ffc009e617fa38/initial_grid_setup.py

@@ -0,0 +1,13 @@
+from mfsetup import MF6model
+
+
+def setup_grid(cfg_file):
+    """Just set up (a shapefile of) the model grid.
+    For trying different grid configurations."""
+    m = MF6model(cfg=cfg_file)
+    m.setup_grid()
+    m.modelgrid.write_shapefile('postproc/shps/grid.shp')
+
+if __name__ == '__main__':
+
+    setup_grid('initial_config_poly.yaml')

_downloads/baf13b4007664691088da3dfada3c732/initial_config_box.yaml

@@ -0,0 +1,24 @@
+simulation:
+  sim_name: 'shellmound'
+  version: 'mf6'
+  sim_ws: 'model'
+
+model:
+  simulation: 'shellmound'
+  modelname: 'shellmound'
+  options:
+    print_input: True
+    save_flows: True
+    newton: True
+  packages: [
+  ]
+
+setup_grid:
+  xoff: 501405 # lower left x-coordinate
+  yoff: 1175835 # lower left y-coordinate
+  nrow: 30
+  ncol: 35
+  dxy: 1000
+  rotation: 0.
+  epsg: 5070
+  snap_to_NHG: True

_downloads/e1fbf3d202706a1435f28708d4ab74a5/initial_model_setup.py

@@ -0,0 +1,30 @@
+import os
+
+from mfsetup import MF6model
+
+
+def setup_grid(cfg_file):
+    """Just set up (a shapefile of) the model grid.
+    For trying different grid configurations."""
+    cwd = os.getcwd()
+    m = MF6model(cfg=cfg_file)
+    m.setup_grid()
+    m.modelgrid.write_shapefile('postproc/shps/grid.shp')
+    # Modflow-setup changes the working directory
+    # to the model workspace; change it back
+    os.chdir(cwd)
+
+
+def setup_model(cfg_file):
+    """Set up the whole model."""
+    cwd = os.getcwd()
+    m = MF6model.setup_from_yaml(cfg_file)
+    m.write_input()
+    os.chdir(cwd)
+    return m
+
+
+if __name__ == '__main__':
+
+    #setup_grid('initial_config_poly.yaml')
+    setup_model('initial_config_full.yaml')

_modules/index.html

@@ -0,0 +1,141 @@
+
+
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" data-content_root="../">
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>Overview: module code &mdash; modflow-setup 0.5.0.post59+g65803fd documentation</title>
+      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
+      <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
+      <link rel="stylesheet" type="text/css" href="../_static/plot_directive.css" />
+      <link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
+
+
+      <script src="../_static/jquery.js?v=5d32c60e"></script>
+      <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+      <script src="../_static/documentation_options.js?v=4370c7ca"></script>
+      <script src="../_static/doctools.js?v=9bcbadda"></script>
+      <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+      <script src="../_static/clipboard.min.js?v=a7894cd8"></script>
+      <script src="../_static/copybutton.js?v=f281be69"></script>
+      <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
+    <script src="../_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+          <a href="../index.html" class="icon icon-home">
+            modflow-setup
+          </a>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption" role="heading"><span class="caption-text">Getting Started</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../philosophy.html">     Philosophy</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../installation.html"> Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../10min.html"> 10 Minutes to Modflow-setup</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../examples.html"> Examples</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../config-file-gallery.html"> Configuration File Gallery</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">User Guide</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../structure.html"> Basic program structure and usage</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../config-file.html"> The configuration file</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../concepts/index.html"> Concepts and methods</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../input/index.html"> Input instructions by package</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../troubleshooting.html"> Troubleshooting</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Reference</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../api/index.html"> Code reference</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../config-file-defaults.html"> Configuration file defaults</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../release-history.html"> Release History</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../contributing.html"> Contributing to modflow-setup</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Bibliography</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../references.html">References</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../references.html#modflow-setup-applications">Modflow-setup applications</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../references.html#workflow-examples">Workflow examples</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../index.html">modflow-setup</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
+      <li class="breadcrumb-item active">Overview: module code</li>
+      <li class="wy-breadcrumbs-aside">
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <h1>All modules for which code is available</h1>
+<ul><li><a href="mfsetup/discretization.html">mfsetup.discretization</a></li>
+<li><a href="mfsetup/fileio.html">mfsetup.fileio</a></li>
+<li><a href="mfsetup/grid.html">mfsetup.grid</a></li>
+<li><a href="mfsetup/interpolate.html">mfsetup.interpolate</a></li>
+<li><a href="mfsetup/mf6model.html">mfsetup.mf6model</a></li>
+<li><a href="mfsetup/mfmodel.html">mfsetup.mfmodel</a></li>
+<li><a href="mfsetup/mfnwtmodel.html">mfsetup.mfnwtmodel</a></li>
+<li><a href="mfsetup/tdis.html">mfsetup.tdis</a></li>
+<li><a href="mfsetup/tmr.html">mfsetup.tmr</a></li>
+</ul>
+
+           </div>
+          </div>
+          <footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2019-2024, Modflow-setup developers |.
+      <span class="lastupdated">Last updated on Nov 14, 2024.
+      </span></p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>