Updates(MF6Output): Added budgetcsv method to .output attribute

autotest/t504_test.py

@@ -1182,6 +1182,7 @@ def test_mf6_output():
     ml = sim.get_model("gwf_1")
 
     bud = ml.oc.output.budget()
+    budcsv = ml.oc.output.budgetcsv()
     hds = ml.oc.output.head()
     lst = ml.oc.output.list()
 
@@ -1191,6 +1192,9 @@ def test_mf6_output():
     if not isinstance(bud, flopy.utils.CellBudgetFile):
         raise TypeError()
 
+    if not isinstance(budcsv, flopy.utils.observationfile.CsvFile):
+        raise TypeError()
+
     if not isinstance(hds, flopy.utils.HeadFile):
         raise TypeError()
 
@@ -1201,13 +1205,17 @@ def test_mf6_output():
         raise AssertionError()
 
     bud = ml.output.budget()
+    budcsv = ml.output.budgetcsv()
     hds = ml.output.head()
     zonbud = ml.output.zonebudget(idomain)
     lst = ml.output.list()
 
     if not isinstance(bud, flopy.utils.CellBudgetFile):
         raise TypeError()
 
+    if not isinstance(budcsv, flopy.utils.observationfile.CsvFile):
+        raise TypeError()
+
     if not isinstance(hds, flopy.utils.HeadFile):
         raise TypeError()
 
@@ -1219,13 +1227,17 @@ def test_mf6_output():
 
     uzf = ml.uzf
     uzf_bud = uzf.output.budget()
+    uzf_budcsv = uzf.output.budgetcsv()
     conv = uzf.output.package_convergence()
     uzf_obs = uzf.output.obs()
     uzf_zonbud = uzf.output.zonebudget(idomain)
 
     if not isinstance(uzf_bud, flopy.utils.CellBudgetFile):
         raise TypeError()
 
+    if not isinstance(uzf_budcsv, flopy.utils.observationfile.CsvFile):
+        raise TypeError()
+
     if conv is not None:
         if not isinstance(conv, flopy.utils.observationfile.CsvFile):
             raise TypeError()
@@ -1292,7 +1304,6 @@ def test_mf6_output_add_observation():
     test006_gwf3()
     test027_timeseriestest()
     test036_twrihfb()
-    test045_lake1ss_table()
     test045_lake2tr()
     test_mf6_output()
     test_mf6_output_add_observation()

examples/Tutorials/modflow6output/tutorial01_mf6_output.py

@@ -59,6 +59,10 @@
 # |                       | the model. Accessed from the model object or   |
 # |                       | the OC package object                          |
 # +-----------------------+------------------------------------------------+
+# | budgetcsv()           | Method to get the MODFLOW-6 budget csv as a    |
+# |                       | `CsvFile` object. Valid for model, oc, and     |
+# |                       | advanced packages such as MAW, UZF, LAK        |
+# +-----------------------+------------------------------------------------+
 # | zonebudget()          | Method to get the `ZoneBudget6` object for     |
 # |                       | the model. Accessed from the model object or   |
 # |                       | the OC package object                          |
@@ -99,6 +103,9 @@
 bud = ml.output.budget()
 bud.get_data(idx=0, full3D=True)
 
+budcsv = ml.output.budgetcsv()
+budcsv.data
+
 hds = ml.output.head()
 hds.get_data()
 
@@ -111,13 +118,16 @@
 # ## Get output associated with a specific package
 # The `.output` attribute is tied to the package object and allows the user
 # to get the output types specified in the MODFLOW 6 package. Here is an
-# example with a UZF package that has UZF budget file output,
-# package convergence output, and observation data.
+# example with a UZF package that has UZF budget file output, budgetcsv
+# file output, package convergence output, and observation data.
 
 uzf = ml.uzf
 uzf_bud = uzf.output.budget()
 uzf_bud.get_data(idx=0)
 
+uzf_budcsv = uzf.output.budgetcsv()
+uzf_budcsv.data
+
 uzf_conv = uzf.output.package_convergence()
 if uzf_conv is not None:
     uzf_conv.data[0:10]

examples/data/mf6/test001e_UZF_3lay/test001e_UZF_3lay.oc

@@ -2,6 +2,7 @@
 BEGIN OPTIONS
   HEAD FILEOUT test001e_UZF_3lay.hds
   BUDGET FILEOUT test001e_UZF_3lay.cbc
+  BUDGETCSV FILEOUT test001e_UZF_3lay.cbc.csv
 END OPTIONS
 
 BEGIN PERIOD 1

examples/data/mf6/test001e_UZF_3lay/test001e_UZF_3lay.uzf

@@ -5,6 +5,7 @@ Begin options
   PRINT_FLOWS
   OBS6 FILEIN test001e_UZF_3lay.obs
   BUDGET FILEOUT test001e_UZF_3lay.uzf.cbc
+  BUDGETCSV FILEOUT test001e_UZF_3lay.uzf.cbc.csv
   PACKAGE_CONVERGENCE FILEOUT test001e_UZF_3lay.uzf_convergence.csv
   SIMULATE_GWSEEP
   SIMULATE_ET   

flopy/mf6/data/dfn/exg-gwfgwf.dfn

@@ -75,6 +75,14 @@ optional true
 longname keyword to activate Newton-Raphson
 description keyword that activates the Newton-Raphson formulation for groundwater flow between connected, convertible groundwater cells. Cells will not dry when this option is used.
 
