docs: updated release history; add flows and observations as automodules

Author: aleaf

Readme.md

@@ -3,7 +3,7 @@ SFRmaker
 SFRmaker is a python package for automating construction of stream flow routing networks from hydrography data. Hydrography are input from a polyline shapefile and intersected with a structured grid defined using a shapefile or a Flopy `StructuredGrid` instance. Attribute data are supplied via `.dbf` files (NHDPlus input option) or via specified fields in the hydrography shapefile. Line fragments representing intersections between the flowlines and model grid cells are converted to SFR reaches using the supplied attribute data. MODFLOW-NWT/2005 or MODFLOW-6 SFR package input can then be written, along with shapefiles for visualizing the SFR package dataset.
 
 
-### Version 0.7
+### Version 0.8
 
 ![Tests](https://github.com/usgs/sfrmaker/workflows/Tests/badge.svg)
 [![Coverage Status](https://codecov.io/github/usgs/SFRmaker/coverage.svg?branch=develop)](https://codecov.io/github/usgs/SFRmaker/coverage.svg?branch=develop)

docs/source/api/index.rst

@@ -3,9 +3,11 @@ Modules
 
 .. toctree::
 
+   Flows Module <sfrmaker.flows>
    Grid Module <sfrmaker.grid>
    Lines Module <sfrmaker.lines>
    MODFLOW-2005 to 6 Module <sfrmaker.mf5to6>
+   Observations Module <sfrmaker.observations>
    Preprocessing Module <sfrmaker.preprocessing>
    SFRData Module <sfrmaker.sfrdata>
    Utilities Module <sfrmaker.utils>

docs/source/api/sfrmaker.observations.rst

@@ -0,0 +1,7 @@
+The Observations Module
+=============================
+
+.. automodule:: sfrmaker.observations
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/release-history.rst

@@ -2,11 +2,18 @@
 Release History
 ===============
 
-Version 0.7.2 (2021-04-06)
+Version 0.8.0 (2021-04-19)
 --------------------------
-* Fix issue with starting arbolate sums, that was causing artificially narrow estimated widths on the first segment of any streams originating from outside of the model, by computing starting arbolate sums for each reach from the ending asum minus the line length.
-* Inflows: Allow multiple inflows to be specified along a single headwater to outlet path, via an optional one_inflow_per_path argument (default False; previously was hardcoded as True).
-* Observations: base unique observations on name and type; allowing multiple observation types (e.g. downstream-flow and stage) to be appended to the observations table via add_observations
+* Inflows: 
+    * Allow multiple inflows to be specified along a single headwater to outlet path, via an optional *one_inflow_per_path argument* (default False; previously was hardcoded as True).
+* Runoff and other stress period data (including inflows)
+    * Add support for specifying runoff (or other stress period inputs), allowing for multiple flows to be specified to a line, via lines IDs that may not be in the SFR package, but which route to lines in the SFR package. Routing information is provided by the ``flowline_routing argument`` to :meth:`sfrmaker.flows.add_to_perioddata` or :meth:`sfrmaker.sfrdata.SFRData.add_to_perioddata`. Line IDs may be missing if the linework was culled (i.e. to higher order streams or streams with a minimum arbolate sum). Runoff generated within the catchments of these culled lines still needs to be routed to the first line in the stream network.
+    * Add option to distribute specified flows evenly among reaches associated with a line.
+    * Refactor :meth:`sfrmaker.sfrdata.SFRData.period_data` to be indexed by stress period and reach number, allowing incremental updating (e.g. via pandas.DataFrame.update()). Previously, each call to :meth:`sfrmaker.flows.add_to_perioddata` would reset :meth:`sfrmaker.sfrdata.SFRData.period_data`. These changes allow for the specification of runoff to the SFR package in addition to specified inflows.
+* Observations: 
+    * base unique observations on name and type; allowing multiple observation types (e.g. downstream-flow and stage) to be appended to the observations table via add_observations
+* Bug fixes:
+    * Fix issue with starting arbolate sums, that was causing artificially narrow estimated widths on the first segment of any streams originating from outside of the model, by computing starting arbolate sums for each reach from the ending asum minus the line length.
 
 Version 0.7.1 (2021-01-29)
 --------------------------

sfrmaker/flows.py

@@ -1,3 +1,6 @@
+"""
+Functions for getting or adding specified flows or other stress-period-based inputs to the SFR package.
+"""
 import warnings
 import numpy as np
 import pandas as pd