docs: update release history; other minor doc fixes and removal of stale comments

Author: aleaf

docs/source/config-file-gallery.rst

@@ -28,7 +28,7 @@ Shellmound TMR inset test case
 * parent model grid defined with a SpatialReference subblock (which overrides information in MODFLOW Namefile)
 * DIS package top and bottom elevations copied from parent model
 * IC, NPF, STO, RCH, and WEL packages copied from parent model (default if not specified in config file)
-* `default OC configuration <#MODFLOW-6 configuration defaults>`_
+* :ref:`default OC configuration <MODFLOW-6 configuration defaults>`
 * variable time discretization
 * model grid aligned with the `National Hydrologic Grid`_
 * SFR network created from custom hydrography

docs/source/release-history.rst

@@ -2,6 +2,28 @@
 Release History
 ===============
 
+
+Version 0.3.0 (2023-07-25)
+----------------------------------------
+
+* Transient input to basic stress packages can now be supplied via a ``csvfile:`` block. Transient
+  values for the package variables are associated with the shapefile feature extents via an
+  ``id_column`` of values that match values in the shapefile id_column. Input can be mixed between
+  transient ``csvfile:`` input and static input supplied via rasters (that varies spatially)
+  or uniform global values. See the Basic stress packages section in the documentation for more details.
+* add automatic reprojection of NetCDF source data files
+* most Soil Water Balance code models should be work as-is
+* added ``crs:`` configuration file item to specify the coordinate reference system for NetCDF files
+  where coordinate reference information can't be parsed.
+* add support for inner and outer CSV file output in MODFLOW 6 IMS options (remap input to work with Flopy)
+* refactor ``grid.rasterize()`` function to work with standard Flopy ``StructuredGrid`` (s)
+* refactor MODFLOW 6 head observations setup
+* add ``allow_obs_in_bc_cells`` option to allow observations in boundary condition cells (previously not allowed).
+* put modflow-setup specific options in an ``mfsetup_options:`` sub-block, consistent with other packages
+* fixes to adapted to breaking changes with pandas 2.0 and revised flopy modelgrid/crs interface
+* fix ``AttributeError`` issue with model name not getting passed to flopy
+* some fixes to model version reporting in MODFLOW input file headers
+
 Version 0.2.0 (2023-02-06)
 ----------------------------------------
 * add minimal support for MODFLOW-2000 parent models and variably-spaced structured grids

mfsetup/tdis.py

@@ -465,7 +465,7 @@ def setup_perioddata(model,
         ============== =========================================
         start_datetime Start date of each model stress period
         end_datetime   End date of each model stress period
-        time           MODFLOW elapsed time, in days*
+        time           MODFLOW elapsed time, in days [#f1]_
         per            Model stress period number
         perlen         Stress period length (days)
         nstp           Number of timesteps in stress period
@@ -480,29 +480,19 @@ def setup_perioddata(model,
     perioddata is also saved to stress_period_data.csv in the tables folder
     (usually `/tables`).
 
-    *Modflow elapsed time includes the time lengths specified for
-    any steady-state periods (at least 1 day). Therefore if the model
-    has an initial steady-state period with a ``perlen`` of one day,
-    the elapsed time at the model start date will already be 1 day.
+    .. rubric:: Footnotes
+
+    .. [#f1] Modflow elapsed time includes the time lengths specified for
+        any steady-state periods (at least 1 day). Therefore if the model
+        has an initial steady-state period with a ``perlen`` of one day,
+        the elapsed time at the model start date will already be 1 day.
     """
     # get start_date_time from parent if available and start_date_time wasn't specified
     # only apply to tdis_perioddata_config if it wasn't specified there
     if tdis_perioddata_config.get('start_datetime', '1970-01-01') == '1970-01-01' and \
             default_start_datetime != '1970-01-01':
         tdis_perioddata_config['start_date_time'] = default_start_datetime
 
-    # cast steady array to boolean
-    #if steady is not None and not isinstance(steady, dict):
-    #    tdis_perioddata_config['steady'] = np.array(steady).astype(bool).tolist()
-
-    # get period data groups
-    # if no groups are specified, make a group from general stress period input
-    #cfg = self.cfg
-    defaults = {#'start_date_time': default_start_datetime,
-                #'nper': nper,
-                #'steady': steady,
-                #'oc_saverecord': oc_saverecord,
-                }
     perioddata_groups = parse_perioddata_groups(tdis_perioddata_config,
                                                 nper=nper, steady=steady,
                                                 start_date_time=default_start_datetime)