linesink-maker

version 0.2.0.post0.dev0+gf95e937

---

Rapid creation of linesink elements for stream network simulation in the groundwater flow modeling program GFLOW (<http://www.haitjema.com/>). Nearfield (highest resultion), mid-field and farfield (least resolution, zero resistance) areas of a desired stream network can be defined by polygon shapefiles. The LinesinkData are then created from NHDPlus hydrography. The number of resulting linesink equations (level of detail) in the various areas of the stream network can be controlled by a distance tolerance parameter specified by geographic area (defined by one of the polygons). Results are written to a linesink string (LSS) XML file that can be imported into the GFLOW GUI (version 2.2 or higher).

Go to the GitHub repository

Getting Started

• Philosophy
  • Motivation
  • What linesink-maker does
  • What linesink-maker doesn’t do
• Installation
  • Required GFLOW version
  • Installing python dependencies with Conda
    • Download and install a python distribution and Conda-like package installer
    • Download an environment file
    • Creating a Conda environment using Mamba
    • Keeping the Conda environment up to date
  • Installing Linesink-maker
    • Installing and updating Linesink-maker from PyPI
    • Installing the latest develop version of Linesink-maker
    • Installing the Linesink-maker source code in-place
  • Installing the IPython kernel to use Linesink-maker in Jupyter Notebooks
  • Best practices
  • Considerations for USGS Users
    • Installing the DOI SSL certificate for use with pip
    • Installing the DOI SSL certificate for use with conda
    • Troubleshooting issues with the USGS network
      • SSL-related error messages when using conda
      • SSL-related error messages when using pip
      • If you are on the USGS network, using Windows, and you get this error message:
• Examples
  • Medford National Forest Unit Example
    • Configuration file in yaml format (Medford_lines.yml)
      • The GlobalSettings block
      • The ModelDomain block
      • The Simplification block
    • Python script to build the model (make_linesinks.py):
    • Alternative XML format for configuration file (Medford_lines.xml)
  • Nicolet National Forest Unit Example
    • Configuration file in XML format (Nicolet_lines.xml)
    • make_linesinks.py
  • Exporting and Visualizing GFLOW output
    • make a shapefile of the streamflow results
    • read in and plot the streamflow
    • Make a raster comparing simulated heads to a DEM
    • Plot the gridded heads from GFLOW
    • Plot raster of simulated flooded heads
    • Plot raster of simulated depth to groundwater

Usage

• Input requirements
• Creating the YAML Input file for Linesink-maker
• Running Linesink-maker
• Diagnosing errors
• Importing the linesink string file into GFLOW
• Viewing the LinesinkData in a GIS

Reference

• Code Reference
• Configuration defaults
• Release History

Developer

• Contributing to linesink-maker