Skip to content

Commit

Permalink
update v2.0.0 release notes
Browse files Browse the repository at this point in the history
  • Loading branch information
jmccreight committed Nov 15, 2024
1 parent fc11e84 commit 91977db
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions _posts/2024-11-14-v2-0-0-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,20 +16,20 @@ These are the extended release notes. The official release notes are found
These notes summarize the more detailed [What's New for version 2.0.0](https://pywatershed.readthedocs.io/en/latest/whats-new.html#v2-0-0-14-november-2024) in the documentation.

### FlowGraph
The primary new capability introduced is the `FlowGraph` and its related classes.
The `FlowGraph` allow users to combine different kinds flow solutions on `FlowNodes` in
The primary new capability introduced is the [`FlowGraph`](https://pywatershed.readthedocs.io/en/latest/api/generated/pywatershed.FlowGraph.html) and its related classes.
The `FlowGraph` allow users to combine different kinds flow solutions on [`FlowNodes`](https://pywatershed.readthedocs.io/en/latest/api/generated/pywatershed.FlowNode.html) in
arbitrary order. While `FlowGraph`s may be constructed from scratch, a common use case
(demonstrated in a new example notebook,
[06_flow_graph_starfit.ipynb](https://github.com/EC-USGS/pywatershed/blob/develop/examples/06_flow_graph_starfit.ipynb))
is to add a reservoir representation
into an existing `FlowGraph` which is equivalent to `PRMSChannel`. The STARFIT
reservoir representation is implemented as `StarfitFlowNode` which can be added into
the `FlowGraph`. Other `FlowNodes` implemented are `PassThroughFlowNode` and
`ObsInFlowNode`. The second reproduces the "obsin" capabilities present in PRMS.
Please see the [`FlowGraph` documentation](https://pywatershed.readthedocs.io/en/latest/api/generated/pywatershed.FlowGraph.html#pywatershed.FlowGraph) for additional details.
into an existing `FlowGraph` which is equivalent to `PRMSChannel`, using [`PRMSChannelFlowNode`](https://pywatershed.readthedocs.io/en/latest/api/generated/pywatershed.PRMSChannelFlowNode.html). The STARFIT
reservoir representation is implemented as [`StarfitFlowNode`](https://pywatershed.readthedocs.io/en/latest/api/generated/pywatershed.StarfitFlowNode.html) which can be added into
the `FlowGraph`. Other `FlowNodes` implemented are [`PassThroughFlowNode`](https://pywatershed.readthedocs.io/en/latest/api/generated/pywatershed.PassThroughFlowNode.html) and
[`ObsInFlowNode`](https://pywatershed.readthedocs.io/en/latest/api/generated/pywatershed.ObsInFlowNode.html). The second reproduces the "obsin" capabilities present in PRMS.
Please see the [`FlowGraph` documentation](https://pywatershed.readthedocs.io/en/latest/api/generated/pywatershed.FlowGraph.html) (linked throughout above) for additional details.


### Additional PRMS functionalities
### Additional PRMS functionality
- Subclasses of PRMSRunoff, PRMSSoilzone, and PRMSGroundwater are available
which do not include depression storage: PRMSRunoffNoDprst, PRMSSoilzoneNoDprst, and PRMSGroundwaterNoDprst.
- Dunnian flow is implemented in PRMSSoilzone and is 2-way coupled to PRMSRunoff.
Expand Down

0 comments on commit 91977db

Please sign in to comment.