Skip to content

Commit

Permalink
add notebook 05 update docs abstract and typo in README
Browse files Browse the repository at this point in the history
  • Loading branch information
jmccreight committed Dec 15, 2023
1 parent 01fe647 commit a7c9f85
Show file tree
Hide file tree
Showing 4 changed files with 495 additions and 326 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ you will also need to activate this environment by name.)


We install the `environment_w_jupyter.yml` to provide all known dependencies
including those for running the eample notebooks. (The `environment.yml`
including those for running the example notebooks. (The `environment.yml`
does not contain jupyter or jupyterlab because this interferes with installation
on WholeTale, see Example Notebooks seection below.)

Expand Down
18 changes: 13 additions & 5 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@ modeling techniques and data sources. Pywatershed is a place for experimentation
with software design, process representation, and data fusion in the context
of well established hydrologic process modeling.

The Python language was choosen because it is accessible to a wide audience of
potential contributors which will help foster community development and
experimentation. A large number of advanced libraries available for Python can
be applied to hdyrologic modeling, including libraries for parallelism, data
access and manipulation, and machine learning.

Following the conceptual design of PRMS, pywatershed calculates explicit solutions
of spatially distributed hydrologic process representations including evaporation,
transpiration, runoff, infiltration, interflow, snowpack, soil moisture, conceptual
Expand All @@ -29,11 +35,13 @@ land use change at temporal scales ranging from days to centuries.

Pywatershed enhances PRMS with a new software design that is object-oriented and highly
flexible, allowing users to easily run "sub-models", replace process representations, and
incorporate new data. The Python language is accessible to a wide audience of
potential contributors which will help foster community development and experimentation.
A large number of advanced libraries available for Python can be applied to
hdyrologic modeling, including libraries for parallelism, data access and manipulation,
and machine learning.
incorporate new data. There are base classes which manage mass and energy conservation
and the implementation of concrete, process classes follows a self-describing design
which allows for Model class to properly connect hydrologic proecsses based on their
own descriptions of themselves. A variety of input data sources is managed by the
Adapter class which implements subclasses for different sources. The design of
pywatershed is documented in these docs and also deomonstrated by numbered jupyter
notebooks in the `examples/` directory.

The flexible structure of pywatershed helps it to couple with other hydrologic
models. We can easily one-way couple pywatershed to
Expand Down
Loading

0 comments on commit a7c9f85

Please sign in to comment.