SFRmaker

version 0.12.1.post54.dev0+g1f885a0

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
  • Using SFRmaker with a configuration file: MERAS 3 example
    • meras_sfrmaker_config.yml:
    • make_sfr.py:
  • Using SFRmaker with a configuration file: Tyler Forks example
    • tf_sfrmaker_config.yml:
    • tylerforks/make_sfr.py:
    • Running the tylerforks model
  • Using SFRMaker in a script
    • Input requirements
      • Hydrography
    • 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
  • Using SFRmaker with NHDPlus High Resolution
    • 1. Preview NHDPlusHR geodatabases
      • Plot the raw NHD HR lines from the two geodatabases
        • Note: NHDPlusHR fileGDBs have EPSG:4269 CRS
    • 2. Filter network using shapefile boundary
    • 3. Option to remove reaches with unwated FCodes
    • 4. Make an sfrmaker.lines instance using from_nhdplus_hr
      • visualize the SFR network
    • 5. Create a streamflow routing dataset and write an SFR package input file for MODDLOW
      • write the sfr data set to a MODFLOW SFR file
      • Finally, we can review our completed SFR network
  • Converting a MODFLOW-2005 (SFR2) Package to MODFLOW 6
• 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
  • Using SFRmaker with a configuration file: MERAS 3 example
  • Using SFRmaker with a configuration file: Tyler Forks example
  • Using SFRMaker in a script
  • Using SFRmaker with NHDPlus High Resolution
  • Converting a MODFLOW-2005 (SFR2) Package to MODFLOW 6
• Concepts and methods
  • How the streambed elevation sampling works
• Other 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