Section 1 Introduction

Welcome to the SHEDS stream temperature model documentation.

This website is provides background and results of the stream temperature model. The documentation will be updated for each new set of results. See the Change Log below for changes from earlier versions.

The source code for the model and documentation is available in the github repository walkerjeffd/sheds-streamtempmodel.

1.1 Model Versioning

The SHEDS stream temperature model uses semantic versioning of the form: vX.Y.Z

X is the major version, Y is the minor version, and Z is the patch version.

For the stream temperature model, the X value will be incremented when there is a major change to the model theory, code, or datasets. The Y value will be incremented when there is a new set of results due to changes in the model code, datasets, processing procedures, etc. The Z value will be incremented when only the documentation or output datasets are updated, but the results remain the same (based on the Y value).

1.2 Changelog

  • v0.9.1 (Jun 6, 2018)
    Updates to model versioning and configuration framework, and minor updates to documentation (still incomplete).
  • v0.9.0 (May 30, 2018)
    Preliminary release of the new model framework and documentation.
  • Previous Versions (prior to 2018)
    Previous versions of the stream temperature model can be found here. That website is now deprecated, but will remain available for future reference. Beginning with v1.0.0 of the new framework and codebase, all model changes and results will be tracked and made available.