Nicolet National Forest Unit (Northern part)

This page shows another example of using Linesink-maker to construct a GFLOW model, for the northern part of the Nicolet National Forest Unit in Northern Wisconsin. The files for this example can be found in the examples/nicolet subfolder of the Linesink-maker repository. To run the example, simply run the included make_linesinks.py script at the command line with Nicolet_lines.xml configuration file as an argument:

python make_linesinks.py Nicolet_lines.xml

See the Medford example for a more detailed description of the input options, and an example of the more human-readable YAML configuration file format.

Configuration file in XML format (Nicolet_lines.xml)

<linesinkInput>
<!--
Notes on linesinkMaker input:
    All shps should be in (same) model coordinate units (e.g. ft.)
    If model domain contains a major divide, need to merge relevant NHD datasets
        (e.g. 04 and 07) prior to running this script
    Put in paths to input/output files as-is (i.e. no double \)
-->
<GlobalSettings>
    <!-- working_dir:
    full path to working folder where intermediate and output will be generated. -->
    <working_dir></working_dir>
    <!-- zmult:
    elevation units multiplier (from NHDPlus cm to model units) -->
    <zmult>0.03280839895013123</zmult>
    <!-- resistance:
    global resistance value to apply to all resistance LinesinkData (c in GFLOW documentation) -->
    <resistance>0.3</resistance>
    <!-- H:
    aquifer thickness in model units -->
    <H>100</H>
    <!-- k:
    Hydraulic conductivity in model units -->
    <k>10</k>
    <!-- ScenResistance:
    name for global resistance parameter to assign to LinesinkData-->
    <ScenResistance>Rlinesink</ScenResistance>
    <!-- ComputationalUnits: ('Feet' or 'Meters')
    model units-->
    <ComputationalUnits>Feet</ComputationalUnits>
    <!-- BasemapUnits: ('Feet' or 'Meters')
    Units of the model basemaps-->
    <BasemapUnits>Meters</BasemapUnits>
</GlobalSettings>

<modelDomain>
    <!-- farfield:
    polygon shapefile (a ring, with nearfield making up the side) of the desired model farfield area
    LinesinkData within this area will be zero resistance (specified head) -->
    <farfield>shps/Nicolet_north_FF.shp</farfield>
    <!-- nearfield:
    polygon of the model nearfield area, where LinesinkData will be given resistance and routed -->
    <nearfield>shps/Nicolet_north_NF.shp</nearfield>
    <!-- split_by_HUC:
    option to split out LinesinkData by HUC, writing one lss file per HUC -->
    <split_by_HUC>False</split_by_HUC>
    <HUC_shp>None</HUC_shp>
    <HUC_name_field>None</HUC_name_field>
</modelDomain>
<!-- NHDfiles:
input .shp and .dbf files from NHDPlus. To include multiple files
(e.g. multiple flowlines files spanning multiple drainage areas)
simply add additional entries with same XML keyword.
LinesinkMakr will open all of the files and combine them.-->
<NHDfiles>
    <flowlines>shps/Nicolet_flowlines.shp</flowlines>
    <elevslope>shps/NHDPlus04/NHDPlusAttributes/elevslope.dbf</elevslope>
    <elevslope>shps/NHDPlus07/NHDPlusAttributes/elevslope.dbf</elevslope>
    <PlusFlowVAA>shps/NHDPlus04/NHDPlusAttributes/PlusFlowlineVAA.dbf</PlusFlowVAA>
    <PlusFlowVAA>shps/NHDPlus07/NHDPlusAttributes/PlusFlowlineVAA.dbf</PlusFlowVAA>
    <waterbodies>shps/NHDwaterbodies.shp</waterbodies>
</NHDfiles>

<Simplification>
    <!-- nearfield_tolerance:
    maximum distance a simplified line can deviate from the original linework -->
    <nearfield_tolerance>200</nearfield_tolerance>
    <!-- farfield_tolerance:
    maximum distance a simplified line can deviate from the original linework -->
    <farfield_tolerance>500</farfield_tolerance>
    <!-- min_farfield_order:
    minimum stream order to retain in farfield -->
    <min_farfield_order>2</min_farfield_order>
    <!-- min_waterbody_size:
    minimum sized waterbodies to retain (km2) -->
    <min_waterbody_size>1.0</min_waterbody_size>
    <!-- drop_crossing:
    Line simplification can lead to some lines crossing.
    In instances of crossing, remove the line representing this smaller of the two streams
    (as indicated by a lower arbolate sum value)-->
    <drop_crossing>True</drop_crossing>
</Simplification>

<outputs>
    <outfile_basename>Nicolet</outfile_basename>
    <error_reporting>linesinkMaker_errors.txt</error_reporting>
</outputs>
</linesinkInput>

make_linesinks.py

import sys
import lsmaker

try:
    input_file = sys.argv[1]
except IndexError:
    print("\nusage is: python make_linesinks.py <configuration file>\n")
    quit()

ls = lsmaker.LinesinkData(input_file)

ls.preprocess(save=True)

ls.make_linesinks(shp='preprocessed/lines.shp')