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  name_column: name
 47  bbox_filter: None
 48  crs: None
 49  prjfile: None
 50  # NHDPlus option (arguments to sfrmaker.Lines.from_nhdplus_v2):
 51  NHDPlus_paths: None
 52  NHDFlowlines: None
 53  PlusFlowlineVAA: None
 54  PlusFlow: None
 55  elevslope: None
 56
 57simulation:
 58  # Simulation information
 59  # (MODFLOW-6 only; arguments to flopy.mf6.MFSimulation.load):
 60  sim_name: modflowsim
 61  version: mf6
 62  exe_name: mf6
 63  sim_ws: .
 64  strict: True
 65  verbosity_level: 1
 66  load_only: None
 67  verify_data: False
 68  write_headers: True
 69  lazy_io: False
 70  use_pandas: True
 71
 72model:
 73  # MODFLOW-NWT or MODFLOW-2005 information
 74  # (arguments to flopy.modflow.Modflow.load):
 75  namefile: None  # "f" argument in flopy
 76  version: mf2005
 77  exe_name: mf2005
 78  verbose: False
 79  model_ws: .
 80  load_only: None
 81  forgive: False
 82  check: True
 83  extra_pkgs: None
 84  # MODFLOW-6 information
 85  # (arguments to flopy.mf6.MFSimulation.get_model):
 86  model_name: None
 87
 88dem:
 89  # Option to sample streambed top elevations from a DEM
 90  # (arguments to sfrmaker.SFRData.set_streambed_top_elevations_from_dem):
 91  filename: None
 92  elevation_units: None
 93  method: buffers
 94  # keyword arguments to sfrmaker.SFRData.sample_reach_elevations:
 95  buffer_distance: 100
 96  smooth: True
 97  elevation_data: None
 98  elevation_data_crs: None
 99  elevation_data_layer: None
100  elevation_data_errors: raise
101
102inflows:
103  # Option to add specified inflows
104  # (arguments to sfrmaker.SFRData.add_to_perioddata for MODFLOW-6):
105  data: None
106  flowline_routing: None
107  variable: inflow
108  line_id_column: None
109  rno_column: None
110  period_column: per
111  data_column: Q_avg
112  one_inflow_per_path: False
113  distribute_flows_to_reaches: False
114  # (arguments to sfrmaker.SFRData.add_to_segment_data for MODFLOW-2005):
115  segment_column: segment
116
117observations:
118  # Option to add SFR observation input
119  # (arguments to sfrmaker.SFRData.add_observations):
120  data: None
121  flowline_routing: None
122  obstype: None
123  sfrlines_shapefile: None
124  x_location_column: None
125  y_location_column: None
126  line_id_column: None
127  rno_column: None
128  obstype_column: None
129  obsname_column: site_no
130  gage_starting_unit_number: 250
131
132to_riv:
133  # Option to convert parts of the SFR network
134  # downstream of specified line_ids to the RIV package:
135  line_ids: None
136  drop_in_sfr: True
137
138options:
139  # SFR options (arguments to sfrmaker.Lines.to_sfr):
140  active_area: None
141  isfr: None
142  model_length_units: undefined
143  model_time_units: days
144  minimum_reach_length: None
145  width_from_asum_a_param: 0.1193
146  width_from_asum_b_param: 0.5032
147  minimum_reach_width: 1.0
148  consolidate_conductance: False
149  one_reach_per_cell: False
150  add_outlets: None
151  # keyword arguments to sfrmaker.SFRData:
152  enforce_increasing_nsegs: True
153  default_slope: 0.001
154  minimum_slope: 0.0001
155  maximum_slope: 1.0