+block options
+name xt3d
+type keyword
+reader urword
+optional true
+longname keyword to activate XT3D
+description keyword that activates the XT3D formulation between the cells connected with this GWF-GWF Exchange.
+
 block options
 name gnc_filerecord
 type record gnc6 filein gnc6_filename

flopy/mf6/data/dfn/gwf-lak.dfn

@@ -127,6 +127,39 @@ optional false
 longname file keyword
 description name of the binary output file to write budget information.
 
+block options
+name budgetcsv_filerecord
+type record budgetcsv fileout budgetcsvfile
+shape
+reader urword
+tagged true
+optional true
+longname
+description
+
+block options
+name budgetcsv
+type keyword
+shape
+in_record true
+reader urword
+tagged true
+optional false
+longname budget keyword
+description keyword to specify that record corresponds to the budget CSV.
+
+block options
+name budgetcsvfile
+type string
+preserve_case true
+shape
+in_record true
+reader urword
+tagged false
+optional false
+longname file keyword
+description name of the comma-separated value (CSV) output file to write budget summary information.  A budget summary record will be written to this file for each time step of the simulation.
+
 block options
 name package_convergence_filerecord
 type record package_convergence fileout package_convergence_filename

flopy/mf6/data/dfn/gwf-maw.dfn

@@ -127,6 +127,39 @@ optional false
 longname file keyword
 description name of the binary output file to write budget information.
 
+block options
+name budgetcsv_filerecord
+type record budgetcsv fileout budgetcsvfile
+shape
+reader urword
+tagged true
+optional true
+longname
+description
+
+block options
+name budgetcsv
+type keyword
+shape
+in_record true
+reader urword
+tagged true
+optional false
+longname budget keyword
+description keyword to specify that record corresponds to the budget CSV.
+
+block options
+name budgetcsvfile
+type string
+preserve_case true
+shape
+in_record true
+reader urword
+tagged false
+optional false
+longname file keyword
+description name of the comma-separated value (CSV) output file to write budget summary information.  A budget summary record will be written to this file for each time step of the simulation.
+
 block options
 name no_well_storage
 type keyword

flopy/mf6/data/dfn/gwf-mvr.dfn

@@ -68,6 +68,39 @@ optional false
 longname file keyword
 description name of the output file to write budget information.
 
+block options
+name budgetcsv_filerecord
+type record budgetcsv fileout budgetcsvfile
+shape
+reader urword
+tagged true
+optional true
+longname
+description
+
+block options
+name budgetcsv
+type keyword
+shape
+in_record true
+reader urword
+tagged true
+optional false
+longname budget keyword
+description keyword to specify that record corresponds to the budget CSV.
+
+block options
+name budgetcsvfile
+type string
+preserve_case true
+shape
+in_record true
+reader urword
+tagged false
+optional false
+longname file keyword
+description name of the comma-separated value (CSV) output file to write budget summary information.  A budget summary record will be written to this file for each time step of the simulation.
+
 # --------------------- gwf mvr dimensions ---------------------
 
 block dimensions

flopy/mf6/data/dfn/gwf-npf.dfn

@@ -159,6 +159,49 @@ optional true
 longname keyword to indicate that specified K33 is a ratio
 description keyword to indicate that specified K33 is a ratio of K33 divided by K.  If this option is specified, then the K33 array entered in the NPF Package will be multiplied by K after being read.
 
+block options
+name tvk_filerecord
+type record tvk6 filein tvk_filename
+shape
+reader urword
+tagged true
+optional true
+longname
+description
+
+block options
+name tvk6
+type keyword
+shape
+in_record true
+reader urword
+tagged true
+optional false
+longname tvk keyword
+description keyword to specify that record corresponds to a time-varying hydraulic conductivity (TVK) file.  The behavior of TVK and a description of the input file is provided separately.
+
+block options
+name filein
+type keyword
+shape
+in_record true
+reader urword
+tagged true
+optional false
+longname file keyword
+description keyword to specify that an input filename is expected next.
+
+block options
+name tvk_filename
+type string
+preserve_case true
+in_record true
+reader urword
+optional false
+tagged false
+longname file name of TVK information
+description defines a time-varying hydraulic conductivity (TVK) input file.  Records in the TVK file can be used to change hydraulic conductivity properties at specified times or stress periods.
+
 
 # --------------------- gwf npf griddata ---------------------
 

flopy/mf6/data/dfn/gwf-oc.dfn

@@ -44,6 +44,39 @@ optional false
 longname file keyword
 description name of the output file to write budget information.
 
+block options
+name budgetcsv_filerecord
+type record budgetcsv fileout budgetcsvfile
+shape
+reader urword
+tagged true
+optional true
+longname
+description
+
+block options
+name budgetcsv
+type keyword
+shape
+in_record true
+reader urword
+tagged true
+optional false
+longname budget keyword
+description keyword to specify that record corresponds to the budget CSV.
+
+block options
+name budgetcsvfile
+type string
+preserve_case true
+shape
+in_record true
+reader urword
+tagged false
+optional false
+longname file keyword
+description name of the comma-separated value (CSV) output file to write budget summary information.  A budget summary record will be written to this file for each time step of the simulation.
+
 block options
 name head_filerecord
 type record head fileout headfile