SFRmaker configuration file options

Below is a comprehensive summary of the input options supported in the SFRmaker configuration file. Most keys in the YAML blocks represent arguments to methods within SFRmaker or Flopy. Additional description of method arguments is available in the SFRmaker code reference and Flopy documentation.

  1# Summary of SFRmaker configuration file options
  2
  3package_version: mf6  # mf6, mfnwt or mf2005
  4package_name: model  # (defaults to model or simulation name if not specified)
  5output_path: "."  # where the output will be written
  6
  7modelgrid:
  8  # Shapefile option (arguments to sfrmaker.grid.StructuredGrid.from_shapefile):
  9  shapefile: None
 10  node_col: node
 11  kcol: k
 12  icol: i
 13  jcol: j
 14  isfr_col: isfr
 15  active_area: None
 16  crs: None
 17  prjfile: None
 18  # Flopy modelgrid option (arguments to flopy.discretization.StructuredGrid):
 19  delc: None
 20  delr: None
 21  top: None
 22  botm: None
 23  idomain: None
 24  lenuni: None
 25  xoff: 0.0
 26  yoff: 0.0
 27  angrot: 0.0
 28  nlay: None
 29  nrow: None
 30  ncol: None
 31  laycbd: None
 32
 33flowlines:
 34  # Custom hydrography option (arguments to sfrmaker.Lines.from_shapefile):
 35  shapefile: None
 36  id_column: id
 37  routing_column: toid
 38  arbolate_sum_column2: asum2
 39  asum_units: km
 40  width1_column: width1
 41  width2_column: width2
 42  width_units: meters
 43  up_elevation_column: elevup
 44  dn_elevation_column: elevdn
 45  elevation_units: meters
 46  length_units: None
 47  name_column: name
 48  bbox_filter: None
 49  crs: None
 50  prjfile: None
 51  # NHDPlus option (arguments to sfrmaker.Lines.from_nhdplus_v2):
 52  NHDPlus_paths: None
 53  NHDFlowlines: None
 54  PlusFlowlineVAA: None
 55  PlusFlow: None
 56  elevslope: None
 57
 58simulation:
 59  # Simulation information
 60  # (MODFLOW-6 only; arguments to flopy.mf6.MFSimulation.load):
 61  sim_name: modflowsim
 62  version: mf6
 63  exe_name: mf6
 64  sim_ws: .
 65  strict: True
 66  verbosity_level: 1
 67  load_only: None
 68  verify_data: False
 69  write_headers: True
 70  lazy_io: False
 71  use_pandas: True
 72
 73model:
 74  # MODFLOW-NWT or MODFLOW-2005 information
 75  # (arguments to flopy.modflow.Modflow.load):
 76  namefile: None  # "f" argument in flopy
 77  version: mf2005
 78  exe_name: mf2005
 79  verbose: False
 80  model_ws: .
 81  load_only: None
 82  forgive: False
 83  check: True
 84  extra_pkgs: None
 85  # MODFLOW-6 information
 86  # (arguments to flopy.mf6.MFSimulation.get_model):
 87  model_name: None
 88
 89dem:
 90  # Option to sample streambed top elevations from a DEM
 91  # (arguments to sfrmaker.SFRData.set_streambed_top_elevations_from_dem):
 92  filename: None
 93  elevation_units: None
 94  method: buffers
 95  # keyword arguments to sfrmaker.SFRData.sample_reach_elevations:
 96  buffer_distance: 100
 97  smooth: True
 98  elevation_data: None
 99  elevation_data_crs: None
100  elevation_data_layer: None
101  elevation_data_errors: raise
102
103inflows:
104  # Option to add specified inflows
105  # (arguments to sfrmaker.SFRData.add_to_perioddata for MODFLOW-6):
106  data: None
107  flowline_routing: None
108  variable: inflow
109  line_id_column: None
110  rno_column: None
111  period_column: per
112  data_column: Q_avg
113  one_inflow_per_path: False
114  distribute_flows_to_reaches: False
115  # (arguments to sfrmaker.SFRData.add_to_segment_data for MODFLOW-2005):
116  segment_column: segment
117
118observations:
119  # Option to add SFR observation input
120  # (arguments to sfrmaker.SFRData.add_observations):
121  data: None
122  flowline_routing: None
123  obstype: None
124  sfrlines_shapefile: None
125  x_location_column: None
126  y_location_column: None
127  line_id_column: None
128  rno_column: None
129  obstype_column: None
130  obsname_column: site_no
131  gage_starting_unit_number: 250
132  site_location_distance_threshold: 1000
133
134to_riv:
135  # Option to convert parts of the SFR network
136  # downstream of specified line_ids to the RIV package:
137  line_ids: None
138  drop_in_sfr: True
139
140options:
141  # SFR options (arguments to sfrmaker.Lines.to_sfr):
142  active_area: None
143  isfr: None
144  model_length_units: undefined
145  model_time_units: days
146  minimum_reach_length: None
147  width_from_asum_a_param: 0.1193
148  width_from_asum_b_param: 0.5032
149  minimum_reach_width: 1.0
150  consolidate_conductance: False
151  one_reach_per_cell: False
152  add_outlets: None
153  # keyword arguments to sfrmaker.SFRData:
154  enforce_increasing_nsegs: True
155  default_slope: 0.001
156  minimum_slope: 0.0001
157  maximum_slope: 1.0
158  # keyword arguments to sfrmaker.SFRData.write_package:
159  filename: None
160  options: None
161  run_diagnostics: True
162  write_observations_input: True
163  external_files_path: None
164  gage_starting_unit_number: None
165  write_mf6_inactive_cellids_as_None: False