SFRmaker

version 0.11.2.post8.dev0+g5138354

Go to the GitHub site

Read the paper

---

Getting Started

• Philosophy
  • Motivation
  • What SFRmaker does
  • What SFRmaker doesn’t do
  • Read more
    • Cited References
• Examples
  • MERAS 3: Creating an SFR package from a configuration file with custom hydrography
    • meras_sfrmaker_config.yml:
    • make_sfr.py:
  • The Tyler Forks watershed: Creating an SFR package from a configuration file using NHDPlus
    • tf_sfrmaker_config.yml:
    • tylerforks/make_sfr.py:
    • Running the tylerforks model
• Installation
  • Installing python dependencies with Conda
    • Download and install a python distribution and Conda-like package manager
    • Download an environment file
    • Creating a Conda environment using Mamba
    • Keeping the Conda environment up to date
  • Installing SFRmaker
    • Installing and updating SFRmaker from PyPI
    • Installing the latest develop version of SFRmaker
    • Installing the SFRmaker source code in-place
  • Installing the IPython kernel to use SFRmaker in Jupyter Notebooks
  • Best practices
  • Considerations for USGS Users (or anyone else with an organizational SSL certificate)
    • Installing the DOI SSL certificate for use with pip
    • Installing the DOI SSL certificate for use with git
    • 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 building a conda environment or using pip
      • If you are on the USGS network, using Windows, and you get this error message:

User Guide

• Input Requirements
  • 1) Hydrography data
  • 2) Model grid information
• Using SFRmaker with a configuration file
  • MERAS 3: Creating an SFR package from a configuration file with custom hydrography
  • The Tyler Forks watershed: Creating an SFR package from a configuration file using NHDPlus
• Basic Usage in a scripting context
  • Input requirements
  • Creating a Lines instance from NHDPlus
  • Creating a Lines instance from custom hydrography
  • Specifying a model grid from a flopy StructuredGrid instance
  • Specifying a model grid from a shapefile
  • Using the modelgrid attached to a flopy model
  • Specifying a model
  • Creating an SFRData instance
  • The SFRData class
  • Sampling streambed top elevations from a DEM
  • Assigning layers to the reaches
  • Running diagnostics
  • Writing an SFR package
  • Writing a MODFLOW-6 SFR package
  • Writing tables
  • Writing shapefiles
• Preprocessing NHDPlus version 2 data
  • Merging and culling flowlines
  • Preprocessing the flowlines
  • Clipping the flowlines to a specific area
• Using SFRmaker with NHDPlus High Resolution
  • 1. Preview NHDPlusHR geodatabases
  • 2. Filter network using shapefile boundary
  • 3. Option to remove reaches with unwated FCodes
  • 4. Make an sfrmaker.lines instance using from_nhdplus_hr
  • 5. Create a streamflow routing dataset and write an SFR package input file for MODDLOW
• Concepts and methods
  • How the streambed elevation sampling works
• Stand-alone tools
  • Methods for working with the SFR routing network, or any other directed acyclic graph (DAG)
• Troubleshooting
  • My script doesn’t run

Reference

• Code reference
• Summary of configuration file options
• Release History
• Contributing to SFRmaker

Bibliography

• References cited